@mouse_484/oxc-config 0.4.2 → 0.5.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mouse_484/oxc-config",
   "type": "module",
-  "version": "0.4.2",
+  "version": "0.5.1",
   "author": "mouse_484",
   "license": "MIT",
   "homepage": "https://github.com/mouse484/config/tree/main/packages/oxc",
@@ -19,11 +19,11 @@
   },
   "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.1",
-    "oxlint": "^1.78.0",
+    "local-pkg": "^1.2.1",
+    "oxlint": "^1.79.0",
     "oxlint-tsgolint": "^7.0.2001"
   },
   "publishConfig": {

package/scripts/typegen.js

@@ -34,7 +34,7 @@ function getConfigLiteral(/** @type {string} */ importedName) {
     return {}
   }
   return {
-    defaultEnabled: literal.getProperty('defaultEnabled')
+    enable: literal.getProperty('enable')
       ?.asKind(ts.SyntaxKind.PropertyAssignment)
       ?.getInitializer()
       ?.getText(),
@@ -62,9 +62,15 @@ dtsFile.addInterface({
       const options = node.getProperty('options')
         ?.getTypeAtLocation(variable)
         .getConstraint()
-      const { defaultEnabled, options: defaultOptions } = getConfigLiteral(name)
+      const { enable, options: defaultOptions } = getConfigLiteral(name)
+      let defaultText = 'auto'
+      if (enable === undefined) {
+        defaultText = 'true'
+      } else if (enable === 'true' || enable === 'false') {
+        defaultText = enable
+      }
       const tags = [
-        { tagName: 'default', text: defaultEnabled ?? 'true' },
+        { tagName: 'default', text: defaultText },
       ]
       if (defaultOptions !== undefined) {
         tags.push({ tagName: 'options', text: defaultOptions })

package/src/configs/eslint.js

@@ -2,8 +2,10 @@ import { createConfigs } from '../lib/factory.js'
 
 export default createConfigs({
   name: 'eslint',
+  enable: true,
   configs: [
     {
+      plugins: ['eslint'],
       rules: {
         'eslint/id-length': 'off',
         'eslint/func-style': ['error', 'declaration', { allowArrowFunctions: true }],
@@ -13,11 +15,7 @@ export default createConfigs({
         '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',
+        'eslint/one-var': 'off',
       },
     },
   ],

package/src/configs/{perfectionist.js → import.js}

@@ -2,7 +2,8 @@ import perfectionist from 'eslint-plugin-perfectionist'
 import { createConfigs } from '../lib/factory.js'
 
 export default createConfigs({
-  name: 'perfectionist',
+  name: 'import',
+  enable: true,
   configs: [
     {
       jsPlugins: ['eslint-plugin-perfectionist'],
@@ -10,5 +11,11 @@ export default createConfigs({
         ...perfectionist.configs['recommended-natural'].rules,
       },
     },
+    {
+      rules: {
+        'eslint/sort-imports': 'off',
+        'eslint/sort-keys': 'off',
+      },
+    },
   ],
 })

package/src/configs/index.d.ts

@@ -1,4 +1,6 @@
-export declare function buildConfigs(options: Options): OxlintConfig[]
+import type { OxlintConfig } from 'oxlint'
+
+export default function buildConfigs(options: Options): OxlintConfig[]
 
 export interface Options {
   /**
@@ -17,10 +19,10 @@ export interface Options {
    */
   oxc?: boolean
   /**
-   * `perfectionist` option
+   * `import` option
    * @default true
    */
-  perfectionist?: boolean
+  import?: boolean
   /**
    * `stylistic` option
    * @default true
@@ -28,25 +30,48 @@ export interface Options {
   stylistic?: boolean
   /**
    * `tailwind` option
-   * @default false
+   * @default auto
    * @options {
    *     entryPoint: 'src/global.css',
    *   }
    */
   tailwind?: boolean | { entryPoint: string } | undefined
   /**
-   * `tanstackRouter` option
-   * @default false
+   * `tanstack` option
+   * @default true
+   */
+  tanstack?: boolean
+  /**
+   * `typescript` option
+   * @default auto
+   * @options {
+   *     typeAware: true,
+   *   }
+   */
+  typescript?: boolean | { typeAware: boolean } | undefined
+  /**
+   * `react` option
+   * @default auto
+   */
+  react?: boolean
+  /**
+   * `vitest` option
+   * @default auto
    */
-  tanstackRouter?: boolean
+  vitest?: boolean
   /**
-   * `typeAware` option
+   * `node` option
+   * @default auto
+   */
+  node?: boolean
+  /**
+   * `javascript` option
    * @default true
    */
-  typeAware?: boolean
+  javascript?: boolean
   /**
-   * `typescript` option
+   * `unicorn` option
    * @default true
    */
-  typescript?: boolean
+  unicorn?: boolean
 }

package/src/configs/index.js

@@ -1,37 +1,52 @@
-import defu from 'defu'
+import { isPackageExists } from 'local-pkg'
 import eslint from './eslint.js'
+import importConfig from './import.js'
+import javascript from './javascript.js'
+import node from './node.js'
 import opinionated from './opinionated.js'
 import oxc from './oxc.js'
-import perfectionist from './perfectionist.js'
+import react from './react.js'
 import stylistic from './stylistic.js'
 import tailwind from './tailwind.js'
-import tanstackRouter from './tanstack-router.js'
-import typeAware from './type-aware.js'
+import tanstack from './tanstack.js'
 import typescript from './typescript.js'
+import unicorn from './unicorn.js'
+import vitest from './vitest.js'
 
 const CONFIGS = /** @type {const} */[
   eslint,
   opinionated,
   oxc,
-  perfectionist,
+  importConfig,
   stylistic,
   tailwind,
-  tanstackRouter,
-  typeAware,
+  tanstack,
   typescript,
+  react,
+  vitest,
+  node,
+  javascript,
+  unicorn,
 ]
 
-/** @type {import(".").buildConfigs} */
+/**
+@param {import(".").Options} options
+@returns {import("oxlint").OxlintConfig[]} Generated configs for the enabled options
+ */
 export default function buildConfigs(options) {
-  const configs = CONFIGS.flatMap(({ name, build, defaultEnabled, options: defaultOptions }) => {
+  const context = { isPackageExists, options }
+  return CONFIGS.flatMap(({ name, build, enable = true }) => {
     const option = options[name]
-    if (option === false || (option === undefined && defaultEnabled === false)) {
+    if (option === false) {
       return []
     }
+    if (option === undefined) {
+      const isEnabled = typeof enable === 'function' ? enable(context) : enable
+      if (!isEnabled) {
+        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 build(context, typeof option === 'object' ? option : undefined)
   })
-
-  return configs
 }

package/src/configs/javascript.js

@@ -0,0 +1,11 @@
+import { createConfigs } from '../lib/factory.js'
+
+export default createConfigs({
+  name: 'javascript',
+  enable: true,
+  configs: [
+    {
+      plugins: ['jsdoc', 'promise'],
+    },
+  ],
+})

package/src/configs/node.js

@@ -0,0 +1,11 @@
+import { createConfigs } from '../lib/factory.js'
+
+export default createConfigs({
+  name: 'node',
+  enable: ({ isPackageExists }) => isPackageExists('@types/node'),
+  configs: [
+    {
+      plugins: ['node'],
+    },
+  ],
+})

package/src/configs/opinionated.js

@@ -2,6 +2,7 @@ import { createConfigs } from '../lib/factory.js'
 
 export default createConfigs({
   name: 'opinionated',
+  enable: true,
   configs: [
     {
       jsPlugins: ['eslint-plugin-antfu'],

package/src/configs/oxc.js

@@ -2,8 +2,10 @@ import { createConfigs } from '../lib/factory.js'
 
 export default createConfigs({
   name: 'oxc',
+  enable: true,
   configs: [
     {
+      plugins: ['oxc'],
       rules: {
         'oxc/no-async-await': 'off',
         'oxc/no-rest-spread-properties': 'off',

package/src/configs/react.js

@@ -0,0 +1,20 @@
+import { createConfigs } from '../lib/factory.js'
+
+export default createConfigs({
+  name: 'react',
+  enable: ({ isPackageExists }) => isPackageExists('react'),
+  configs: [
+    {
+      plugins: ['react'],
+      rules: {
+        'react/react-in-jsx-scope': 'off',
+        'react/jsx-props-no-spreading': 'off',
+        'react/jsx-max-depth': ['error', { max: 5 }],
+        'react/jsx-filename-extension': ['error', { extensions: ['.jsx', '.tsx'] }],
+      },
+    },
+    {
+      plugins: ['jsx-a11y'],
+    },
+  ],
+})

package/src/configs/stylistic.js

@@ -10,6 +10,7 @@ const { rules } = stylistic.configs.customize({
 
 export default createConfigs ({
   name: 'stylistic',
+  enable: true,
   configs: [
     {
       jsPlugins: ['@stylistic/eslint-plugin'],

package/src/configs/tailwind.js

@@ -3,12 +3,12 @@ import { createConfigs } from '../lib/factory.js'
 
 export default createConfigs({
   name: 'tailwind',
-  defaultEnabled: false,
+  enable: ({ isPackageExists }) => isPackageExists('tailwindcss'),
   options: {
     entryPoint: 'src/global.css',
   },
-  configs: ({ entryPoint }) => ([
-    {
+  configs: [
+    ({ options: { entryPoint } }) => ({
       jsPlugins: [
         'eslint-plugin-better-tailwindcss',
       ],
@@ -23,6 +23,6 @@ export default createConfigs({
           entryPoint,
         },
       },
-    },
-  ]),
+    }),
+  ],
 })

package/src/configs/tanstack.js

@@ -0,0 +1,22 @@
+import { createConfigs } from '../lib/factory.js'
+
+export default createConfigs({
+  name: 'tanstack',
+  enable: true,
+  configs: [
+    ({ isPackageExists }) => isPackageExists('@tanstack/react-router')
+      ? {
+          ignorePatterns: ['**/src/routeTree.gen.ts'],
+          overrides: [
+            {
+              files: ['src/routes/**/*.tsx'],
+              rules: {
+                'eslint/no-use-before-define': 'off',
+                'react/only-export-components': ['error', { customHOCs: ['createRootRoute', 'createFileRoute'] }],
+              },
+            },
+          ],
+        }
+      : undefined,
+  ],
+})

package/src/configs/typescript.js

@@ -2,12 +2,29 @@ import { createConfigs } from '../lib/factory.js'
 
 export default createConfigs({
   name: 'typescript',
+  enable: ({ isPackageExists }) => isPackageExists('typescript'),
+  options: {
+    typeAware: true,
+  },
   configs: [
     {
+      plugins: ['typescript'],
       rules: {
         'typescript/explicit-function-return-type': 'off',
         'typescript/explicit-module-boundary-types': 'off',
+        'eslint/no-undef': 'off',
       },
     },
+    ({ options: { typeAware } }) => typeAware
+      ? {
+          options: {
+            typeAware: true,
+            typeCheck: true,
+          },
+          rules: {
+            'typescript/prefer-readonly-parameter-types': 'off',
+          },
+        }
+      : undefined,
   ],
 })

package/src/configs/unicorn.js

@@ -0,0 +1,11 @@
+import { createConfigs } from '../lib/factory.js'
+
+export default createConfigs({
+  name: 'unicorn',
+  enable: true,
+  configs: [
+    {
+      plugins: ['unicorn'],
+    },
+  ],
+})

package/src/configs/vitest.js

@@ -0,0 +1,11 @@
+import { createConfigs } from '../lib/factory.js'
+
+export default createConfigs({
+  name: 'vitest',
+  enable: ({ isPackageExists }) => isPackageExists('vitest'),
+  configs: [
+    {
+      plugins: ['vitest'],
+    },
+  ],
+})

package/src/index.d.ts

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

package/src/index.js

@@ -1,24 +1,62 @@
-import defu from 'defu'
 import buildConfigs from './configs/index.js'
 
-/** @type {import('.').lint} */
+const DEFAULT_CATEGORIES = {
+  correctness: 'error',
+  suspicious: 'warn',
+  pedantic: 'warn',
+  perf: 'warn',
+  style: 'warn',
+  restriction: 'warn',
+  nursery: 'warn',
+}
+
+const OBJECT_KEYS = ['settings', 'env', 'globals', 'options']
+const ARRAY_KEYS = ['ignorePatterns']
+const HOISTED_KEYS = [...OBJECT_KEYS, ...ARRAY_KEYS, 'categories']
+
+/**
+@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',
-      },
-    },
-    // @ts-expect-error - buildConfigs returns a Config[]
-    // eslint-disable-next-line ts/no-unsafe-argument
-    ...buildConfigs(options),
-  )
+  const all = [...buildConfigs(options), config]
+
+  /** @type {Record<string, any>} */
+  const root = {
+    categories: { ...DEFAULT_CATEGORIES, ...config.categories },
+  }
+
+  for (const item of all) {
+    for (const key of OBJECT_KEYS) {
+      // @ts-expect-error - hoisted keys are not part of the OxlintConfig index signature
+      // eslint-disable-next-line ts/no-unsafe-assignment
+      const value = item[key]
+      if (value !== undefined) {
+        // eslint-disable-next-line ts/no-unsafe-assignment
+        root[key] = { ...root[key], ...value }
+      }
+    }
+    for (const key of ARRAY_KEYS) {
+      // @ts-expect-error - hoisted keys are not part of the OxlintConfig index signature
+      // eslint-disable-next-line ts/no-unsafe-assignment
+      const value = item[key]
+      if (value !== undefined) {
+        // eslint-disable-next-line ts/no-unsafe-assignment
+        root[key] = [...new Set([...(root[key] ?? []), ...value])]
+      }
+    }
+  }
+
+  return {
+    ...root,
+    extends: all
+      .map((item) => {
+        const rest = { ...item }
+        for (const key of HOISTED_KEYS) {
+          // @ts-expect-error - delete hoisted keys
+          delete rest[key]
+        }
+        return rest
+      })
+      .filter(item => Object.keys(item).length > 0),
+  }
 }

package/src/lib/factory.d.ts

@@ -1,4 +1,14 @@
 import type { OxlintConfig } from 'oxlint'
+import type { Options } from '../configs'
+
+interface EnableContext<TOptions = Options> {
+  isPackageExists: (name: string) => boolean
+  options: TOptions
+}
+
+type Enable = boolean | ((context: EnableContext) => boolean)
+
+type ConfigItem<TOptions> = OxlintConfig | undefined | ((context: EnableContext<TOptions>) => OxlintConfig | undefined)
 
 declare function createConfigs<
   TName extends string,
@@ -6,14 +16,15 @@ declare function createConfigs<
 >(
   parameters: {
     name: TName
-    defaultEnabled?: boolean
+    enable?: Enable
     options?: TOptions
-    configs: OxlintConfig[] | ((options: TOptions) => OxlintConfig[])
+    configs: ConfigItem<TOptions>[]
   }): {
   name: TName
-  defaultEnabled?: boolean
+  enable?: Enable
   options?: TOptions
-  build: (options?: TOptions) => OxlintConfig[]
+  build: (context: EnableContext, options?: TOptions) => OxlintConfig[]
 }
 
 export { createConfigs }
+export type { ConfigItem, Enable, EnableContext }

package/src/lib/factory.js

@@ -1,18 +1,17 @@
-/** @type {import('./factory').createConfigs} */
-export function createConfigs({ name, defaultEnabled, options, configs }) {
+/**
+@type {import('./factory').createConfigs}
+ */
+export function createConfigs({ name, enable = true, options, configs }) {
   return {
     name,
-    defaultEnabled,
+    enable,
     options,
-    build: (overriddenOptions) => {
-      if (typeof configs === 'function') {
-        // @ts-expect-error - build configs
-        return configs({
-          ...options,
-          ...overriddenOptions,
-        })
-      }
-      return configs
+    build: (context, overriddenOptions) => {
+      const local = { ...context, options: { ...options, ...overriddenOptions } }
+      return configs.flatMap((item) => {
+        const config = typeof item === 'function' ? item(local) : item
+        return config ? [config] : []
+      })
     },
   }
 }

package/src/configs/tanstack-router.js

@@ -1,19 +0,0 @@
-import { createConfigs } from '../lib/factory.js'
-
-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,16 +0,0 @@
-import { createConfigs } from '../lib/factory.js'
-
-export default createConfigs({
-  name: 'typeAware',
-  configs: [
-    {
-      options: {
-        typeAware: true,
-        typeCheck: true,
-      },
-      rules: {
-        'typescript/prefer-readonly-parameter-types': 'off',
-      },
-    },
-  ],
-})