@websolutespa/eslint-config 3.1.2 → 4.0.0-next.7

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # @websolutespa/eslint-config
 
+## 4.0.0-next.7
+
+### Patch Changes
+
+- The oxlint presets move to the new package `@websolutespa/oxc`, with type declarations and the shared oxfmt config; `@websolutespa/eslint-config` is the ESLint 10 configs again and no longer exports `./oxlint`.
+
+  - `oxlint.config.ts`: `import { next } from '@websolutespa/oxc/oxlint'` (was `@websolutespa/eslint-config/oxlint`).
+  - `.oxfmtrc.json` becomes `oxfmt.config.ts`: `import { format } from '@websolutespa/oxc/oxfmt'; export default defineConfig(format);`.
+  - A project that declared the presets itself (a local `.d.ts` for `@websolutespa/eslint-config/oxlint`) drops it.
+
+## 4.0.0-next.6
+
+### Minor Changes
+
+- aa3870b: Adds oxlint presets, `@websolutespa/eslint-config/oxlint` (`base`, `react`, `next`, `plugin`), generated from the ESLint presets with every rule as a warning. Use them from an `oxlint.config.ts`:
+
+  ```ts
+  import { next } from "@websolutespa/eslint-config/oxlint";
+  import { defineConfig } from "oxlint";
+  export default defineConfig(next);
+  ```
+
+  Run `oxlint --type-aware` (with `oxlint-tsgolint`) for the promise rules. The ESLint flat configs are still exported for one more release.
+
+## 3.0.1-next.0
+
+### Patch Changes
+
+- Add a `no-restricted-imports` rule for `next/headers` outside `src/app` and route handlers.
+
 ## 3.1.2
 
 ## 3.1.1

package/README.md

