eslint-config-auditor 0.5.0 → 1.0.0

package/README.md

@@ -3,97 +3,135 @@
 
 # eslint-config-auditor [![npm][npm-image]][npm-url]
 
-> Shareable ESLint Config to help you write clear, efficient JavaScript code. 😼
+> Shareable ESLint flat config to help you write clear, efficient JavaScript code. 😼
 
 Auditor uses sane defaults focused on code readability. The Auditor's philosophy is that good code means easy to understand code.
 
-Along with its own rules, Auditor by default includes battle-tested rules from [`eslint:recommended`](https://eslint.org/docs/rules/), [`plugin:import`](https://github.com/benmosher/eslint-plugin-import), [`plugin:promise`](https://github.com/xjamundx/eslint-plugin-promise), and [`plugin:node`](https://github.com/mysticatea/eslint-plugin-node). Both on browser and Node.js, **Auditor gives you the confidence you need to write efficient JavaScript code**.
+Along with its own rules, Auditor by default includes battle-tested rules from [`eslint-plugin-import`](https://github.com/import-js/eslint-plugin-import), [`eslint-plugin-promise`](https://github.com/eslint-community/eslint-plugin-promise), and [`eslint-plugin-n`](https://github.com/eslint-community/eslint-plugin-n). Both on browser and Node.js, **Auditor gives you the confidence you need to write efficient JavaScript code**.
 
-Besides linting standard JavaScript code gracefully, Auditor also has first-class support to React, Jest, and TypeScript. See [rules](#rules) about usage.
+Besides linting standard JavaScript code gracefully, Auditor also has first-class support for React, Jest, and TypeScript. See [rules](#rules) about usage.
+
+Version 1.0.0 targets **ESLint 9+ and the flat config format** (`eslint.config.js`). All plugins ship as regular dependencies, so installing this package is all you need.
 
 ## Installation
 
 ```
-npm install --save-dev eslint-config-auditor
+npm install --save-dev eslint eslint-config-auditor
 ```
 
+Requires ESLint `>=9` and Node.js `>=18.18.0`.
+
 ## Usage
 
-Auditor's shareable config is meant to be the source of rules for another application (yet to be built), but as a shareable config, you can use it the same way by installing its peer dependencies.
+In your `eslint.config.js` (or `eslint.config.mjs`):
 
+```js
+import auditor from 'eslint-config-auditor';
+
+export default [...auditor];
 ```
-npm install --save-dev eslint-plugin-{import,promise,node}
-```
 
-Will install [import](https://github.com/benmosher/eslint-plugin-import), [promise](https://github.com/xjamundx/eslint-plugin-promise), and [node](https://github.com/mysticatea/eslint-plugin-node) plugins. You can now extend your config as you usually would.
+The default export is the equivalent of the old root config: `recommended` + `finest` combined.
+
+CommonJS (`eslint.config.cjs`) works too:
 
-In your `.eslintrc`
+```js
+const auditor = require('eslint-config-auditor').default;
 
-```json
-{
-  "extends": "auditor"
-}
+module.exports = [...auditor];
 ```
 
 ## Rules
 
-Installing the above adds all default rules for Auditor. Auditor has two main rule configs:
+Auditor has two main rule configs, available as named exports and subpath imports:
 
-* `auditor/recommended` all the needed rules to write consise JavaScript. Includes all best-practices, Node.js, import, and promise rules. Recommended for most users.
-* `auditor/finest` Auditor at its finest. Strict rules for advanced use cases such as code refactors and open-source software where code changes can break infinite clients. Includes the recommended config.
+* `recommended` all the needed rules to write concise JavaScript. Includes all best-practices, Node.js, import, and promise rules. Recommended for most users.
+* `finest` Auditor at its finest. Strict rules for advanced use cases such as code refactors and open-source software where code changes can break infinite clients. Use it on top of `recommended`.
 
-Auditor also offers first-class support to Jest, React, and TypeScript but since these are opinionated tools, you need to activate them for usage manually.
+```js
+// eslint.config.js
+import recommended from 'eslint-config-auditor/recommended';
+import finest from 'eslint-config-auditor/finest';
 
-### Jest
+export default [...recommended, ...finest];
+```
 
-Uses [`eslint-plugin-jest`](https://www.npmjs.com/package/eslint-plugin-jest).
+Auditor also offers first-class support for Jest, React, and TypeScript but since these are opinionated tools, you need to activate them manually.
 
-```
-npm install --save-dev eslint-plugin-jest -D
-```
+### Jest
 
-```json
-{
-  "extends": [
-    "auditor",
-    "auditor/jest"
-  ]
-}
+Uses [`eslint-plugin-jest`](https://www.npmjs.com/package/eslint-plugin-jest) (already included).
+
+```js
+// eslint.config.js
+import auditor from 'eslint-config-auditor';
+import jest from 'eslint-config-auditor/jest';
+
+export default [
+  ...auditor,
+  // Scope Jest rules to your test files
+  ...jest.map((config) => ({
+    ...config,
+    files: ['**/*.test.{js,jsx,ts,tsx}', '**/*.spec.{js,jsx,ts,tsx}'],
+  })),
+];
 ```
 
 ### React
 
-Uses [`eslint-plugin-react`](https://www.npmjs.com/package/eslint-plugin-react), [`eslint-plugin-react-hooks`](https://www.npmjs.com/package/eslint-plugin-react-hooks), and [`eslint-plugin-jsx-a11y`](https://www.npmjs.com/package/eslint-plugin-jsx-a11y).
+Uses [`eslint-plugin-react`](https://www.npmjs.com/package/eslint-plugin-react), [`eslint-plugin-react-hooks`](https://www.npmjs.com/package/eslint-plugin-react-hooks), and [`eslint-plugin-jsx-a11y`](https://www.npmjs.com/package/eslint-plugin-jsx-a11y) (already included).
 
-```
-npm install --save-dev eslint-plugin-{react,react-hooks,jsx-a11y} -D
-```
+```js
+// eslint.config.js
+import auditor from 'eslint-config-auditor';
+import react from 'eslint-config-auditor/react';
 
-```json
-{
-  "extends": [
-    "auditor",
-    "auditor/react"
-  ]
-}
+export default [...auditor, ...react];
 ```
+
 ### TypeScript
 
-Uses [`@typescript-eslint/eslint-plugin`](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin), [`eslint-plugin-import`](https://www.npmjs.com/package/eslint-plugin-import), and[`@typescript-eslint/parser`](https://www.npmjs.com/package/@typescript-eslint/parser).
+Uses [`typescript-eslint`](https://typescript-eslint.io) and [`eslint-plugin-import`](https://www.npmjs.com/package/eslint-plugin-import) (already included). Rules are scoped to `**/*.ts`/`**/*.tsx` files and use the [project service](https://typescript-eslint.io/packages/parser/#projectservice) for type-aware linting, so a `tsconfig.json` in your project root is all you need.
 
-```
-npm install --save-dev @typescript-eslint/{eslint-plugin,parser} -D
+```js
+// eslint.config.js
+import auditor from 'eslint-config-auditor';
+import typescript from 'eslint-config-auditor/typescript';
+
+export default [...auditor, ...typescript];
 ```
 
-```json
-{
-  "extends": [
-    "auditor",
-    "auditor/typescript"
-  ]
-}
+All variants can also be pulled from the root entry as named exports:
+
+```js
+import { recommended, finest, jest, react, typescript } from 'eslint-config-auditor';
 ```
 
+## Migrating from 0.x
+
+Version 0.x shipped legacy `.eslintrc` configs for ESLint 8. Version 1.0.0 is a flat-config rewrite for ESLint 9. To migrate:
+
+1. Upgrade to `eslint@>=9` and remove the plugin packages you installed manually for 0.x (`eslint-plugin-import`, `eslint-plugin-promise`, `eslint-plugin-node`, `eslint-plugin-jest`, `eslint-plugin-react`, `eslint-plugin-react-hooks`, `eslint-plugin-jsx-a11y`, `@typescript-eslint/parser`, `@typescript-eslint/eslint-plugin`). They are now bundled as dependencies of this package.
+2. Replace your `.eslintrc`/`.eslintrc.json` with an `eslint.config.js`:
+
+   ```diff
+   - { "extends": ["auditor", "auditor/react"] }
+   ```
+
+   ```js
+   // eslint.config.js
+   import auditor from 'eslint-config-auditor';
+   import react from 'eslint-config-auditor/react';
+
+   export default [...auditor, ...react];
+   ```
+
+3. Note these behavioral changes:
+   * `eslint-plugin-node` was replaced by its maintained fork [`eslint-plugin-n`](https://github.com/eslint-community/eslint-plugin-n). The `node/` rule prefix is preserved, so inline directives like `// eslint-disable-next-line node/no-sync` keep working. `node/shebang` is now `node/hashbang`.
+   * `@typescript-eslint/parser` + `@typescript-eslint/eslint-plugin` were replaced by [`typescript-eslint`](https://typescript-eslint.io) v8. The TypeScript config now uses `projectService: true` instead of `parserOptions.project` globs.
+   * Environments (`env`) and `parserOptions` were translated to `languageOptions`, with globals provided by the [`globals`](https://www.npmjs.com/package/globals) package.
+   * A few rules were removed or renamed upstream. See [MIGRATION.md](./MIGRATION.md) for the complete old-rule → disposition table.
+
 ## License
 
 MIT (c) Cezar Augusto.

package/dist/finest.cjs

@@ -0,0 +1,148 @@
+"use strict";
+var __webpack_require__ = {};
+(()=>{
+    __webpack_require__.n = (module)=>{
+        var getter = module && module.__esModule ? ()=>module['default'] : ()=>module;
+        __webpack_require__.d(getter, {
+            a: getter
+        });
+        return getter;
+    };
+})();
+(()=>{
+    __webpack_require__.d = (exports1, definition)=>{
+        for(var key in definition)if (__webpack_require__.o(definition, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
+            enumerable: true,
+            get: definition[key]
+        });
+    };
+})();
+(()=>{
+    __webpack_require__.o = (obj, prop)=>Object.prototype.hasOwnProperty.call(obj, prop);
+})();
+(()=>{
+    __webpack_require__.r = (exports1)=>{
+        if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
+})();
+var __webpack_exports__ = {};
+__webpack_require__.r(__webpack_exports__);
+__webpack_require__.d(__webpack_exports__, {
+    default: ()=>src_finest
+});
+const external_eslint_plugin_jsx_a11y_namespaceObject = require("eslint-plugin-jsx-a11y");
+var external_eslint_plugin_jsx_a11y_default = /*#__PURE__*/ __webpack_require__.n(external_eslint_plugin_jsx_a11y_namespaceObject);
+const external_eslint_plugin_n_namespaceObject = require("eslint-plugin-n");
+var external_eslint_plugin_n_default = /*#__PURE__*/ __webpack_require__.n(external_eslint_plugin_n_namespaceObject);
+const external_eslint_plugin_promise_namespaceObject = require("eslint-plugin-promise");
+var external_eslint_plugin_promise_default = /*#__PURE__*/ __webpack_require__.n(external_eslint_plugin_promise_namespaceObject);
+const external_eslint_plugin_import_namespaceObject = require("eslint-plugin-import");
+var external_eslint_plugin_import_default = /*#__PURE__*/ __webpack_require__.n(external_eslint_plugin_import_namespaceObject);
+const importPlugin = external_eslint_plugin_import_default() ?? external_eslint_plugin_import_namespaceObject;
+const import_plugin = importPlugin;
+const finest = [
+    {
+        name: 'auditor/finest',
+        plugins: {
+            import: import_plugin,
+            'jsx-a11y': external_eslint_plugin_jsx_a11y_default(),
+            node: external_eslint_plugin_n_default(),
+            promise: external_eslint_plugin_promise_default()
+        },
+        rules: {
+            complexity: [
+                'warn',
+                10
+            ],
+            'func-names': 'warn',
+            'max-lines': [
+                'warn',
+                500
+            ],
+            'max-lines-per-function': [
+                'warn',
+                {
+                    max: 45,
+                    skipComments: true
+                }
+            ],
+            'max-nested-callbacks': [
+                'warn',
+                6
+            ],
+            'max-params': [
+                'warn',
+                3
+            ],
+            'max-statements-per-line': [
+                'warn',
+                {
+                    max: 1
+                }
+            ],
+            'no-await-in-loop': 'warn',
+            'no-console': [
+                'off',
+                {
+                    allow: [
+                        'info',
+                        'warn',
+                        'error'
+                    ]
+                }
+            ],
+            'no-promise-executor-return': 'error',
+            'node/no-unpublished-bin': 'warn',
+            'node/no-unpublished-import': 'warn',
+            'node/no-unpublished-require': 'warn',
+            'node/prefer-promises/dns': 'warn',
+            'node/prefer-promises/fs': 'warn',
+            'promise/prefer-await-to-callbacks': 'warn',
+            'promise/prefer-await-to-then': 'warn',
+            'prefer-arrow-callback': [
+                'warn',
+                {
+                    allowNamedFunctions: false,
+                    allowUnboundThis: true
+                }
+            ],
+            'node/no-unsupported-features/es-syntax': 'warn',
+            'node/no-missing-import': 'warn',
+            'import/no-relative-parent-imports': 'warn',
+            'node/no-unsupported-features/node-builtins': 'warn',
+            'no-duplicate-imports': 'warn',
+            'import/exports-last': 'error',
+            'node/no-callback-literal': 'error',
+            'jsx-a11y/aria-role': 'error',
+            'jsx-a11y/alt-text': 'error',
+            'array-callback-return': [
+                'error',
+                {
+                    allowImplicit: false,
+                    checkForEach: false
+                }
+            ],
+            'object-shorthand': [
+                'error',
+                'always',
+                {
+                    avoidQuotes: true,
+                    ignoreConstructors: false
+                }
+            ]
+        }
+    }
+];
+const src_finest = finest;
+exports["default"] = __webpack_exports__["default"];
+for(var __webpack_i__ in __webpack_exports__)if (-1 === [
+    "default"
+].indexOf(__webpack_i__)) exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/finest.d.ts

@@ -0,0 +1,3 @@
+import type { Linter } from 'eslint';
+declare const finest: Linter.Config[];
+export default finest;

package/dist/finest.js

@@ -0,0 +1,101 @@
+import * as __WEBPACK_EXTERNAL_MODULE_eslint_plugin_jsx_a11y_fe6a299b__ from "eslint-plugin-jsx-a11y";
+import * as __WEBPACK_EXTERNAL_MODULE_eslint_plugin_n_9e0a97d1__ from "eslint-plugin-n";
+import * as __WEBPACK_EXTERNAL_MODULE_eslint_plugin_promise_3f421790__ from "eslint-plugin-promise";
+import * as __WEBPACK_EXTERNAL_MODULE_eslint_plugin_import_fddde6bb__ from "eslint-plugin-import";
+const importPlugin = __WEBPACK_EXTERNAL_MODULE_eslint_plugin_import_fddde6bb__["default"] ?? __WEBPACK_EXTERNAL_MODULE_eslint_plugin_import_fddde6bb__;
+const import_plugin = importPlugin;
+const finest = [
+    {
+        name: 'auditor/finest',
+        plugins: {
+            import: import_plugin,
+            'jsx-a11y': __WEBPACK_EXTERNAL_MODULE_eslint_plugin_jsx_a11y_fe6a299b__["default"],
+            node: __WEBPACK_EXTERNAL_MODULE_eslint_plugin_n_9e0a97d1__["default"],
+            promise: __WEBPACK_EXTERNAL_MODULE_eslint_plugin_promise_3f421790__["default"]
+        },
+        rules: {
+            complexity: [
+                'warn',
+                10
+            ],
+            'func-names': 'warn',
+            'max-lines': [
+                'warn',
+                500
+            ],
+            'max-lines-per-function': [
+                'warn',
+                {
+                    max: 45,
+                    skipComments: true
+                }
+            ],
+            'max-nested-callbacks': [
+                'warn',
+                6
+            ],
+            'max-params': [
+                'warn',
+                3
+            ],
+            'max-statements-per-line': [
+                'warn',
+                {
+                    max: 1
+                }
+            ],
+            'no-await-in-loop': 'warn',
+            'no-console': [
+                'off',
+                {
+                    allow: [
+                        'info',
+                        'warn',
+                        'error'
+                    ]
+                }
+            ],
+            'no-promise-executor-return': 'error',
+            'node/no-unpublished-bin': 'warn',
+            'node/no-unpublished-import': 'warn',
+            'node/no-unpublished-require': 'warn',
+            'node/prefer-promises/dns': 'warn',
+            'node/prefer-promises/fs': 'warn',
+            'promise/prefer-await-to-callbacks': 'warn',
+            'promise/prefer-await-to-then': 'warn',
+            'prefer-arrow-callback': [
+                'warn',
+                {
+                    allowNamedFunctions: false,
+                    allowUnboundThis: true
+                }
+            ],
+            'node/no-unsupported-features/es-syntax': 'warn',
+            'node/no-missing-import': 'warn',
+            'import/no-relative-parent-imports': 'warn',
+            'node/no-unsupported-features/node-builtins': 'warn',
+            'no-duplicate-imports': 'warn',
+            'import/exports-last': 'error',
+            'node/no-callback-literal': 'error',
+            'jsx-a11y/aria-role': 'error',
+            'jsx-a11y/alt-text': 'error',
+            'array-callback-return': [
+                'error',
+                {
+                    allowImplicit: false,
+                    checkForEach: false
+                }
+            ],
+            'object-shorthand': [
+                'error',
+                'always',
+                {
+                    avoidQuotes: true,
+                    ignoreConstructors: false
+                }
+            ]
+        }
+    }
+];
+const src_finest = finest;
+export { src_finest as default };

package/dist/import-plugin.d.ts

@@ -0,0 +1,12 @@
+import type { ESLint, Linter } from 'eslint';
+type ImportPlugin = ESLint.Plugin & {
+    flatConfigs: {
+        recommended: Linter.Config;
+        errors: Linter.Config;
+        warnings: Linter.Config;
+        typescript: Linter.Config;
+        react: Linter.Config;
+    };
+};
+declare const importPlugin: ImportPlugin;
+export default importPlugin;