@jgarber/eslint-config 2.0.0 → 4.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022–present Jason Garber
+Copyright (c) 2022 Jason Garber
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,13 +1,13 @@
-# eslint-config
+# @jgarber/eslint-config
 
-Shareable [ESLint](https://eslint.org) configurations.
+**Shareable [ESLint](https://eslint.org) configuration.**
 
 [![npm](https://img.shields.io/npm/v/@jgarber/eslint-config.svg?logo=npm&style=for-the-badge)](https://www.npmjs.com/package/@jgarber/eslint-config)
 [![Downloads](https://img.shields.io/npm/dt/@jgarber/eslint-config.svg?logo=npm&style=for-the-badge)](https://www.npmjs.com/package/@jgarber/eslint-config)
 [![Build](https://img.shields.io/github/actions/workflow/status/jgarber623/eslint-config/ci.yml?branch=main&logo=github&style=for-the-badge)](https://github.com/jgarber623/eslint-config/actions/workflows/ci.yml)
 
 > [!IMPORTANT]\
-> These shareable configurations use ESLint's new "flat" configuration file format, which may not be suitable for every project. See [the official documentation](https://eslint.org/docs/latest/use/configure/configuration-files-new) for details.
+> This shareable configuration uses ESLint's new "flat" configuration file format, which may not be suitable for every project. See [the official documentation](https://eslint.org/docs/latest/use/configure/configuration-files-new) for details.
 
 ## Installation
 
@@ -21,31 +21,16 @@ Using [ECMAScript module (ESM)](https://nodejs.org/api/esm.html) syntax:
 
 ```js
 // eslint.config.js
-import config from '@jgarber/eslint-config';
-
-export default config;
+export { default } from "@jgarber/eslint-config";
 ```
 
 Using [CommonJS module](https://nodejs.org/api/modules.html) syntax:
 
 ```js
 // eslint.config.js
-const config = require('@jgarber/eslint-config');
-const commonjs = require('@jgarber/eslint-config/commonjs');
-
-module.exports = [
-  ...commonjs,
-  ...config
-];
+module.exports = (async () => await require("@jgarber/eslint-config"))();
 ```
 
-### Additional Configurations
-
-This package exports several other configurations that may be useful in conjunction with the main configuration (or, by themselves!):
-
-- `@jgarber/eslint-config/commonjs`: configures `languageOptions` and `globals` for CommonJS modules (especially useful if your `*.js` files target Node.js environments)
-- `@jgarber/eslint-config/ava`: configures linting for tests written using the [AVA](https://www.npmjs.com/package/ava) test framework
-
 ## License
 
-Ths package is freely available under the [MIT License](https://opensource.org/licenses/MIT). Use it, learn from it, fork it, improve it, change it, tailor it to your needs.
+@jgarber/eslint-config is freely available under the [MIT License](https://opensource.org/licenses/MIT).

package/index.cjs

@@ -0,0 +1,24 @@
+module.exports = (async () => {
+  const { default: eslintConfig } = await import("./index.js");
+
+  return [
+    ...eslintConfig,
+    {
+      languageOptions: {
+        /**
+         * @see {@link https://www.npmjs.com/package/globals}
+         * @see {@link https://github.com/sindresorhus/globals/blob/main/globals.json}
+         */
+        globals: {
+          __dirname: "readonly",
+          __filename: "readonly",
+          exports: "writable",
+          global: "readonly",
+          module: "readonly",
+          require: "readonly",
+        },
+        sourceType: "commonjs",
+      },
+    },
+  ];
+})();

package/index.js

@@ -0,0 +1,186 @@
+import js from "@eslint/js";
+import stylistic from "@stylistic/eslint-plugin";
+
+import arrayFunc from "eslint-plugin-array-func";
+import jsdoc from "eslint-plugin-jsdoc";
+import n from "eslint-plugin-n";
+import regexp from "eslint-plugin-regexp";
+import sortClassMembers from "eslint-plugin-sort-class-members";
+
+export default [
+  /**
+   * @see {@link https://www.npmjs.com/package/eslint-plugin-jsdoc}
+   */
+  jsdoc.configs["flat/recommended"],
+
+  /**
+   * @see {@link https://www.npmjs.com/package/@eslint/js}
+   * @see {@link https://eslint.org/docs/latest/rules/}
+   */
+  js.configs.recommended,
+
+  /**
+   * @see {@link https://eslint.style/guide/config-presets}
+   * @see {@link https://eslint.style/packages/default}
+   * @see {@link https://github.com/eslint-stylistic/eslint-stylistic/blob/main/packages/eslint-plugin/configs/customize.ts}
+   */
+  stylistic.configs.customize({
+    braceStyle: "1tbs",
+    jsx: false,
+    quotes: "double",
+    semi: true,
+  }),
+
+  /**
+   * @see {@link https://www.npmjs.com/package/eslint-plugin-array-func}
+   */
+  arrayFunc.configs.all,
+
+  /**
+   * @see {@link https://www.npmjs.com/package/eslint-plugin-n}
+   */
+  n.configs["flat/recommended"],
+
+  /**
+   * @see {@link https://www.npmjs.com/package/eslint-plugin-regexp}
+   * @see {@link https://github.com/ota-meshi/eslint-plugin-regexp/issues/695}
+   */
+  {
+    plugins: { regexp },
+    rules: regexp.configs.recommended.rules,
+  },
+
+  /**
+   * @see {@link https://www.npmjs.com/package/eslint-plugin-sort-class-members}
+   */
+  {
+    plugins: { "sort-class-members": sortClassMembers },
+    rules: sortClassMembers.configs.recommended.rules,
+  },
+
+  /**
+   * @see {@link https://www.npmjs.com/package/@jgarber/eslint-config}
+   */
+  {
+    rules: {
+      /**
+       * Enforce consistent line breaks between array elements.
+       *
+       * @see {@link https://eslint.style/rules/default/array-element-newline}
+       */
+      "@stylistic/array-element-newline": ["error", "consistent"],
+
+      /**
+       * Enforce consistent usage of line breaks between arguments of a function
+       * call.
+       *
+       * @see {@link https://eslint.style/rules/js/function-call-argument-newline}
+       */
+      "@stylistic/function-call-argument-newline": ["error", "consistent"],
+
+      /**
+       * Disallow spaces between the function name and the opening parenthesis
+       * that calls it.
+       *
+       * @see {@link https://eslint.style/rules/default/function-call-spacing}
+       */
+      "@stylistic/function-call-spacing": ["error"],
+
+      /**
+       * Enforce a consistent location for an arrow function containing an
+       * implicit return.
+       *
+       * @see {@link https://eslint.style/rules/default/implicit-arrow-linebreak}
+       */
+      "@stylistic/implicit-arrow-linebreak": "error",
+
+      /**
+       * Enforce consistent line endings independent of operating system, VCS,
+       * or editor.
+       *
+       * @see {@link https://eslint.style/rules/default/linebreak-style}
+       */
+      "@stylistic/linebreak-style": "warn",
+
+      /**
+       * Enforces a maximum line length to increase code readability and
+       * maintainability.
+       *
+       * @see {@link https://eslint.style/rules/default/max-len}
+       */
+      "@stylistic/max-len": ["warn", {
+        code: 120,
+        comments: 80,
+        ignoreUrls: true,
+        tabWidth: 2,
+      }],
+
+      /**
+       * Disallow unnecessary semicolons.
+       *
+       * @see {@link https://eslint.style/rules/default/no-extra-semi}
+       */
+      "@stylistic/no-extra-semi": "error",
+
+      /**
+       * Warns against using the arrow function syntax in places where it could
+       * be confused with a comparison operator.
+       *
+       * @see {@link https://eslint.style/rules/default/no-confusing-arrow}
+       */
+      "@stylistic/no-confusing-arrow": "warn",
+
+      /**
+       * Enforce consistent spacing before function parentheses.
+       *
+       * @see {@link https://eslint.style/rules/js/space-before-function-paren}
+       */
+      "@stylistic/space-before-function-paren": ["error", {
+        anonymous: "never",
+        asyncArrow: "always",
+        named: "never",
+      }],
+
+      /**
+       *  Control spacing around colons of `case` and `default` clauses in
+       * switch statements.
+       *
+       * @see {@link https://eslint.style/rules/default/switch-colon-spacing}
+       */
+      "@stylistic/switch-colon-spacing": "error",
+
+      /**
+       * Sorts tags by a specified sequence according to tag name, optionally
+       * adding line breaks between tag groups.
+       *
+       * @see {@link https://github.com/gajus/eslint-plugin-jsdoc/blob/HEAD/docs/rules/sort-tags.md#user-content-sort-tags-options-linesbetween}
+       */
+      "jsdoc/sort-tags": ["warn"],
+
+      /**
+       * Enforces lines (or no lines) between tags.
+       *
+       * @see {@link https://github.com/gajus/eslint-plugin-jsdoc/blob/HEAD/docs/rules/tag-lines.md}
+       */
+      "jsdoc/tag-lines": ["warn", "any", { startLines: 1 }],
+
+      /**
+       * Enforce sorted import declarations within modules.
+       *
+       * @see {@link https://eslint.org/docs/latest/rules/sort-imports}
+       */
+      "sort-imports": ["error", { allowSeparatedGroups: true }],
+
+      /**
+       * Require object keys to be sorted.
+       *
+       * @see {@link https://eslint.org/docs/latest/rules/sort-keys}
+       */
+      "sort-keys": ["error", "asc", {
+        allowLineSeparatedGroups: true,
+        caseSensitive: false,
+        natural: true,
+      }],
+    },
+  },
+];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jgarber/eslint-config",
-  "version": "2.0.0",
+  "version": "4.0.0",
   "description": "Shareable ESLint configuration.",
   "keywords": [
     "config",
@@ -16,41 +16,36 @@
   "license": "MIT",
   "author": "Jason Garber <jason@sixtwothree.org> (https://sixtwothree.org)",
   "files": [
-    "lib/*"
+    "index.cjs",
+    "index.js"
   ],
+  "type": "module",
   "exports": {
-    "./package.json": "./package.json",
-    ".": "./lib/index.js",
-    "./ava": "./lib/ava.js",
-    "./commonjs": "./lib/commonjs.js"
+    "import": "./index.js",
+    "require": "./index.cjs"
   },
   "repository": "github:jgarber623/eslint-config",
   "scripts": {
     "lint": "eslint .",
-    "test": "c8 ava"
-  },
-  "engines": {
-    "node": ">=18.0.0"
+    "test": "NODE_V8_COVERAGE=coverage node --experimental-test-coverage --test"
   },
   "dependencies": {
-    "@eslint/js": "^8.50.0",
-    "eslint-config-standard": "^17.1.0",
-    "eslint-plugin-ava": "^14.0.0",
-    "eslint-plugin-array-func": "^4.0.0",
-    "eslint-plugin-jsdoc": "^46.8.2",
-    "eslint-plugin-n": "^16.1.0",
-    "eslint-plugin-promise": "^6.1.1",
-    "eslint-plugin-regexp": "^1.15.0",
-    "eslint-plugin-sort-class-members": "^1.19.0",
-    "eslint-plugin-unicorn": "^48.0.1"
+    "@eslint/js": "^8.56.0",
+    "@stylistic/eslint-plugin": "^1.6.1",
+    "eslint-plugin-array-func": "^5.0.1",
+    "eslint-plugin-jsdoc": "^48.0.6",
+    "eslint-plugin-n": "^16.6.2",
+    "eslint-plugin-regexp": "^2.2.0",
+    "eslint-plugin-sort-class-members": "^1.19.0"
   },
   "devDependencies": {
-    "ava": "^5.3.1",
-    "c8": "^8.0.1",
-    "eslint": "^8.50.0"
+    "eslint": "^8.56.0"
   },
   "peerDependencies": {
-    "eslint": ">=8.50.0"
+    "eslint": ">=8.56.0"
+  },
+  "engines": {
+    "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
   },
   "publishConfig": {
     "access": "public"

package/lib/ava.js

@@ -1,22 +0,0 @@
-const ava = require('eslint-plugin-ava');
-
-module.exports = [
-  {
-    // Use AVA's default file-matching patterns.
-    //
-    // https://github.com/avajs/ava/blob/HEAD/docs/05-command-line.md
-    files: [
-      'test.js',
-      'src/test.js',
-      'source/test.js',
-      '**/test-*.js',
-      '**/*.spec.js',
-      '**/*.test.js',
-      '**/test/**/*.js',
-      '**/tests/**/*.js',
-      '**/__tests__/**/*.js'
-    ],
-    plugins: { ava },
-    rules: ava.configs.recommended.rules
-  }
-];

package/lib/commonjs.js

@@ -1,29 +0,0 @@
-// By default, ESLint's "flat" config considers `*.js` files to be ECMAScript
-// modules (ESM). `*.mjs` files are always parsed as ESM modules and `*.cjs`
-// files are always parsed as CommonJS modules.
-//
-// This configures ESLint to treat `*.js` files as CommonJS modules.
-//
-// Authors may also specify the module type in `package.json` using either
-// `"type": "commonjs"` or `"type": "module"`.
-//
-// https://eslint.org/docs/latest/use/configure/configuration-files-new#configuration-objects
-// https://nodejs.org/dist/latest-v18.x/docs/api/modules.html#enabling
-module.exports = [
-  {
-    files: ['**/*.js'],
-    languageOptions: {
-      // https://www.npmjs.com/package/globals
-      // https://github.com/sindresorhus/globals/blob/HEAD/globals.json
-      globals: {
-        __dirname: 'readonly',
-        __filename: 'readonly',
-        exports: 'writable',
-        global: 'readonly',
-        module: 'readonly',
-        require: 'readonly'
-      },
-      sourceType: 'commonjs'
-    }
-  }
-];

package/lib/compat/eslint-plugin-array-func.js

@@ -1,21 +0,0 @@
-const plugin = require('eslint-plugin-array-func');
-const { configs, rules } = plugin;
-
-module.exports = {
-  configs: {
-    'flat/all': {
-      plugins: { 'array-func': plugin },
-      rules: {
-        ...configs.recommended.rules,
-        ...configs.all.rules
-      }
-    },
-    'flat/recommended': {
-      plugins: { 'array-func': plugin },
-      rules: {
-        ...configs.recommended.rules
-      }
-    }
-  },
-  rules
-};

package/lib/compat/eslint-plugin-promise.js

@@ -1,12 +0,0 @@
-const plugin = require('eslint-plugin-promise');
-const { configs, rules } = plugin;
-
-module.exports = {
-  configs: {
-    'flat/recommended': {
-      plugins: { promise: plugin },
-      rules: configs.recommended.rules
-    }
-  },
-  rules
-};

package/lib/compat/eslint-plugin-regexp.js

@@ -1,16 +0,0 @@
-const plugin = require('eslint-plugin-regexp');
-const { configs, rules } = plugin;
-
-module.exports = {
-  configs: {
-    'flat/all': {
-      plugins: { regexp: plugin },
-      rules: configs.all.rules
-    },
-    'flat/recommended': {
-      plugins: { regexp: plugin },
-      rules: configs.recommended.rules
-    }
-  },
-  rules
-};

package/lib/compat/eslint-plugin-sort-class-members.js

@@ -1,12 +0,0 @@
-const plugin = require('eslint-plugin-sort-class-members');
-const { configs, rules } = plugin;
-
-module.exports = {
-  configs: {
-    'flat/recommended': {
-      plugins: { 'sort-class-members': plugin },
-      rules: configs.recommended.rules
-    }
-  },
-  rules
-};

package/lib/compat/eslint-plugin-unicorn.js

@@ -1,16 +0,0 @@
-const plugin = require('eslint-plugin-unicorn');
-const { configs, rules } = plugin;
-
-module.exports = {
-  configs: {
-    'flat/all': {
-      plugins: { unicorn: plugin },
-      rules: configs.all.rules
-    },
-    'flat/recommended': {
-      plugins: { unicorn: plugin },
-      rules: configs.recommended.rules
-    }
-  },
-  rules
-};

package/lib/compat/index.js

@@ -1,5 +0,0 @@
-module.exports.arrayFunc = require('./eslint-plugin-array-func');
-module.exports.promise = require('./eslint-plugin-promise');
-module.exports.regexp = require('./eslint-plugin-regexp');
-module.exports.sortClassMembers = require('./eslint-plugin-sort-class-members');
-module.exports.unicorn = require('./eslint-plugin-unicorn');

package/lib/index.js

@@ -1,88 +0,0 @@
-// ESLint shared configurations
-const js = require('@eslint/js');
-const standard = require('eslint-config-standard');
-
-// ESLint plugins
-const jsdoc = require('eslint-plugin-jsdoc');
-const n = require('eslint-plugin-n');
-
-// Compat module for non-"flat"-compatible plugins
-const compat = require('./compat');
-
-module.exports = [
-  // https://www.npmjs.com/package/eslint-plugin-jsdoc
-  jsdoc.configs['flat/recommended-error'],
-
-  // https://www.npmjs.com/package/eslint-plugin-n
-  n.configs['flat/recommended'],
-
-  // https://www.npmjs.com/package/eslint-plugin-array-func
-  compat.arrayFunc.configs['flat/all'],
-
-  // https://www.npmjs.com/package/eslint-plugin-promise
-  compat.promise.configs['flat/recommended'],
-
-  // https://www.npmjs.com/package/eslint-plugin-regexp
-  compat.regexp.configs['flat/recommended'],
-
-  // https://www.npmjs.com/package/eslint-plugin-sort-class-members
-  compat.sortClassMembers.configs['flat/recommended'],
-
-  // https://www.npmjs.com/package/eslint-plugin-unicorn
-  compat.unicorn.configs['flat/recommended'],
-
-  {
-    rules: {
-      // https://www.npmjs.com/package/@eslint/js
-      ...js.configs.recommended.rules,
-
-      // https://www.npmjs.com/package/eslint-config-standard
-      //
-      // Remove eslint-plugin-import rules until the following "flat" config-
-      // related issues are resolved.
-      //
-      // https://github.com/import-js/eslint-plugin-import/issues/2556
-      // https://github.com/import-js/eslint-plugin-import/pull/2829
-      ...Object.fromEntries(
-        Object.entries(standard.rules).filter(([key]) => {
-          return !key.startsWith('import/');
-        })
-      ),
-
-      // https://eslint.org/docs/latest/rules/semi
-      semi: ['error', 'always'],
-
-      // https://eslint.org/docs/latest/rules/sort-keys
-      'sort-keys': ['error', 'asc', {
-        allowLineSeparatedGroups: true,
-        natural: true
-      }],
-
-      // https://eslint.org/docs/latest/rules/space-before-function-paren
-      'space-before-function-paren': ['error', {
-        anonymous: 'never',
-        asyncArrow: 'always',
-        named: 'never'
-      }],
-
-      // Disable rules conflicting with eslint-plugin-unicorn.
-      //
-      // https://www.npmjs.com/package/eslint-plugin-array-func
-      'array-func/prefer-flat': 'off',
-      'array-func/prefer-flat-map': 'off',
-
-      // https://github.com/gajus/eslint-plugin-jsdoc/blob/HEAD/docs/rules/tag-lines.md
-      'jsdoc/tag-lines': ['error', 'any', { startLines: 1 }],
-
-      // ¯\_(ツ)_/¯
-      //
-      // https://github.com/sindresorhus/eslint-plugin-unicorn/blob/HEAD/docs/rules/no-null.md}
-      // https://github.com/sindresorhus/eslint-plugin-unicorn/blob/HEAD/docs/rules/prefer-module.md}
-      'unicorn/no-null': 'off',
-      'unicorn/prefer-module': 'off',
-
-      // https://github.com/sindresorhus/eslint-plugin-unicorn/blob/HEAD/docs/rules/prevent-abbreviations.md
-      'unicorn/prevent-abbreviations': ['warn', { checkFilenames: false }]
-    }
-  }
-];