@clipboard-health/eslint-config 0.0.0

package/README.md

@@ -0,0 +1,42 @@
+# @clipboard-health/eslint-config
+
+Shared [ESLint](https://eslint.org/) configuration.
+
+## Table of Contents
+
+- [Install](#install)
+- [Local development commands](#local-development-commands)
+
+## Install
+
+```bash
+npm install -D @clipboard-health/eslint-config eslint-config-prettier prettier
+```
+
+Then, modify your `.eslintrc.js` file:
+
+```js
+module.exports = {
+  extends: ["@clipboard-health", "prettier"],
+  overrides: [
+    {
+      files: ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      parserOptions: {
+        project: "tsconfig.lint.json",
+        tsconfigRootDir: __dirname,
+      },
+    },
+    {
+      files: ["*.spec.ts", "*.spec.tsx", "*.spec.js", "*.spec.jsx"],
+      env: {
+        jest: true,
+      },
+    },
+  ],
+  root: true,
+};
+```
+
+## Local development commands
+
+See [`package.json`](./package.json) `scripts` for a list of commands.

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@clipboard-health/eslint-config",
+  "description": "Clipboard Health's ESLint configuration.",
+  "version": "0.0.0",
+  "bugs": "https://github.com/clipboardhealth/core-utils/issues",
+  "keywords": [
+    "config",
+    "eslint"
+  ],
+  "license": "MIT",
+  "main": "./src/index.js",
+  "peerDependencies": {
+    "@typescript-eslint/eslint-plugin": "^7",
+    "@typescript-eslint/parser": "^7",
+    "eslint": "^8",
+    "eslint-config-airbnb-base": "^15",
+    "eslint-config-prettier": "^9",
+    "eslint-config-xo": "^0.45",
+    "eslint-config-xo-react": "^0.27",
+    "eslint-config-xo-typescript": "^1",
+    "eslint-plugin-eslint-comments": "^3",
+    "eslint-plugin-import": "^2",
+    "eslint-plugin-jest": "^27.7",
+    "eslint-plugin-n": "^16",
+    "eslint-plugin-no-only-tests": "^3",
+    "eslint-plugin-no-use-extend-native": "^0.5",
+    "eslint-plugin-react": "^7",
+    "eslint-plugin-security": "^1",
+    "eslint-plugin-simple-import-sort": "^10",
+    "eslint-plugin-sonarjs": "^0.23",
+    "eslint-plugin-unicorn": "^48"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/clipboardhealth/core-utils.git",
+    "directory": "packages/nx-plugin"
+  },
+  "type": "commonjs",
+  "typings": "./src/index.d.ts",
+  "types": "./src/index.d.ts"
+}

package/src/index.d.ts

@@ -0,0 +1,92 @@
+declare let _extends: string[];
+export { _extends as extends };
+export declare let parser: string;
+export declare namespace parserOptions {
+    let project: string[];
+    let tsconfigRootDir: string;
+}
+export declare let plugins: string[];
+export declare let rules: {
+    /**
+     * Disable the capitalization of comments
+     * It makes code "not build" when just commented temporarily, which we've
+     * found to add more friction than the value from having consistent capitalization.
+     */
+    "capitalized-comments": string;
+    "@typescript-eslint/consistent-type-definitions": string[];
+    "@typescript-eslint/naming-convention": string;
+    "security/detect-object-injection": string;
+    "@typescript-eslint/no-unused-vars": (string | {
+        argsIgnorePattern: string;
+    })[];
+    "no-return-await": string;
+    "@typescript-eslint/return-await": string[];
+    curly: string[];
+    "class-methods-use-this": string;
+    "import/extensions": string;
+    "n/no-missing-import": string;
+    "n/no-unpublished-import": string;
+    "unicorn/prefer-module": string;
+    "import/no-extraneous-dependencies": string;
+    "import/no-unresolved": string;
+    "import/prefer-default-export": string;
+    "new-cap": (string | {
+        newIsCap: boolean;
+        capIsNew: boolean;
+    })[];
+    "import/no-cycle": (string | {
+        ignoreExternal: boolean;
+        maxDepth: number;
+    })[];
+    "no-only-tests/no-only-tests": string;
+    "no-restricted-syntax": (string | {
+        selector: string;
+        message: string;
+    })[];
+    "no-shadow": string;
+    "object-shorthand": string[];
+    "simple-import-sort/imports": string;
+    "simple-import-sort/exports": string;
+    "unicorn/no-array-for-each": string;
+    "unicorn/no-array-reduce": string;
+    "unicorn/prevent-abbreviations": (string | {
+        ignore: RegExp[];
+    })[];
+    "no-underscore-dangle": string;
+    "no-use-before-define": (string | {
+        functions: boolean;
+        classes: boolean;
+    })[];
+    "no-restricted-imports": (string | {
+        paths: {
+            name: string;
+            importNames: string[];
+            message: string;
+        }[];
+    })[];
+};
+export declare let overrides: ({
+    files: string[];
+    rules: {
+        "@typescript-eslint/no-unsafe-assignment": string;
+        "sonarjs/no-duplicate-string": string;
+        "@typescript-eslint/ban-types"?: never;
+    };
+} | {
+    files: string[];
+    rules: {
+        "@typescript-eslint/ban-types": (string | {
+            extendDefaults: boolean;
+            types: {
+                null: boolean;
+            };
+        })[];
+        "@typescript-eslint/no-unsafe-assignment"?: never;
+        "sonarjs/no-duplicate-string"?: never;
+    };
+})[];
+export declare namespace settings {
+    namespace node {
+        let version: string;
+    }
+}

package/src/index.js

@@ -0,0 +1,161 @@
+"use strict";
+module.exports = {
+    extends: [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/eslint-recommended",
+        "plugin:@typescript-eslint/recommended",
+        "airbnb-base",
+        "plugin:eslint-comments/recommended",
+        "plugin:jest/recommended",
+        "plugin:jest/style",
+        "plugin:import/recommended",
+        "plugin:n/recommended",
+        "plugin:no-use-extend-native/recommended",
+        "plugin:security/recommended",
+        "plugin:sonarjs/recommended",
+        "plugin:unicorn/recommended",
+        "xo",
+        "xo-typescript/space",
+        "prettier",
+    ],
+    parser: "@typescript-eslint/parser",
+    parserOptions: {
+        project: ["tsconfig.json"],
+        tsconfigRootDir: __dirname,
+    },
+    plugins: ["jest", "no-only-tests", "simple-import-sort", "sonarjs", "@typescript-eslint"],
+    rules: {
+        /**
+         * Disable the capitalization of comments
+         * It makes code "not build" when just commented temporarily, which we've
+         * found to add more friction than the value from having consistent capitalization.
+         */
+        "capitalized-comments": "off",
+        // See https://github.com/microsoft/TypeScript/wiki/Performance#preferring-interfaces-over-intersections
+        "@typescript-eslint/consistent-type-definitions": ["error", "interface"],
+        // Too many false positives
+        "@typescript-eslint/naming-convention": "off",
+        "security/detect-object-injection": "off",
+        // Prefer an escape hatch instead of an outright ban
+        "@typescript-eslint/no-unused-vars": ["warn", { argsIgnorePattern: "^_" }],
+        // Prefer debugging ease over an extra microtask by requiring `return await`.
+        // `no-return-await` states "This can make debugging more difficult."
+        "no-return-await": "off",
+        "@typescript-eslint/return-await": ["error", "always"],
+        // Prevent bugs
+        curly: ["error", "all"],
+        // Recommends using static fields instead of moving to a function
+        "class-methods-use-this": "off",
+        // Our libraries don't use ESM
+        "import/extensions": "off",
+        "n/no-missing-import": "off",
+        "n/no-unpublished-import": "off",
+        "unicorn/prefer-module": "off",
+        // Rely on `"n/no-extraneous-import"` instead
+        "import/no-extraneous-dependencies": "off",
+        // Doesn't play well with NX/monorepos
+        "import/no-unresolved": "off",
+        // Prefer named exports
+        "import/prefer-default-export": "off",
+        // Allow PascalCase for Decorators
+        "new-cap": ["warn", { newIsCap: true, capIsNew: false }],
+        "import/no-cycle": ["error", { ignoreExternal: true, maxDepth: 16 }],
+        /*
+         * Don't allow `.only` in tests to prevent it from making it
+         * into `main` and circumventing our tests.
+         */
+        "no-only-tests/no-only-tests": "error",
+        // Adapter from Airbnb's config, but allows ForOfStatement.
+        // See https://github.com/airbnb/javascript/blob/0f3ca32323b8d5770de3301036e65511c6d18e00/packages/eslint-config-airbnb-base/rules/style.js#L340-L358
+        "no-restricted-syntax": [
+            "error",
+            {
+                selector: "ForInStatement",
+                message: "for..in loops iterate over the entire prototype chain, which is virtually never what you want. Use Object.{keys,values,entries}, and iterate over the resulting array.",
+            },
+            {
+                selector: "LabeledStatement",
+                message: "Labels are a form of GOTO; using them makes code confusing and hard to maintain and understand.",
+            },
+            {
+                selector: "WithStatement",
+                message: "`with` is disallowed in strict mode because it makes code impossible to predict and optimize.",
+            },
+        ],
+        // False positive on `enum`s
+        "no-shadow": "off",
+        /*
+         * Only enable for properties. Favor arrow functions, they don’t have a `this` reference,
+         * preventing accidental usage.
+         */
+        "object-shorthand": ["error", "properties"],
+        // Sort imports and exports
+        "simple-import-sort/imports": "warn",
+        "simple-import-sort/exports": "warn",
+        // "Better readability" is subjective
+        "unicorn/no-array-for-each": "off",
+        "unicorn/no-array-reduce": "off",
+        // Allow common, well understood abbreviations
+        "unicorn/prevent-abbreviations": [
+            "error",
+            { ignore: [/config/i, /params/i, /props/i, /ref/i] },
+        ],
+        // Polarizing naming convention that isn't followed by us
+        "no-underscore-dangle": "off",
+        // We use TypeScript where these are caught by the compiler
+        "no-use-before-define": ["error", { functions: false, classes: false }],
+        "no-restricted-imports": [
+            "error",
+            {
+                paths: [
+                    // We want `ObjectId` to be imported from `mongoose` only
+                    {
+                        name: "mongodb",
+                        importNames: ["ObjectId", "ObjectID"],
+                        message: 'Importing `ObjectId` from `mongodb` is not allowed. Use `import { Types } from "mongoose"` and then `Types.ObjectId` instead.',
+                    },
+                ],
+            },
+        ],
+    },
+    overrides: [
+        {
+            files: [
+                "*.spec.ts",
+                "*.spec.tsx",
+                "*.spec.js",
+                "*.spec.jsx",
+                "*.test.ts",
+                "*.test.tsx",
+                "*.test.js",
+                "*.test.jsx",
+            ],
+            rules: {
+                // Interferes with `jest`'s `expect.any`
+                "@typescript-eslint/no-unsafe-assignment": "off",
+                // Duplication allows verbose test case setups and asserts
+                "sonarjs/no-duplicate-string": "off",
+            },
+        },
+        /**
+         * Exclude *.dto.ts, null is needed for PATCH endpoints to differentiate empty from optional fields
+         * Exclude *.repository.ts, null is needed for our ORMs (prisma and mongoose)
+         */
+        {
+            files: ["**/*.dto.ts", "**/*.repository.ts"],
+            rules: {
+                "@typescript-eslint/ban-types": [
+                    "error",
+                    {
+                        extendDefaults: true,
+                        types: {
+                            null: false,
+                        },
+                    },
+                ],
+            },
+        },
+    ],
+    settings: { node: { version: ">=18.15.0" } },
+};
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/eslint-config/src/index.js"],"names":[],"mappings":";AAAA,MAAM,CAAC,OAAO,GAAG;IACf,OAAO,EAAE;QACP,oBAAoB;QACpB,8CAA8C;QAC9C,uCAAuC;QACvC,aAAa;QACb,oCAAoC;QACpC,yBAAyB;QACzB,mBAAmB;QACnB,2BAA2B;QAC3B,sBAAsB;QACtB,yCAAyC;QACzC,6BAA6B;QAC7B,4BAA4B;QAC5B,4BAA4B;QAC5B,IAAI;QACJ,qBAAqB;QACrB,UAAU;KACX;IACD,MAAM,EAAE,2BAA2B;IACnC,aAAa,EAAE;QACb,OAAO,EAAE,CAAC,eAAe,CAAC;QAC1B,eAAe,EAAE,SAAS;KAC3B;IACD,OAAO,EAAE,CAAC,MAAM,EAAE,eAAe,EAAE,oBAAoB,EAAE,SAAS,EAAE,oBAAoB,CAAC;IACzF,KAAK,EAAE;QACL;;;;WAIG;QACH,sBAAsB,EAAE,KAAK;QAE7B,wGAAwG;QACxG,gDAAgD,EAAE,CAAC,OAAO,EAAE,WAAW,CAAC;QAExE,2BAA2B;QAC3B,sCAAsC,EAAE,KAAK;QAC7C,kCAAkC,EAAE,KAAK;QAEzC,oDAAoD;QACpD,mCAAmC,EAAE,CAAC,MAAM,EAAE,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC;QAE1E,6EAA6E;QAC7E,qEAAqE;QACrE,iBAAiB,EAAE,KAAK;QACxB,iCAAiC,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;QAEtD,eAAe;QACf,KAAK,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC;QAEvB,iEAAiE;QACjE,wBAAwB,EAAE,KAAK;QAE/B,8BAA8B;QAC9B,mBAAmB,EAAE,KAAK;QAC1B,qBAAqB,EAAE,KAAK;QAC5B,yBAAyB,EAAE,KAAK;QAChC,uBAAuB,EAAE,KAAK;QAE9B,6CAA6C;QAC7C,mCAAmC,EAAE,KAAK;QAE1C,sCAAsC;QACtC,sBAAsB,EAAE,KAAK;QAE7B,uBAAuB;QACvB,8BAA8B,EAAE,KAAK;QAErC,kCAAkC;QAClC,SAAS,EAAE,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;QAExD,iBAAiB,EAAE,CAAC,OAAO,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;QACpE;;;WAGG;QACH,6BAA6B,EAAE,OAAO;QAEtC,2DAA2D;QAC3D,qJAAqJ;QACrJ,sBAAsB,EAAE;YACtB,OAAO;YACP;gBACE,QAAQ,EAAE,gBAAgB;gBAC1B,OAAO,EACL,wKAAwK;aAC3K;YACD;gBACE,QAAQ,EAAE,kBAAkB;gBAC5B,OAAO,EACL,iGAAiG;aACpG;YACD;gBACE,QAAQ,EAAE,eAAe;gBACzB,OAAO,EACL,+FAA+F;aAClG;SACF;QAED,4BAA4B;QAC5B,WAAW,EAAE,KAAK;QAElB;;;WAGG;QACH,kBAAkB,EAAE,CAAC,OAAO,EAAE,YAAY,CAAC;QAE3C,2BAA2B;QAC3B,4BAA4B,EAAE,MAAM;QACpC,4BAA4B,EAAE,MAAM;QAEpC,qCAAqC;QACrC,2BAA2B,EAAE,KAAK;QAClC,yBAAyB,EAAE,KAAK;QAEhC,8CAA8C;QAC9C,+BAA+B,EAAE;YAC/B,OAAO;YACP,EAAE,MAAM,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE;SACrD;QAED,yDAAyD;QACzD,sBAAsB,EAAE,KAAK;QAE7B,2DAA2D;QAC3D,sBAAsB,EAAE,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;QAEvE,uBAAuB,EAAE;YACvB,OAAO;YACP;gBACE,KAAK,EAAE;oBACL,yDAAyD;oBACzD;wBACE,IAAI,EAAE,SAAS;wBACf,WAAW,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC;wBACrC,OAAO,EACL,+HAA+H;qBAClI;iBACF;aACF;SACF;KACF;IACD,SAAS,EAAE;QACT;YACE,KAAK,EAAE;gBACL,WAAW;gBACX,YAAY;gBACZ,WAAW;gBACX,YAAY;gBACZ,WAAW;gBACX,YAAY;gBACZ,WAAW;gBACX,YAAY;aACb;YACD,KAAK,EAAE;gBACL,wCAAwC;gBACxC,yCAAyC,EAAE,KAAK;gBAEhD,0DAA0D;gBAC1D,6BAA6B,EAAE,KAAK;aACrC;SACF;QACD;;;WAGG;QACH;YACE,KAAK,EAAE,CAAC,aAAa,EAAE,oBAAoB,CAAC;YAC5C,KAAK,EAAE;gBACL,8BAA8B,EAAE;oBAC9B,OAAO;oBACP;wBACE,cAAc,EAAE,IAAI;wBACpB,KAAK,EAAE;4BACL,IAAI,EAAE,KAAK;yBACZ;qBACF;iBACF;aACF;SACF;KACF;IACD,QAAQ,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE;CAC7C,CAAC"}

package/src/react.d.ts

@@ -0,0 +1,6 @@
+declare let _extends: string[];
+export { _extends as extends };
+export declare namespace parserOptions {
+    let project: string[];
+    let tsconfigRootDir: string;
+}

package/src/react.js

@@ -0,0 +1,9 @@
+"use strict";
+module.exports = {
+    extends: ["./index", "xo-react/space"],
+    parserOptions: {
+        project: ["tsconfig.json"],
+        tsconfigRootDir: __dirname,
+    },
+};
+//# sourceMappingURL=react.js.map

package/src/react.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"react.js","sourceRoot":"","sources":["../../../../packages/eslint-config/src/react.js"],"names":[],"mappings":";AAAA,MAAM,CAAC,OAAO,GAAG;IACf,OAAO,EAAE,CAAC,SAAS,EAAE,gBAAgB,CAAC;IACtC,aAAa,EAAE;QACb,OAAO,EAAE,CAAC,eAAe,CAAC;QAC1B,eAAe,EAAE,SAAS;KAC3B;CACF,CAAC"}