@cargosense/eslint-config 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 CargoSense, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,46 @@
+# eslint-config
+
+**Shareable [ESLint](https://eslint.org) configuration.**
+
+[![npm](https://img.shields.io/npm/v/@cargosense/eslint-config.svg?logo=npm&style=for-the-badge)](https://www.npmjs.com/package/@cargosense/eslint-config)
+[![Downloads](https://img.shields.io/npm/dt/@cargosense/eslint-config.svg?logo=npm&style=for-the-badge)](https://www.npmjs.com/package/@cargosense/eslint-config)
+[![Build](https://img.shields.io/github/actions/workflow/status/CargoSense/eslint-config/ci.yml?branch=main&logo=github&style=for-the-badge)](https://github.com/CargoSense/eslint-config/actions/workflows/ci.yml)
+
+## Installation
+
+```sh
+npm install --save-dev @cargosense/eslint-config
+```
+
+## Usage
+
+Using [ECMAScript module (ESM)](https://nodejs.org/api/esm.html) syntax:
+
+```js
+// eslint.config.js
+export { default } from "@cargosense/eslint-config";
+```
+
+You may also apply this shared configuration to your project's customized configuration:
+
+```js
+// eslint.config.js
+import config from "@cargosense/eslint-config";
+
+export default [
+  ...config,
+
+  {
+    "rules": {
+      // …
+    },
+  },
+];
+```
+
+> [!TIP]
+> ESLint is _extremely_ customizable. Refer to [the documentation](https://eslint.org/docs/latest/use/configure/configuration-files) for details.
+
+## License
+
+eslint-config is freely available under the [MIT License](https://opensource.org/licenses/MIT).

package/index.js

@@ -0,0 +1,224 @@
+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/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}
+   */
+  stylistic.configs["recommended-flat"],
+
+  /**
+   * @see {@link https://www.npmjs.com/package/eslint-plugin-array-func}
+   */
+  arrayFunc.configs.all,
+
+  /**
+   * @see {@link https://www.npmjs.com/package/eslint-plugin-jsdoc}
+   */
+  jsdoc.configs["flat/recommended"],
+
+  /**
+   * @see {@link https://www.npmjs.com/package/eslint-plugin-n}
+   */
+  n.configs["flat/recommended"],
+
+  /**
+   * @see {@link https://www.npmjs.com/package/eslint-plugin-regexp}
+   */
+  regexp.configs["flat/recommended"],
+
+  /**
+   * @see {@link https://www.npmjs.com/package/eslint-plugin-sort-class-members}
+   */
+  sortClassMembers.configs["flat/recommended"],
+
+  /**
+   * @see {@link https://www.npmjs.com/package/@cargosense/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",
+
+      /**
+       * Enforce 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 a consistent linebreak style for operators.
+       *
+       * @see {@link https://eslint.style/rules/default/operator-linebreak}
+       */
+      "@stylistic/operator-linebreak": ["error", "after"],
+
+      /**
+       * Disallow quotes around object literal property names that are not
+       * strictly required.
+       *
+       * @see {@link https://eslint.style/rules/default/quote-props}
+       */
+      "@stylistic/quote-props": ["error", "as-needed"],
+
+      /**
+       * Enforce the consistent use of either double quotes.
+       *
+       * @see {@link https://eslint.style/rules/default/quotes}
+       */
+      "@stylistic/quotes": ["error", "double", {
+        allowTemplateLiterals: true,
+        avoidEscape: false,
+      }],
+
+      /**
+       * Enforce consistent use of semicolons.
+       *
+       * @see {@link https://eslint.style/rules/default/semi}
+       */
+      "@stylistic/semi": ["error", "always"],
+
+      /**
+       * 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}
+       */
+      "jsdoc/sort-tags": ["warn", { alphabetizeExtras: true }],
+
+      /**
+       * Enforce 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 }],
+
+      /**
+       * Report unsupported Node.js built-in APIs on the configured Node.js
+       * version.
+       *
+       * @see {@link https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/no-unsupported-features/node-builtins.md}
+       */
+      "n/no-unsupported-features/node-builtins": ["error", { allowExperimental: true }],
+
+      /**
+       * Disallow unused variables (excluding variables whose name begins with
+       * an underscore).
+       *
+       * @see {@link https://eslint.org/docs/latest/rules/no-unused-vars}
+       */
+      "no-unused-vars": ["error", {
+        argsIgnorePattern: "^_",
+        destructuredArrayIgnorePattern: "^_",
+      }],
+
+      /**
+       * 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

@@ -0,0 +1,54 @@
+{
+  "name" :"@cargosense/eslint-config",
+  "version": "0.1.0",
+  "description": "Shareable ESLint configuration.",
+  "keywords": [
+    "eslint-config",
+    "eslint",
+    "eslintconfig",
+    "javascript"
+  ],
+  "homepage": "https://github.com/CargoSense/eslint-config",
+  "bugs": "https://github.com/CargoSense/eslint-config/issues",
+  "license": "MIT",
+  "author": "CargoSense <npm@cargosense.com> (https://www.cargosense.com)",
+  "files": [
+    "index.js"
+  ],
+  "type": "module",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": "./index.js"
+  },
+  "repository": "github:CargoSense/eslint-config",
+  "scripts": {
+    "lint": "npx eslint",
+    "test": "NODE_V8_COVERAGE=coverage node --experimental-test-coverage --test"
+  },
+  "dependencies": {
+    "@eslint/js": "^9.3.0",
+    "@stylistic/eslint-plugin": "^2.1.0",
+    "eslint-plugin-array-func": "^5.0.1",
+    "eslint-plugin-jsdoc": "^48.2.6",
+    "eslint-plugin-n": "^17.7.0",
+    "eslint-plugin-regexp": "^2.6.0",
+    "eslint-plugin-sort-class-members": "^1.20.0"
+  },
+  "devDependencies": {
+    "eslint": "^9.3.0"
+  },
+  "peerDependencies": {
+    "eslint": ">=9"
+  },
+  "overrides": {
+    "@typescript-eslint/utils": {
+      "eslint": ">=9"
+    }
+  },
+  "engines": {
+    "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}