@jgarber/eslint-config 0.2.0 → 1.1.0

package/.editorconfig

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

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

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

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

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Jason Garber
+Copyright (c) 2022–present 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,3 +1,39 @@
 # eslint-config
 
-Shareable [ESLint](https://eslint.org) configurations.
+Shareable [ESLint](https://eslint.org) configuration.
+
+> **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.
+
+## Installation
+
+```sh
+npm install --save-dev @jgarber/eslint-config
+```
+
+## Usage
+
+Using [CommonJS module](https://nodejs.org/api/modules.html) syntax:
+
+```js
+// eslint.config.js
+module.exports = require('@jgarber/eslint-config');
+```
+
+Using [ECMAScript module (ESM)](https://nodejs.org/api/esm.html) syntax:
+
+```js
+// eslint.config.js
+import config from '@jgarber/eslint-config';
+
+export default [
+  ...config,
+  {
+    files: ['**/*.js'],
+    languageOptions: {
+      sourceType: 'module'
+    }
+  }
+];
+```

package/eslint.config.js

@@ -0,0 +1,15 @@
+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,22 +1,59 @@
-module.exports = {
-  extends: 'eslint:recommended',
+/*
+ * 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');
 
-  rules: {
-    // Enforces consistent use of trailing commas in object and array literals.
-    'comma-dangle': ['error', 'never'],
+/*
+ * 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');
 
-    // Enforces a consistent indentation style.
-    'indent': ['error', 2],
+module.exports = [
+  {
+    plugins: Object.fromEntries(standard.plugins.map(plugin => [plugin, require(`eslint-plugin-${plugin}`)])),
+    rules: {
+      ...standard.rules,
 
-    // Enforces consistent line endings independent of operating system, VCS,
-    // or editor used across your codebase.
-    'linebreak-style': ['error', 'unix'],
+      /*
+       * Enforces consistent use of semicolons.
+       *
+       * @see {@link https://eslint.org/docs/latest/rules/semi}
+       */
+      semi: ['error', 'always'],
 
-    // Enforces the consistent use of either backticks, double, or single
-    // quotes.
-    'quotes': ['error', 'single'],
-
-    // Enforces consistent use of semicolons.
-    '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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jgarber/eslint-config",
-  "version": "0.2.0",
-  "description": "Shareable ESLint configurations.",
+  "version": "1.1.0",
+  "description": "Shareable ESLint configuration.",
   "keywords": [
     "eslint",
     "eslintconfig",
@@ -12,20 +12,25 @@
   "bugs": "https://github.com/jgarber623/eslint-config/issues",
   "license": "MIT",
   "author": "Jason Garber <jason@sixtwothree.org> (https://sixtwothree.org)",
-  "files": [
-    "eleventy.js",
-    "module.js"
-  ],
   "main": "index.js",
   "repository": "github:jgarber623/eslint-config",
   "scripts": {
-    "test": "eslint ."
+    "lint": "eslint .",
+    "test": "jasmine"
   },
   "engines": {
     "node": ">=16.0.0"
   },
+  "devDependencies": {
+    "eslint": "^8.43.0",
+    "eslint-config-standard": "^17.1.0",
+    "globals": "^13.20.0",
+    "jasmine": "^5.0.2"
+  },
   "peerDependencies": {
-    "eslint": "^8.12.0"
+    "eslint": ">=8.43.0",
+    "eslint-config-standard": ">=17.1.0",
+    "globals": ">=13.20.0"
   },
   "publishConfig": {
     "access": "public"

package/spec/indexSpec.js

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

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

package/eleventy.js

@@ -1,16 +0,0 @@
-module.exports = {
-  extends: './index',
-
-  env: {
-    node: true
-  },
-
-  parserOptions: {
-    ecmaVersion: 2017
-  },
-
-  ignorePatterns: [
-    '!.eleventy.js',
-    'public/'
-  ]
-};

package/module.js

@@ -1,17 +0,0 @@
-module.exports = {
-  extends: './index',
-
-  env: {
-    browser: true,
-    es6: true
-  },
-
-  parserOptions: {
-    sourceType: 'module'
-  },
-
-  ignorePatterns: [
-    'dist/*',
-    'spec/*'
-  ]
-};