@jgarber/eslint-config 1.1.0 → 2.0.0

package/README.md

@@ -1,10 +1,13 @@
 # eslint-config
 
-Shareable [ESLint](https://eslint.org) configuration.
+Shareable [ESLint](https://eslint.org) configurations.
 
-> **Note**
->
-> As of v1.0.0, this shareable configuration uses ESLint's new "flat" configuration file format and, thus, may not be suitable for every project. See [the official documentation](https://eslint.org/docs/latest/use/configure/configuration-files-new) for details.
+[![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.
 
 ## Installation
 
@@ -14,26 +17,35 @@ npm install --save-dev @jgarber/eslint-config
 
 ## Usage
 
-Using [CommonJS module](https://nodejs.org/api/modules.html) syntax:
+Using [ECMAScript module (ESM)](https://nodejs.org/api/esm.html) syntax:
 
 ```js
 // eslint.config.js
-module.exports = require('@jgarber/eslint-config');
+import config from '@jgarber/eslint-config';
+
+export default config;
 ```
 
-Using [ECMAScript module (ESM)](https://nodejs.org/api/esm.html) syntax:
+Using [CommonJS module](https://nodejs.org/api/modules.html) syntax:
 
 ```js
 // eslint.config.js
-import config from '@jgarber/eslint-config';
+const config = require('@jgarber/eslint-config');
+const commonjs = require('@jgarber/eslint-config/commonjs');
 
-export default [
-  ...config,
-  {
-    files: ['**/*.js'],
-    languageOptions: {
-      sourceType: 'module'
-    }
-  }
+module.exports = [
+  ...commonjs,
+  ...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.

package/lib/ava.js

@@ -0,0 +1,22 @@
+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

@@ -0,0 +1,29 @@
+// 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

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,16 @@
+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

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,16 @@
+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

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1,88 @@
+// 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 }]
+    }
+  }
+];

package/package.json

@@ -1,36 +1,56 @@
 {
   "name": "@jgarber/eslint-config",
-  "version": "1.1.0",
+  "version": "2.0.0",
   "description": "Shareable ESLint configuration.",
   "keywords": [
+    "config",
+    "configuration",
+    "eslint-config",
     "eslint",
     "eslintconfig",
-    "eleventy",
-    "javascript"
+    "javascript",
+    "lint"
   ],
   "homepage": "https://github.com/jgarber623/eslint-config",
   "bugs": "https://github.com/jgarber623/eslint-config/issues",
   "license": "MIT",
   "author": "Jason Garber <jason@sixtwothree.org> (https://sixtwothree.org)",
-  "main": "index.js",
+  "files": [
+    "lib/*"
+  ],
+  "exports": {
+    "./package.json": "./package.json",
+    ".": "./lib/index.js",
+    "./ava": "./lib/ava.js",
+    "./commonjs": "./lib/commonjs.js"
+  },
   "repository": "github:jgarber623/eslint-config",
   "scripts": {
     "lint": "eslint .",
-    "test": "jasmine"
+    "test": "c8 ava"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=18.0.0"
   },
-  "devDependencies": {
-    "eslint": "^8.43.0",
+  "dependencies": {
+    "@eslint/js": "^8.50.0",
     "eslint-config-standard": "^17.1.0",
-    "globals": "^13.20.0",
-    "jasmine": "^5.0.2"
+    "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"
+  },
+  "devDependencies": {
+    "ava": "^5.3.1",
+    "c8": "^8.0.1",
+    "eslint": "^8.50.0"
   },
   "peerDependencies": {
-    "eslint": ">=8.43.0",
-    "eslint-config-standard": ">=17.1.0",
-    "globals": ">=13.20.0"
+    "eslint": ">=8.50.0"
   },
   "publishConfig": {
     "access": "public"

package/.editorconfig

@@ -1,10 +0,0 @@
-# EditorConfig is awesome: https://EditorConfig.org
-root = true
-
-[*]
-charset = utf-8
-end_of_line = lf
-insert_final_newline = true
-indent_size = 2
-indent_style = space
-trim_trailing_whitespace = true

package/.github/dependabot.yml

@@ -1,15 +0,0 @@
-version: 2
-
-updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-    assignees:
-      - "jgarber623"
-  - package-ecosystem: "npm"
-    directory: "/"
-    schedule:
-      interval: "monthly"
-    assignees:
-      - "jgarber623"

package/.github/workflows/ci.yml

@@ -1,27 +0,0 @@
-name: CI
-
-on: push
-
-jobs:
-  lint:
-    name: Lint files
-    runs-on: ubuntu-20.04
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version-file: ".nvmrc"
-          cache: npm
-      - run: npm ci
-      - run: npm run lint
-  test:
-    name: Test files
-    runs-on: ubuntu-20.04
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version-file: ".nvmrc"
-          cache: npm
-      - run: npm ci
-      - run: npm test

package/.nvmrc

@@ -1 +0,0 @@
-lts/*

package/eslint.config.js

@@ -1,15 +0,0 @@
-const globals = require('globals');
-
-const config = require('./index');
-
-module.exports = [
-  ...config,
-  {
-    files: ['spec/**/*[sS]pec.?(m)js'],
-    languageOptions: {
-      globals: {
-        ...globals.jasmine
-      }
-    }
-  }
-];

package/index.js

@@ -1,59 +0,0 @@
-/*
- * Import global identifiers from different JavaScript environments.
- *
- * @see {@link https://www.npmjs.com/package/globals}
- * @see {@link https://github.com/sindresorhus/globals/blob/HEAD/globals.json}
- */
-const globals = require('globals');
-
-/*
- * Import Standard's ESLint configurtation for use with ESLint's new "flat"
- * configuration file format.
- *
- * @see {@link https://github.com/standard/eslint-config-standard/blob/master/.eslintrc.json}
- * @see {@link https://eslint.org/docs/latest/use/configure/configuration-files-new}
- */
-const standard = require('eslint-config-standard');
-
-module.exports = [
-  {
-    plugins: Object.fromEntries(standard.plugins.map(plugin => [plugin, require(`eslint-plugin-${plugin}`)])),
-    rules: {
-      ...standard.rules,
-
-      /*
-       * Enforces consistent use of semicolons.
-       *
-       * @see {@link https://eslint.org/docs/latest/rules/semi}
-       */
-      semi: ['error', 'always'],
-
-      /*
-       * Enforces consistent spacing before function parentheses and will warn
-       * whenever whitespace doesn't match the preferences specified.
-       *
-       * @see {@link https://eslint.org/docs/latest/rules/space-before-function-paren}
-       */
-      'space-before-function-paren': ['error', {
-        anonymous: 'never',
-        asyncArrow: 'always',
-        named: 'never'
-      }]
-    }
-  },
-  {
-    /*
-     * By default, ESLint's "flat" config considers `*.js` files as ECMAScript
-     * modules (ESM). Instead, consider `*.js` files to be CommonJS modules.
-     *
-     * @see {@link https://eslint.org/docs/latest/use/configure/configuration-files-new#configuration-objects}
-     */
-    files: ['**/*.js'],
-    languageOptions: {
-      globals: {
-        ...globals.commonjs
-      },
-      sourceType: 'commonjs'
-    }
-  }
-];

package/spec/indexSpec.js

@@ -1,24 +0,0 @@
-const { FlatESLint } = require('eslint/use-at-your-own-risk');
-
-const config = require('../index');
-
-it('exports an Array', () => {
-  expect(Array.isArray(config)).toBe(true);
-});
-
-it('loads the config and validates correct syntax', async () => {
-  const eslint = new FlatESLint({ baseConfig: config });
-  const [results] = await eslint.lintText(';\n');
-
-  expect(results.errorCount).toEqual(0);
-});
-
-it('loads the config and invalidates incorrect syntax', async () => {
-  const eslint = new FlatESLint({ baseConfig: config });
-  const [results] = await eslint.lintText('(() => {}) ()\n');
-
-  const ruleIds = results.messages.map(({ ruleId }) => ruleId);
-
-  expect(results.errorCount).toEqual(2);
-  expect(ruleIds).toEqual(jasmine.arrayContaining(['func-call-spacing', 'semi']));
-});

package/spec/support/jasmine.json

@@ -1,14 +0,0 @@
-{
-  "spec_dir": "spec",
-  "spec_files": [
-    "**/*[sS]pec.?(m)js"
-  ],
-  "helpers": [
-    "helpers/**/*.?(m)js"
-  ],
-  "env": {
-    "failSpecWithNoExpectations": true,
-    "random": true,
-    "stopSpecOnExpectationFailure": false
-  }
-}