@@ -1,11 +1,11 @@
-# @websolutespa/eslint-config
-
-[![npm version](https://badge.fury.io/js/@websolutespa/eslint-config.svg)](https://badge.fury.io/js/@websolutespa/eslint-config)
-
-Eslint shared config of the [BOM Repository](https://github.com/websolutespa/bom) by [websolute](https://www.websolute.com/).
-
-This package provides Websolute's .eslintrc as an extensible shared config.
-
----
-
-##### *this library is for internal usage and not production ready*
+# @websolutespa/eslint-config
+
+[![npm version](https://badge.fury.io/js/@websolutespa/eslint-config.svg)](https://badge.fury.io/js/@websolutespa/eslint-config)
+
+Eslint shared config of the [BOM Repository](https://github.com/websolutespa/bom) by [websolute](https://www.websolute.com/).
+
+This package provides Websolute's .eslintrc as an extensible shared config.
+
+---
+
+##### _this library is for internal usage and not production ready_

package/base.js

@@ -1,115 +1,126 @@
-import js from '@eslint/js';
-import stylistic from '@stylistic/eslint-plugin';
-import prettier from 'eslint-config-prettier';
-import onlyWarn from 'eslint-plugin-only-warn';
-import turbo from 'eslint-plugin-turbo';
-import typescript from 'typescript-eslint';
-
-/**
- * A shared ESLint configuration for the repository.
- *
- * @type {import("eslint").Linter.Config[]}
- * */
-export const base = [
-  js.configs.recommended,
-  prettier,
-  ...typescript.configs.recommended,
-  /*
-  {
-    rules: [
-      ...typescript.configs.recommended.rules,
-      ...typescript.configs['recommended-requiring-type-checking'].rules,
-    ]
-  },
-  */
-  {
-    plugins: {
-      turbo,
-    },
-    rules: {
-      'turbo/no-undeclared-env-vars': 'warn',
-    },
-  },
-  {
-    plugins: {
-      onlyWarn,
-    },
-  },
-  {
-    // Helpers must not read request data: only the template (page, layout,
-    // route handler) reads headers()/cookies()/draftMode() and passes it down.
-    rules: {
-      'no-restricted-imports': ['warn', {
-        paths: [{
-          name: 'next/headers',
-          message: 'Read request data (headers, cookies, draftMode) in the template under src/app and pass it down as an argument.',
-        }],
-      }],
-    },
-  },
-  {
-    files: [
-      'src/app/**',
-      '**/handlers/**',
-      '**/*.test.{ts,tsx}',
-    ],
-    rules: {
-      'no-restricted-imports': 'off',
-    },
-  },
-  {
-    ignores: [
-      '**/.next/**',
-      '**/.rollup.cache/**',
-      '**/.turbo/**',
-      '**/build/**',
-      '**/dist/**',
-      'src/app/(payload)/**',
-    ],
-  },
-  {
-    plugins: { '@stylistic': stylistic },
-    rules: {
-      '@stylistic/quotes': ['error', 'single'],
-      '@stylistic/comma-dangle': ['warn', {
-        'arrays': 'always-multiline',
-        'objects': 'always-multiline',
-        'imports': 'never',
-        'exports': 'never',
-        'functions': 'never',
-      }],
-      'for-direction': 'off',
-      '@stylistic/indent': ['error', 2, {
-        'SwitchCase': 1,
-      }],
-      '@stylistic/jsx-quotes': ['error', 'prefer-double'],
-      'no-cond-assign': ['error', 'always'],
-      'no-empty-function': 'off',
-      'no-empty': 'warn',
-      '@stylistic/no-extra-semi': 'error',
-      '@stylistic/no-multi-spaces': 'error',
-      'no-unreachable': 'error',
-      'no-unused-vars': 'off',
-      '@stylistic/semi': 'error',
-    },
-  }, {
-    files: [
-      '*.{ts,tsx}',
-    ],
-    rules: {
-      '@typescript-eslint/ban-types': 'off',
-      '@typescript-eslint/explicit-module-boundary-types': 'off',
-      '@typescript-eslint/no-empty-function': 'off',
-      '@typescript-eslint/no-empty-interface': 'off',
-      '@typescript-eslint/no-explicit-any': 'warn',
-      '@typescript-eslint/no-inferrable-types': 'off',
-      '@typescript-eslint/no-unused-vars': 'warn',
-      '@typescript-eslint/no-use-before-define': ['error', {
-        'functions': false,
-        'classes': false,
-        'variables': true,
-        'allowNamedExports': false,
-      }],
-    },
-  },
-];
+import js from '@eslint/js';
+import stylistic from '@stylistic/eslint-plugin';
+import prettier from 'eslint-config-prettier';
+import onlyWarn from 'eslint-plugin-only-warn';
+import turbo from 'eslint-plugin-turbo';
+import typescript from 'typescript-eslint';
+
+/**
+ * A shared ESLint configuration for the repository.
+ *
+ * @type {import("eslint").Linter.Config[]}
+ * */
+export const base = [
+  js.configs.recommended,
+  prettier,
+  ...typescript.configs.recommended,
+  /*
+  {
+    rules: [
+      ...typescript.configs.recommended.rules,
+      ...typescript.configs['recommended-requiring-type-checking'].rules,
+    ]
+  },
+  */
+  {
+    plugins: {
+      turbo,
+    },
+    rules: {
+      'turbo/no-undeclared-env-vars': 'warn',
+    },
+  },
+  {
+    plugins: {
+      onlyWarn,
+    },
+  },
+  {
+    // Helpers must not read request data: only the template (page, layout,
+    // route handler) reads headers()/cookies()/draftMode() and passes it down.
+    rules: {
+      'no-restricted-imports': [
+        'warn',
+        {
+          paths: [
+            {
+              name: 'next/headers',
+              message:
+                'Read request data (headers, cookies, draftMode) in the template under src/app and pass it down as an argument.',
+            },
+          ],
+        },
+      ],
+    },
+  },
+  {
+    files: ['src/app/**', '**/handlers/**', '**/*.test.{ts,tsx}'],
+    rules: {
+      'no-restricted-imports': 'off',
+    },
+  },
+  {
+    ignores: [
+      '**/.next/**',
+      '**/.rollup.cache/**',
+      '**/.turbo/**',
+      '**/build/**',
+      '**/dist/**',
+      'src/app/(payload)/**',
+    ],
+  },
+  {
+    plugins: { '@stylistic': stylistic },
+    rules: {
+      '@stylistic/quotes': ['error', 'single'],
+      '@stylistic/comma-dangle': [
+        'warn',
+        {
+          arrays: 'always-multiline',
+          objects: 'always-multiline',
+          imports: 'never',
+          exports: 'never',
+          functions: 'never',
+        },
+      ],
+      'for-direction': 'off',
+      '@stylistic/indent': [
+        'error',
+        2,
+        {
+          SwitchCase: 1,
+        },
+      ],
+      '@stylistic/jsx-quotes': ['error', 'prefer-double'],
+      'no-cond-assign': ['error', 'always'],
+      'no-empty-function': 'off',
+      'no-empty': 'warn',
+      '@stylistic/no-extra-semi': 'error',
+      '@stylistic/no-multi-spaces': 'error',
+      'no-unreachable': 'error',
+      'no-unused-vars': 'off',
+      '@stylistic/semi': 'error',
+    },
+  },
+  {
+    files: ['*.{ts,tsx}'],
+    rules: {
+      '@typescript-eslint/ban-types': 'off',
+      '@typescript-eslint/explicit-module-boundary-types': 'off',
+      '@typescript-eslint/no-empty-function': 'off',
+      '@typescript-eslint/no-empty-interface': 'off',
+      '@typescript-eslint/no-explicit-any': 'warn',
+      '@typescript-eslint/no-inferrable-types': 'off',
+      '@typescript-eslint/no-unused-vars': 'warn',
+      '@typescript-eslint/no-use-before-define': [
+        'error',
+        {
+          functions: false,
+          classes: false,
+          variables: true,
+          allowNamedExports: false,
+        },
+      ],
+    },
+  },
+];

package/next.js

@@ -1,79 +1,77 @@
-import nextPlugin from '@next/eslint-plugin-next';
-import { fixupPluginRules } from '@eslint/compat';
-import reactPluginSource from 'eslint-plugin-react';
-import reactHooks from 'eslint-plugin-react-hooks';
-import globals from 'globals';
-import { base } from './base.js';
-
-// eslint-plugin-react uses context methods removed in eslint 10
-const reactPlugin = fixupPluginRules(reactPluginSource);
-const reactRecommended = {
-  ...reactPluginSource.configs.flat.recommended,
-  plugins: { react: reactPlugin },
-};
-
-/**
- * A custom ESLint configuration for libraries that use Next.js.
- *
- * @type {import("eslint").Linter.Config[]}
- * */
-export const next = [
-  ...base,
-  {
-    ...reactRecommended,
-    languageOptions: {
-      ...reactRecommended.languageOptions,
-      globals: {
-        ...globals.serviceworker,
-      },
-    },
-  },
-  {
-    plugins: {
-      '@next/next': nextPlugin,
-    },
-    rules: {
-      ...nextPlugin.configs.recommended.rules,
-      ...nextPlugin.configs['core-web-vitals'].rules,
-    },
-  },
-  {
-    plugins: {
-      'react-hooks': reactHooks,
-    },
-    settings: { react: { version: 'detect' } },
-    rules: {
-      ...reactHooks.configs.recommended.rules,
-      // React scope no longer necessary with new JSX transform.
-      'react/react-in-jsx-scope': 'off',
-    },
-  },
-  {
-    files: [
-      '*.{ts,tsx}',
-    ],
-    rules: {
-      '@typescript-eslint/ban-ts-comment': 'warn',
-      '@typescript-eslint/no-empty-object-type': 'warn',
-      '@typescript-eslint/no-explicit-any': 'warn',
-      '@typescript-eslint/no-unused-vars': 'warn',
-      /*
-      '@typescript-eslint/no-unused-vars': [
-        'warn',
-        {
-          vars: 'all',
-          args: 'after-used',
-          ignoreRestSiblings: false,
-          argsIgnorePattern: '^_',
-          varsIgnorePattern: '^_',
-          destructuredArrayIgnorePattern: '^_',
-          caughtErrorsIgnorePattern: '^(_|ignore)',
-        },
-      ],
-      */
-    },
-  },
-  {
-    ignores: ['.next/'],
-  },
-];
+import nextPlugin from '@next/eslint-plugin-next';
+import { fixupPluginRules } from '@eslint/compat';
+import reactPluginSource from 'eslint-plugin-react';
+import reactHooks from 'eslint-plugin-react-hooks';
+import globals from 'globals';
+import { base } from './base.js';
+
+// eslint-plugin-react uses context methods removed in eslint 10
+const reactPlugin = fixupPluginRules(reactPluginSource);
+const reactRecommended = {
+  ...reactPluginSource.configs.flat.recommended,
+  plugins: { react: reactPlugin },
+};
+
+/**
+ * A custom ESLint configuration for libraries that use Next.js.
+ *
+ * @type {import("eslint").Linter.Config[]}
+ * */
+export const next = [
+  ...base,
+  {
+    ...reactRecommended,
+    languageOptions: {
+      ...reactRecommended.languageOptions,
+      globals: {
+        ...globals.serviceworker,
+      },
+    },
+  },
+  {
+    plugins: {
+      '@next/next': nextPlugin,
+    },
+    rules: {
+      ...nextPlugin.configs.recommended.rules,
+      ...nextPlugin.configs['core-web-vitals'].rules,
+    },
+  },
+  {
+    plugins: {
+      'react-hooks': reactHooks,
+    },
+    settings: { react: { version: 'detect' } },
+    rules: {
+      ...reactHooks.configs.recommended.rules,
+      // React scope no longer necessary with new JSX transform.
+      'react/react-in-jsx-scope': 'off',
+    },
+  },
+  {
+    files: ['*.{ts,tsx}'],
+    rules: {
+      '@typescript-eslint/ban-ts-comment': 'warn',
+      '@typescript-eslint/no-empty-object-type': 'warn',
+      '@typescript-eslint/no-explicit-any': 'warn',
+      '@typescript-eslint/no-unused-vars': 'warn',
+      /*
+      '@typescript-eslint/no-unused-vars': [
+        'warn',
+        {
+          vars: 'all',
+          args: 'after-used',
+          ignoreRestSiblings: false,
+          argsIgnorePattern: '^_',
+          varsIgnorePattern: '^_',
+          destructuredArrayIgnorePattern: '^_',
+          caughtErrorsIgnorePattern: '^(_|ignore)',
+        },
+      ],
+      */
+    },
+  },
+  {
+    ignores: ['.next/'],
+  },
+];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@websolutespa/eslint-config",
-  "version": "3.1.2",
-  "description": "Eslint shared config of the BOM Repository",
+  "version": "4.0.0-next.7",
+  "description": "Eslint shared configs of the BOM Repository (oxlint and oxfmt: @websolutespa/oxc)",
   "keywords": [
     "bom",
     "eslint",
@@ -39,4 +39,4 @@
     "./plugin": "./plugin.js",
     "./react": "./react.js"
   }
-}
+}

package/plugin.js

@@ -1,24 +1,24 @@
-import { react } from './react.js';
-
-/**
- * A custom ESLint configuration for plugins.
- *
- * @type {import("eslint").Linter.Config[]} */
-export const plugin = [
-  ...react,
-  {
-    rules: {
-      'no-restricted-exports': 'off',
-    },
-  },
-  {
-    languageOptions: {
-      // no type-aware rules are enabled, so no typescript project service is needed
-      // (it failed on files outside the tsconfig, e.g. tests and eslint.config.js)
-      parserOptions: {
-        sourceType: 'module',
-        ecmaVersion: 'latest',
-      },
-    },
-  },
-];
+import { react } from './react.js';
+
+/**
+ * A custom ESLint configuration for plugins.
+ *
+ * @type {import("eslint").Linter.Config[]} */
+export const plugin = [
+  ...react,
+  {
+    rules: {
+      'no-restricted-exports': 'off',
+    },
+  },
+  {
+    languageOptions: {
+      // no type-aware rules are enabled, so no typescript project service is needed
+      // (it failed on files outside the tsconfig, e.g. tests and eslint.config.js)
+      parserOptions: {
+        sourceType: 'module',
+        ecmaVersion: 'latest',
+      },
+    },
+  },
+];

package/react.js

@@ -1,40 +1,40 @@
-import { fixupPluginRules } from '@eslint/compat';
-import reactPluginSource from 'eslint-plugin-react';
-import reactHooksPlugin from 'eslint-plugin-react-hooks';
-import globals from 'globals';
-import { base } from './base.js';
-
-// eslint-plugin-react uses context methods removed in eslint 10
-const reactPlugin = fixupPluginRules(reactPluginSource);
-const reactRecommended = {
-  ...reactPluginSource.configs.flat.recommended,
-  plugins: { react: reactPlugin },
-};
-
-/**
- * A custom ESLint configuration for libraries that use React.
- *
- * @type {import("eslint").Linter.Config[]} */
-export const react = [
-  ...base,
-  reactRecommended,
-  {
-    languageOptions: {
-      ...reactRecommended.languageOptions,
-      globals: {
-        ...globals.serviceworker,
-        ...globals.browser,
-      },
-    },
-  },
-  {
-    plugins: {
-      'react-hooks': reactHooksPlugin,
-    },
-    settings: { react: { version: 'detect' } },
-    rules: {
-      ...reactHooksPlugin.configs.recommended.rules,
-      'react/react-in-jsx-scope': 'off',
-    },
-  },
-];
+import { fixupPluginRules } from '@eslint/compat';
+import reactPluginSource from 'eslint-plugin-react';
+import reactHooksPlugin from 'eslint-plugin-react-hooks';
+import globals from 'globals';
+import { base } from './base.js';
+
+// eslint-plugin-react uses context methods removed in eslint 10
+const reactPlugin = fixupPluginRules(reactPluginSource);
+const reactRecommended = {
+  ...reactPluginSource.configs.flat.recommended,
+  plugins: { react: reactPlugin },
+};
+
+/**
+ * A custom ESLint configuration for libraries that use React.
+ *
+ * @type {import("eslint").Linter.Config[]} */
+export const react = [
+  ...base,
+  reactRecommended,
+  {
+    languageOptions: {
+      ...reactRecommended.languageOptions,
+      globals: {
+        ...globals.serviceworker,
+        ...globals.browser,
+      },
+    },
+  },
+  {
+    plugins: {
+      'react-hooks': reactHooksPlugin,
+    },
+    settings: { react: { version: 'detect' } },
+    rules: {
+      ...reactHooksPlugin.configs.recommended.rules,
+      'react/react-in-jsx-scope': 'off',
+    },
+  },
+];