@mouse_484/oxc-config 0.6.11 → 0.7.0

package/README.md

@@ -4,11 +4,12 @@ Oxlint Config by me
 
 ## Requirements
 - Oxlint: recomended latest (required `jsPlugin` support)
+- Oxfmt: recomended latest (for formatting)
 
 ## Usage
 Install the packages
 ```sh
-npm install -D oxlint @mouse_484/oxc-config
+npm install -D oxlint oxfmt @mouse_484/oxc-config
 ```
 
 Create a `oxlint.config.ts` and add the following code:
@@ -25,5 +26,41 @@ export default lint(
 )
 ```
 
+Create a `oxfmt.config.ts` and add the following code:
+```js
+import { format } from '@mouse_484/oxc-config'
+
+export default format(
+  {
+  // oxfmt config
+  }
+)
+```
+
+Formatting rules are not provided by `lint()`, they are left to `format()`.
+
+### With Vite+
+If you use [Vite+](https://viteplus.dev/config), put the same configs in the `lint` and `fmt` blocks of `vite.config.ts`:
+```js
+import { format, lint } from '@mouse_484/oxc-config'
+import { defineConfig } from 'vite-plus'
+
+export default defineConfig({
+  lint: lint(
+    {
+    // custom options
+    },
+    {
+    // oxlint config
+    }
+  ),
+  fmt: format(
+    {
+    // oxfmt config
+    }
+  ),
+})
+```
+
 ## Features
-See [configs](https://github.com/mouse484/config/tree/main/packages/oxc/src/configs) for all available presets and options.
+See [configs](https://github.com/mouse484/config/tree/main/packages/oxc/src/configs) for all available presets and options.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mouse_484/oxc-config",
   "type": "module",
-  "version": "0.6.11",
+  "version": "0.7.0",
   "author": "mouse_484",
   "license": "MIT",
   "homepage": "https://github.com/mouse484/config/tree/main/packages/oxc",
@@ -18,11 +18,10 @@
     "typegen": "node scripts/typegen.js"
   },
   "dependencies": {
-    "@stylistic/eslint-plugin": "^5.10.0",
     "eslint-plugin-antfu": "^3.2.3",
-    "eslint-plugin-better-tailwindcss": "^4.9.0",
     "eslint-plugin-perfectionist": "^5.12.1",
     "local-pkg": "^1.2.1",
+    "oxfmt": "^0.72.0",
     "oxlint": "^1.87.0",
     "oxlint-tsgolint": "^7.0.2003"
   },

package/src/configs/import.js

@@ -1,4 +1,3 @@
-import perfectionist from 'eslint-plugin-perfectionist'
 import { createConfigs } from '../lib/factory.js'
 
 export default createConfigs({
@@ -8,7 +7,11 @@ export default createConfigs({
     {
       jsPlugins: ['eslint-plugin-perfectionist'],
       rules: {
-        ...perfectionist.configs['recommended-natural'].rules,
+        // `sort-imports` is handled by oxfmt (`sortImports`)
+        'perfectionist/sort-imports': 'off',
+        'perfectionist/sort-named-imports': ['error', { type: 'natural', order: 'asc' }],
+        'perfectionist/sort-named-exports': ['error', { type: 'natural', order: 'asc' }],
+        'perfectionist/sort-exports': ['error', { type: 'natural', order: 'asc' }],
       },
     },
     {

package/src/configs/index.d.ts

@@ -23,19 +23,6 @@ export interface Options {
    * @default true
    */
   import?: boolean
-  /**
-   * `stylistic` option
-   * @default true
-   */
-  stylistic?: boolean
-  /**
-   * `tailwind` option
-   * @default false
-   * @options {
-   *     entryPoint: 'src/global.css',
-   *   }
-   */
-  tailwind?: boolean | { entryPoint: string } | undefined
   /**
    * `tanstack` option
    * @default true

package/src/configs/index.js

@@ -6,8 +6,6 @@ import node from './node.js'
 import opinionated from './opinionated.js'
 import oxc from './oxc.js'
 import react from './react.js'
-import stylistic from './stylistic.js'
-import tailwind from './tailwind.js'
 import tanstack from './tanstack.js'
 import typescript from './typescript.js'
 import unicorn from './unicorn.js'
@@ -18,8 +16,6 @@ const CONFIGS = /** @type {const} */[
   opinionated,
   oxc,
   importConfig,
-  stylistic,
-  tailwind,
   tanstack,
   typescript,
   react,

package/src/format.js

@@ -0,0 +1,17 @@
+const DEFAULT_FORMAT = /** @type {import('oxfmt').OxfmtConfig} */ ({
+  printWidth: 120,
+  semi: false,
+  singleQuote: true,
+  sortImports: true,
+  tabWidth: 2,
+  trailingComma: 'all',
+})
+
+/**
+ * Create an `oxfmt` config with the defaults of this config.
+ * Formatting rules are not provided by `lint()`, so use this for your formatting.
+ * @param {import('oxfmt').OxfmtConfig} [config]
+ */
+export function format(config = {}) {
+  return { ...DEFAULT_FORMAT, ...config }
+}

package/src/index.d.ts

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

package/src/index.js

@@ -1,64 +1,2 @@
-import buildConfigs from './configs/index.js'
-
-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 = {}) {
-  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),
-  }
-}
+export { format } from './format.js'
+export { lint } from './lint.js'

package/src/lint.js

@@ -0,0 +1,64 @@
+import buildConfigs from './configs/index.js'
+
+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 = {}) {
+  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/configs/stylistic.js

@@ -1,20 +0,0 @@
-import stylistic from '@stylistic/eslint-plugin'
-import { createConfigs } from '../lib/factory.js'
-
-const { rules } = stylistic.configs.customize({
-  indent: 2,
-  quotes: 'single',
-  semi: false,
-  jsx: true,
-})
-
-export default createConfigs ({
-  name: 'stylistic',
-  enable: true,
-  configs: [
-    {
-      jsPlugins: ['@stylistic/eslint-plugin'],
-      rules,
-    },
-  ],
-})

package/src/configs/tailwind.js

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