@mouse_484/oxc-config 0.3.0 → 0.4.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mouse_484/oxc-config",
   "type": "module",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "author": "mouse_484",
   "license": "MIT",
   "homepage": "https://github.com/mouse484/config/tree/main/packages/oxc",
@@ -13,14 +13,23 @@
     "url": "https://github.com/mouse484/config/issues"
   },
   "main": "src/index.js",
+  "types": "src/index.d.ts",
+  "scripts": {
+    "typegen": "node scripts/typegen.js"
+  },
   "dependencies": {
     "@stylistic/eslint-plugin": "^5.10.0",
+    "defu": "^6.1.7",
     "eslint-plugin-antfu": "^3.2.3",
+    "eslint-plugin-better-tailwindcss": "^4.7.0",
     "eslint-plugin-perfectionist": "^5.10.0",
     "oxlint": "^1.76.0",
     "oxlint-tsgolint": "^7.0.2001"
   },
   "publishConfig": {
     "access": "public"
+  },
+  "devDependencies": {
+    "ts-morph": "^28.0.0"
   }
 }

package/scripts/typegen.js

@@ -0,0 +1,84 @@
+import { IndentationText, Project, ts } from 'ts-morph'
+
+const project = new Project({
+  tsConfigFilePath: 'jsconfig.json',
+  skipAddingFilesFromTsConfig: true,
+  manipulationSettings: {
+    indentationText: IndentationText.TwoSpaces,
+  },
+})
+
+const sourceFile = project.addSourceFileAtPath('src/configs/index.js')
+const dtsFile = project.addSourceFileAtPath('src/configs/index.d.ts')
+const variable = sourceFile.getVariableDeclarationOrThrow('CONFIGS')
+
+const importSpecifiers = /** @type {Map<string, string>} */ (new Map())
+for (const declaration of sourceFile.getImportDeclarations()) {
+  const name = declaration.getDefaultImport()?.getText()
+  if (name !== undefined) {
+    importSpecifiers.set(name, declaration.getModuleSpecifierValue())
+  }
+}
+
+function getConfigLiteral(/** @type {string} */ importedName) {
+  const moduleSpecifier = importSpecifiers.get(importedName)
+  if (moduleSpecifier === undefined) {
+    return {}
+  }
+  const file = project.addSourceFileAtPath(`src/configs/${moduleSpecifier.replace(/^\.\//, '')}`)
+  const literal = file
+    .getDescendants()
+    .map(node => node.asKind(ts.SyntaxKind.ObjectLiteralExpression))
+    .find(node => node?.getProperty('name') !== undefined)
+  if (!literal) {
+    return {}
+  }
+  return {
+    defaultEnabled: literal.getProperty('defaultEnabled')
+      ?.asKind(ts.SyntaxKind.PropertyAssignment)
+      ?.getInitializer()
+      ?.getText(),
+    options: literal.getProperty('options')
+      ?.asKind(ts.SyntaxKind.PropertyAssignment)
+      ?.getInitializer()
+      ?.getText(),
+  }
+}
+
+dtsFile.getInterface('Options')?.remove()
+
+dtsFile.addInterface({
+  name: 'Options',
+  isExported: true,
+  properties: variable
+    .getType()
+    .getArrayElementTypeOrThrow()
+    .getUnionTypes()
+    .map((node) => {
+      const name = node.getPropertyOrThrow('name')
+        .getTypeAtLocation(variable)
+        .getText()
+        .replaceAll(/^"|"$/g, '')
+      const options = node.getProperty('options')
+        ?.getTypeAtLocation(variable)
+        .getConstraint()
+      const { defaultEnabled, options: defaultOptions } = getConfigLiteral(name)
+      const tags = [
+        { tagName: 'default', text: defaultEnabled ?? 'true' },
+      ]
+      if (defaultOptions !== undefined) {
+        tags.push({ tagName: 'options', text: defaultOptions })
+      }
+      return {
+        name,
+        type: options ? `boolean | ${options.getText()}` : 'boolean',
+        hasQuestionToken: true,
+        docs: [{
+          description: `\`${name}\` option`,
+          tags,
+        }],
+      }
+    }),
+})
+
+dtsFile.saveSync()

package/src/configs/eslint.js

@@ -1,19 +1,24 @@
-import { defineConfig } from 'oxlint'
+import { createConfigs } from '../lib/factory.js'
 
