@subf/config

Universal configuration for TypeScript, oxlint (+unocss, +solid), oxfmt, and tsdown.

Quick start

bun i -D @subf/config

Usage

tsconfig

{
  "extends": "@subf/config/tsc-lib"
}

Available configs:

• tsc-lib: for libraries.
• tsc-node: for Node.js apps.
• tsc-web: for SolidJS apps.
• tsc-base: base config for custom setups.

tsdown

Helpers to create tsdown build configs.

Example: use lib() in your tsdown.config.ts:

import { defineConfig } from 'tsdown'
import { lib } from '@subf/config/tsdown'

export default lib({
  entry: 'shallow',
  excludeDeps: ['oxlint', 'oxfmt', 'tsdown'],
  overrides: {
    exports: {
      customExports(exports) {
        exports['./custom'] = './you-custom-file.js'
        return exports
      },
    },
  },
})

For Node builds use nodeLib():

import { nodeLib } from '@subf/config/tsdown'
export default nodeLib({ entry: 'src/index.ts' })

For Solid builds (requires vite-plugin-solid) use solidLib():

import { defineConfig } from 'tsdown'
import { solidLib } from '@subf/config/tsdown'

export default solidLib({ entry: 'src/index.tsx' })

oxfmt

In oxfmt.config.ts:

import { CONFIG } from '@subf/config/oxfmt'
export default CONFIG

Helper

Use subfFmt() helper to create a config with opinionated presets for lib, solid, unocss, etc.

import { subfFmt } from '@subf/config/oxfmt'
export default subfFmt({
  // your custom oxfmt config here
})

oxlint

In oxlint.config.ts:

import { CONFIG } from '@subf/config/oxlint'

export default CONFIG

or use defineConfig() with extend if you want to extend it:

import { defineConfig } from 'oxlint'
import { CONFIG } from '@subf/config/oxlint'

export default defineConfig({
  extend: [CONFIG],
  // your custom config here
})

Helper

Use subf() helper to create a config with opinionated presets for lib, solid, unocss, etc.

import { subf } from '@subf/config/oxlint'

export default subf({
  lib: true,
  solid: true,
  unocss: true,
  // your custom oxlint config here
})

CLI

Scaffold tsconfig.json, oxlint.config.ts, and oxfmt.config.ts into your project.

Quick start (no install)

bunx @subf/config          # recommended
npx -y @subf/config        # fallback
bunx @subf/config -f       # force overwrite existing files

After scaffolding you'll be prompted to install the package so your configs stay in sync with future updates:

bun i -D @subf/config

Installed locally

bun i -D @subf/config
bun subf                   # or just `subf` if on PATH
bun subf -f                # force overwrite existing files

License

MIT