-export default defineConfig({
-  rules: {
-    'eslint/id-length': ['off'],
-    'eslint/func-style': ['error', 'declaration', { allowArrowFunctions: true }],
-    'eslint/no-magic-numbers': ['error', { ignore: [0, 1, -1] }],
-    'eslint/no-undefined': ['off'],
-    'eslint/no-ternary': ['off'],
-    'eslint/no-nested-ternary': ['error'],
-    'eslint/no-unneeded-ternary': ['error'],
-    'eslint/no-void': ['error', { allowAsStatement: true }],
-    /**
-     * Prefer `perfectionist` plugin for sorting
-     */
-    'eslint/sort-imports': ['off'],
-    'eslint/sort-keys': ['off'],
-  },
+export default createConfigs({
+  name: 'eslint',
+  configs: [
+    {
+      rules: {
+        'eslint/id-length': 'off',
+        'eslint/func-style': ['error', 'declaration', { allowArrowFunctions: true }],
+        'eslint/no-magic-numbers': ['error', { ignore: [0, 1, -1] }],
+        'eslint/no-undefined': 'off',
+        'eslint/no-ternary': 'off',
+        'eslint/no-nested-ternary': 'error',
+        'eslint/no-unneeded-ternary': 'error',
+        'eslint/no-void': ['error', { allowAsStatement: true }],
+        /**
+         * Prefer `perfectionist` plugin for sorting
+         */
+        'eslint/sort-imports': 'off',
+        'eslint/sort-keys': 'off',
+      },
+    },
+  ],
 })

package/src/configs/index.d.ts

@@ -0,0 +1,52 @@
+export declare function buildConfigs(options: Options): OxlintConfig[]
+
+export interface Options {
+  /**
+   * `eslint` option
+   * @default true
+   */
+  eslint?: boolean
+  /**
+   * `opinionated` option
+   * @default true
+   */
+  opinionated?: boolean
+  /**
+   * `oxc` option
+   * @default true
+   */
+  oxc?: boolean
+  /**
+   * `perfectionist` option
+   * @default true
+   */
+  perfectionist?: boolean
+  /**
+   * `stylistic` option
+   * @default true
+   */
+  stylistic?: boolean
+  /**
+   * `tailwind` option
+   * @default false
+   * @options {
+   *     entryPoint: 'src/global.css',
+   *   }
+   */
+  tailwind?: boolean | { entryPoint: string } | undefined
+  /**
+   * `tanstackRouter` option
+   * @default false
+   */
+  tanstackRouter?: boolean
+  /**
+   * `typeAware` option
+   * @default true
+   */
+  typeAware?: boolean
+  /**
+   * `typescript` option
+   * @default true
+   */
+  typescript?: boolean
+}

package/src/configs/index.js

@@ -1,31 +1,37 @@
+import defu from 'defu'
 import eslint from './eslint.js'
 import opinionated from './opinionated.js'
 import oxc from './oxc.js'
 import perfectionist from './perfectionist.js'
 import stylistic from './stylistic.js'
+import tailwind from './tailwind.js'
 import tanstackRouter from './tanstack-router.js'
 import typeAware from './type-aware.js'
 import typescript from './typescript.js'
 
-/**
- * @satisfies {Record<string, [boolean, import('oxlint').OxlintConfig ]>}
- */
-const _configs = {
-  eslint: [true, eslint],
-  opinionated: [true, opinionated],
-  oxc: [true, oxc],
-  perfectionist: [true, perfectionist],
-  stylistic: [true, stylistic],
-  tanstackRouter: [false, tanstackRouter],
-  typeAware: [true, typeAware],
-  typescript: [true, typescript],
-}
-
-/** @typedef {Partial<Record<keyof typeof _configs, boolean>>} ConfigOptions */
+const CONFIGS = /** @type {const} */[
+  eslint,
+  opinionated,
+  oxc,
+  perfectionist,
+  stylistic,
+  tailwind,
+  tanstackRouter,
+  typeAware,
+  typescript,
+]
 
-/** @param {ConfigOptions} [options] */
-export default function configs(options = {}) {
-  return Object.entries(_configs).flatMap(([name, [defaultEnabled, config]]) => {
-    return (Object.hasOwn(options, name) ? options[/** @type {keyof ConfigOptions} */ (name)] : defaultEnabled) ? [config] : []
+/** @type {import(".").buildConfigs} */
+export default function buildConfigs(options) {
+  const configs = CONFIGS.flatMap(({ name, build, defaultEnabled, options: defaultOptions }) => {
+    const option = options[name]
+    if (option === false || (option === undefined && defaultEnabled === false)) {
+      return []
+    }
+    // @ts-expect-error - build configs with options
+    // eslint-disable-next-line unicorn/prefer-minimal-ternary
+    return typeof option === 'object' ? build(defu(option, defaultOptions)) : build(defaultOptions)
   })
+
+  return configs
 }

package/src/configs/opinionated.js

@@ -1,12 +1,17 @@
-import { defineConfig } from 'oxlint'
+import { createConfigs } from '../lib/factory.js'
 
-export default defineConfig({
-  jsPlugins: ['eslint-plugin-antfu'],
-  rules: {
-    'antfu/top-level-function': ['error'],
-    'antfu/consistent-chaining': ['error'],
-    'antfu/import-dedupe': ['error'],
-    'antfu/indent-unindent': ['error', { indent: 2 }],
-    'antfu/no-ts-export-equal': ['error'],
-  },
+export default createConfigs({
+  name: 'opinionated',
+  configs: [
+    {
+      jsPlugins: ['eslint-plugin-antfu'],
+      rules: {
+        'antfu/top-level-function': 'error',
+        'antfu/consistent-chaining': 'error',
+        'antfu/import-dedupe': 'error',
+        'antfu/indent-unindent': ['error', { indent: 2 }],
+        'antfu/no-ts-export-equal': 'error',
+      },
+    },
+  ],
 })

package/src/configs/oxc.js

@@ -1,8 +1,13 @@
-import { defineConfig } from 'oxlint'
+import { createConfigs } from '../lib/factory.js'
 
-export default defineConfig({
-  rules: {
-    'oxc/no-async-await': ['off'],
-    'oxc/no-rest-spread-properties': ['off'],
-  },
+export default createConfigs({
+  name: 'oxc',
+  configs: [
+    {
+      rules: {
+        'oxc/no-async-await': 'off',
+        'oxc/no-rest-spread-properties': 'off',
+      },
+    },
+  ],
 })

package/src/configs/perfectionist.js

@@ -1,9 +1,14 @@
 import perfectionist from 'eslint-plugin-perfectionist'
-import { defineConfig } from 'oxlint'
+import { createConfigs } from '../lib/factory.js'
 
-export default defineConfig({
-  jsPlugins: ['eslint-plugin-perfectionist'],
-  rules: {
-    ...perfectionist.configs['recommended-natural'].rules,
-  },
+export default createConfigs({
+  name: 'perfectionist',
+  configs: [
+    {
+      jsPlugins: ['eslint-plugin-perfectionist'],
+      rules: {
+        ...perfectionist.configs['recommended-natural'].rules,
+      },
+    },
+  ],
 })

package/src/configs/stylistic.js

@@ -1,5 +1,5 @@
 import stylistic from '@stylistic/eslint-plugin'
-import { defineConfig } from 'oxlint'
+import { createConfigs } from '../lib/factory.js'
 
 const { rules } = stylistic.configs.customize({
   indent: 2,
@@ -8,7 +8,12 @@ const { rules } = stylistic.configs.customize({
   jsx: true,
 })
 
-export default defineConfig({
-  jsPlugins: ['@stylistic/eslint-plugin'],
-  rules,
+export default createConfigs ({
+  name: 'stylistic',
+  configs: [
+    {
+      jsPlugins: ['@stylistic/eslint-plugin'],
+      rules,
+    },
+  ],
 })

package/src/configs/tailwind.js

@@ -0,0 +1,28 @@
+import eslintPluginBetterTailwindcss from 'eslint-plugin-better-tailwindcss'
+import { createConfigs } from '../lib/factory.js'
+
+export default createConfigs({
+  name: 'tailwind',
+  defaultEnabled: false,
+  options: {
+    entryPoint: 'src/global.css',
+  },
+  configs: ({ entryPoint }) => ([
+    {
+      jsPlugins: [
+        'eslint-plugin-better-tailwindcss',
+      ],
+      rules: {
+        ...eslintPluginBetterTailwindcss.configs.recommended.rules,
+        'better-tailwindcss/no-unknown-classes': ['error', {
+          detectComponentClasses: true,
+        }],
+      },
+      settings: {
+        'better-tailwindcss': {
+          entryPoint,
+        },
+      },
+    },
+  ]),
+})

package/src/configs/tanstack-router.js

@@ -1,10 +1,19 @@
-import { defineConfig } from 'oxlint'
+import { createConfigs } from '../lib/factory.js'
 
-export default defineConfig({
-  overrides: [{
-    files: ['src/routes/**/*.tsx'],
-    rules: {
-      'eslint/no-use-before-define': ['off'],
+export default createConfigs({
+  defaultEnabled: false,
+  name: 'tanstackRouter',
+  configs: [
+    {
+      ignorePatterns: ['**/src/routeTree.gen.ts'],
+      overrides: [
+        {
+          files: ['src/routes/**/*.tsx'],
+          rules: {
+            'eslint/no-use-before-define': 'off',
+          },
+        },
+      ],
     },
-  }],
+  ],
 })

package/src/configs/type-aware.js

@@ -1,11 +1,16 @@
-import { defineConfig } from 'oxlint'
+import { createConfigs } from '../lib/factory.js'
 
-export default defineConfig({
-  options: {
-    typeAware: true,
-    typeCheck: true,
-  },
-  rules: {
-    'typescript/prefer-readonly-parameter-types': ['off'],
-  },
+export default createConfigs({
+  name: 'typeAware',
+  configs: [
+    {
+      options: {
+        typeAware: true,
+        typeCheck: true,
+      },
+      rules: {
+        'typescript/prefer-readonly-parameter-types': 'off',
+      },
+    },
+  ],
 })

package/src/configs/typescript.js

@@ -1,8 +1,13 @@
-import { defineConfig } from 'oxlint'
+import { createConfigs } from '../lib/factory.js'
 
-export default defineConfig({
-  rules: {
-    'typescript/explicit-function-return-type': ['off'],
-    'typescript/explicit-module-boundary-types': ['off'],
-  },
+export default createConfigs({
+  name: 'typescript',
+  configs: [
+    {
+      rules: {
+        'typescript/explicit-function-return-type': 'off',
+        'typescript/explicit-module-boundary-types': 'off',
+      },
+    },
+  ],
 })

package/src/index.d.ts

@@ -1,10 +1,7 @@
 import type { OxlintConfig } from 'oxlint'
-import type { ConfigOptions } from './configs/index.js'
+import type { Options } from './configs'
 
-export type Options = ConfigOptions
+declare function lint(options?: Options, config?: OxlintConfig): OxlintConfig
 
-declare function lint(options?: Options): OxlintConfig
-
-export {
-  lint,
-}
+export { lint }
+export { type Options } from './configs'

package/src/index.js

@@ -1,18 +1,24 @@
-import { defineConfig } from 'oxlint'
-import configs from './configs/index.js'
+import defu from 'defu'
+import buildConfigs from './configs/index.js'
 
-/** @param {import('.').Options} [options] */
-export function lint(options = {}) {
-  return defineConfig({
-    categories: {
-      correctness: 'error',
-      suspicious: 'warn',
-      pedantic: 'warn',
-      perf: 'warn',
-      style: 'warn',
-      restriction: 'warn',
-      nursery: 'warn',
+/** @type {import('.').lint} */
+export function lint(options, config = {}) {
+  // @ts-expect-error - deep merge config with default config
+  return defu(
+    config,
+    {
+      categories: {
+        correctness: 'error',
+        suspicious: 'warn',
+        pedantic: 'warn',
+        perf: 'warn',
+        style: 'warn',
+        restriction: 'warn',
+        nursery: 'warn',
+      },
     },
-    extends: configs(options),
-  })
+    // @ts-expect-error - buildConfigs returns a Config[]
+    // eslint-disable-next-line ts/no-unsafe-argument
+    ...buildConfigs(options),
+  )
 }

package/src/lib/factory.d.ts

@@ -0,0 +1,19 @@
+import type { OxlintConfig } from 'oxlint'
+
+declare function createConfigs<
+  TName extends string,
+  TOptions extends Record<string, unknown> | undefined = undefined,
+>(
+  parameters: {
+    name: TName
+    defaultEnabled?: boolean
+    options?: TOptions
+    configs: OxlintConfig[] | ((options: TOptions) => OxlintConfig[])
+  }): {
+  name: TName
+  defaultEnabled?: boolean
+  options?: TOptions
+  build: (options?: TOptions) => OxlintConfig[]
+}
+
+export { createConfigs }

package/src/lib/factory.js

@@ -0,0 +1,18 @@
+/** @type {import('./factory').createConfigs} */
+export function createConfigs({ name, defaultEnabled, options, configs }) {
+  return {
+    name,
+    defaultEnabled,
+    options,
+    build: (overriddenOptions) => {
+      if (typeof configs === 'function') {
+        // @ts-expect-error - build configs
+        return configs({
+          ...options,
+          ...overriddenOptions,
+        })
+      }
+      return configs
+    },
+  }
+}