eslint-config-jc 5.0.2 → 5.2.0

package/README.md

@@ -4,17 +4,45 @@ My personal coding style.
 
 This is designed to be a replacement for `eslint:recommended`, `plugin:react-hooks/recommended`, `plugin:@typescript-eslint/recommended`, and of course, everyone's favorite `airbnb`. It also extends `prettier`.
 
+## Installation
+
+```sh
+yarn add -D eslint-config-jc
+```
+
+No need to install any other plugins. You should probably also have the following dependencies:
+
+- `eslint`
+- `typescript-eslint` (for authoring the config)
+
 ## Configuration
 
-ESLint config:
+`eslint.config.mjs`:
 
-```json
-{
-  "root": true,
-  "extends": ["jc"]
-}
+```js
+import jcRules from "eslint-config-jc";
+import tseslint from "typescript-eslint";
+
+export default tseslint.config(
+  ...jcRules({
+    // options
+  }),
+  {
+    // Your overrides here
+  },
+);
 ```
 
+The `jcRules` function has the following options:
+
+- `react`: enable React and JSX rules (also loads browser globals)
+- `typescriptTypeCheck`: enabled type-checked rules
+- `node`: enable Node.js rules (also loads Node globals)
+- `reactClassComp`: enable rules for class components (you probably don't need this)
+- `reactPropTypes`: enable rules for prop types (you probably don't need this)
+
+Each option can be set to `true` to enable, or an array of paths used for the `files` ESLint option.
+
 ## Configuration philosophy
 
 When analyzing whether a rule should be `error`, `warn`, or `off`, the following assumptions are made:

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 import type { TSESLint } from "@typescript-eslint/utils";
 export default function configCreator({ react, typescriptTypeCheck, node, reactClassComp, reactPropTypes, }?: {
-    react?: boolean;
-    typescriptTypeCheck?: boolean;
-    node?: boolean;
-    reactClassComp?: boolean;
-    reactPropTypes?: boolean;
+    react?: boolean | TSESLint.FlatConfig.FileSpec[];
+    typescriptTypeCheck?: boolean | TSESLint.FlatConfig.FileSpec[];
+    node?: boolean | TSESLint.FlatConfig.FileSpec[];
+    reactClassComp?: boolean | TSESLint.FlatConfig.FileSpec[];
+    reactPropTypes?: boolean | TSESLint.FlatConfig.FileSpec[];
 }): TSESLint.FlatConfig.ConfigArray;

package/dist/index.js

@@ -11,6 +11,16 @@ import typescriptTypeCheckRules from "./typescript-typecheck.js";
 import nodeRules from "./node.js";
 import reactClassCompRules from "./react-class-comps.js";
 import reactPropTypesRules from "./react-prop-types.js";
+function expandConfig(config, enabled) {
+    if (enabled === true)
+        return config;
+    if (!enabled)
+        return [];
+    return config.map((v) => ({
+        files: enabled,
+        ...v,
+    }));
+}
 export default function configCreator({ react, typescriptTypeCheck, node, reactClassComp, reactPropTypes, } = {}) {
     return tseslint.config({
         linterOptions: {
@@ -20,5 +30,5 @@ export default function configCreator({ react, typescriptTypeCheck, node, reactC
             ecmaVersion: "latest",
             parser: tseslintParser,
         },
-    }, prettierRules, ...baseRules, ...regexRules, ...typescriptRules, ...importRules, ...(react ? reactRules : []), ...(react ? jsxRules : []), ...(typescriptTypeCheck ? typescriptTypeCheckRules : []), ...(node ? nodeRules : []), ...(reactClassComp ? reactClassCompRules : []), ...(reactPropTypes ? reactPropTypesRules : []));
+    }, prettierRules, ...baseRules, ...regexRules, ...typescriptRules, ...importRules, ...expandConfig([...reactRules, ...jsxRules], react), ...expandConfig(typescriptTypeCheckRules, typescriptTypeCheck), ...expandConfig(nodeRules, node), ...expandConfig(reactClassCompRules, reactClassComp), ...expandConfig(reactPropTypesRules, reactPropTypes));
 }

package/dist/jsx.js

@@ -224,7 +224,11 @@ export default tseslint.config({
             },
         ],
         "react/iframe-missing-sandbox": "error",
-        "react/jsx-boolean-value": ["error", "never"],
+        "react/jsx-boolean-value": [
+            "error",
+            "never",
+            { assumeUndefinedIsFalse: false },
+        ],
         "react/jsx-child-element-spacing": "warn",
         // Formatting
         "react/jsx-closing-bracket-location": "off",
@@ -305,7 +309,7 @@ export default tseslint.config({
         "react/no-unknown-property": [
             "error",
             {
-            // TODO: not released: requireDataLowercase: true,
+                requireDataLowercase: true,
             },
         ],
         "react/self-closing-comp": ["error", { component: true, html: true }],

package/dist/node.js

@@ -55,6 +55,7 @@ export default tseslint.config({
         "n/prefer-global/text-encoder": ["error", "always"],
         "n/prefer-global/url": ["error", "always"],
         "n/prefer-global/url-search-params": ["error", "always"],
+        "n/prefer-node-protocol": "error",
         "n/prefer-promises/dns": "error",
         "n/prefer-promises/fs": "error",
         "n/process-exit-as-throw": "warn",

package/dist/react.js

@@ -17,6 +17,10 @@ export default tseslint.config({
         "react-hooks/exhaustive-deps": "error",
         "react-hooks/rules-of-hooks": "error",
         "react/boolean-prop-naming": "off",
+        "react/checked-requires-onchange-or-readonly": ["error", {
+                ignoreExclusiveCheckedAttribute: false,
+                ignoreMissingProperties: false,
+            }],
         // Sometimes we do need `props` as a whole, e.g. for spreading
         "react/destructuring-assignment": "off",
         // Isn't useful

package/dist/regex.js

@@ -67,7 +67,12 @@ export default tseslint.config({
         ],
         "regexp/no-trivially-nested-assertion": "error",
         "regexp/no-trivially-nested-quantifier": "error",
-        "regexp/no-unused-capturing-group": "warn",
+        "regexp/no-unused-capturing-group": [
+            "warn",
+            {
+                allowNamed: false,
+            },
+        ],
         "regexp/no-useless-assertions": "error",
         "no-useless-backreference": "off",
         "regexp/no-useless-backreference": "error",
@@ -120,6 +125,18 @@ export default tseslint.config({
         "regexp/sort-flags": "error",
         "regexp/strict": "error",
         "regexp/unicode-escape": ["error", "unicodeEscape"],
+        "regexp/unicode-property": [
+            "error",
+            {
+                generalCategory: "never",
+                key: "short",
+                property: {
+                    binary: "long",
+                    generalCategory: "long",
+                    script: "long",
+                },
+            },
+        ],
         "regexp/use-ignore-case": "error",
     },
 });

package/dist/typescript-typecheck.js

@@ -3,6 +3,8 @@ export default tseslint.config({
     rules: {
         // https://jc-verse.github.io/js-style-guide/typescript/type-checked#await-thenable
         "@typescript-eslint/await-thenable": "error",
+        // Not worth turning on
+        "@typescript-eslint/consistent-return": "off",
         // Also enforced by --isolatedModules
         // https://jc-verse.github.io/js-style-guide/typescript/type-checked#consistent-type-exports
         "@typescript-eslint/consistent-type-exports": [
@@ -63,7 +65,10 @@ export default tseslint.config({
         "@typescript-eslint/prefer-reduce-type-parameter": "error",
         "@typescript-eslint/prefer-regexp-exec": "warn",
         "@typescript-eslint/prefer-return-this-type": "warn",
-        "@typescript-eslint/prefer-string-starts-ends-with": "warn",
+        "@typescript-eslint/prefer-string-starts-ends-with": [
+            "warn",
+            { allowSingleElementEquality: "never" },
+        ],
         // Not useful. Sometimes we intentionally make the function non-async.
         "@typescript-eslint/promise-function-async": "off",
         "@typescript-eslint/require-array-sort-compare": "error",
@@ -74,6 +79,7 @@ export default tseslint.config({
             "warn",
             {
                 allowAny: false,
+                allowArray: false,
                 allowBoolean: false,
                 allowNullish: false,
                 allowNumber: true,
@@ -85,5 +91,6 @@ export default tseslint.config({
         "@typescript-eslint/switch-exhaustiveness-check": "error",
         // Not very useful in practice... A lot of false-positives
         "@typescript-eslint/unbound-method": "off",
+        "@typescript-eslint/use-unknown-in-catch-callback-variables": "error",
     },
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-jc",
-  "version": "5.0.2",
+  "version": "5.2.0",
   "description": "Josh-Cena's personal coding style",
   "type": "module",
   "repository": {
@@ -36,18 +36,18 @@
     "prepublishOnly": "yarn build"
   },
   "dependencies": {
-    "@typescript-eslint/eslint-plugin": "^7.7.0",
-    "@typescript-eslint/parser": "^7.7.0",
+    "@typescript-eslint/eslint-plugin": "^7.8.0",
+    "@typescript-eslint/parser": "^7.8.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-header": "^3.1.1",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-jsx-a11y": "^6.8.0",
-    "eslint-plugin-n": "^17.2.1",
+    "eslint-plugin-n": "^17.4.0",
     "eslint-plugin-react": "^7.34.1",
-    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-react-hooks": "^4.6.2",
     "eslint-plugin-regexp": "^2.5.0",
     "globals": "^15.0.0",
-    "typescript-eslint": "^7.7.0"
+    "typescript-eslint": "^7.8.0"
   },
   "devDependencies": {
     "@types/eslint-config-prettier": "^6.11.3"

package/src/index.ts

@@ -15,6 +15,18 @@ import nodeRules from "./node.js";
 import reactClassCompRules from "./react-class-comps.js";
 import reactPropTypesRules from "./react-prop-types.js";
 
+function expandConfig(
+  config: TSESLint.FlatConfig.ConfigArray,
+  enabled: undefined | boolean | TSESLint.FlatConfig.FileSpec[],
+): TSESLint.FlatConfig.ConfigArray {
+  if (enabled === true) return config;
+  if (!enabled) return [];
+  return config.map((v) => ({
+    files: enabled,
+    ...v,
+  }));
+}
+
 export default function configCreator({
   react,
   typescriptTypeCheck,
@@ -22,11 +34,11 @@ export default function configCreator({
   reactClassComp,
   reactPropTypes,
 }: {
-  react?: boolean;
-  typescriptTypeCheck?: boolean;
-  node?: boolean;
-  reactClassComp?: boolean;
-  reactPropTypes?: boolean;
+  react?: boolean | TSESLint.FlatConfig.FileSpec[];
+  typescriptTypeCheck?: boolean | TSESLint.FlatConfig.FileSpec[];
+  node?: boolean | TSESLint.FlatConfig.FileSpec[];
+  reactClassComp?: boolean | TSESLint.FlatConfig.FileSpec[];
+  reactPropTypes?: boolean | TSESLint.FlatConfig.FileSpec[];
 } = {}): TSESLint.FlatConfig.ConfigArray {
   return tseslint.config(
     {
@@ -43,11 +55,10 @@ export default function configCreator({
     ...regexRules,
     ...typescriptRules,
     ...importRules,
-    ...(react ? reactRules : []),
-    ...(react ? jsxRules : []),
-    ...(typescriptTypeCheck ? typescriptTypeCheckRules : []),
-    ...(node ? nodeRules : []),
-    ...(reactClassComp ? reactClassCompRules : []),
-    ...(reactPropTypes ? reactPropTypesRules : []),
+    ...expandConfig([...reactRules, ...jsxRules], react),
+    ...expandConfig(typescriptTypeCheckRules, typescriptTypeCheck),
+    ...expandConfig(nodeRules, node),
+    ...expandConfig(reactClassCompRules, reactClassComp),
+    ...expandConfig(reactPropTypesRules, reactPropTypes),
   );
 }

package/src/jsx.ts

@@ -264,7 +264,11 @@ export default tseslint.config({
 
     "react/iframe-missing-sandbox": "error",
 
-    "react/jsx-boolean-value": ["error", "never"],
+    "react/jsx-boolean-value": [
+      "error",
+      "never",
+      { assumeUndefinedIsFalse: false },
+    ],
 
     "react/jsx-child-element-spacing": "warn",
 
@@ -381,7 +385,7 @@ export default tseslint.config({
     "react/no-unknown-property": [
       "error",
       {
-        // TODO: not released: requireDataLowercase: true,
+        requireDataLowercase: true,
       },
     ],
 

package/src/node.ts

@@ -87,6 +87,8 @@ export default tseslint.config({
 
     "n/prefer-global/url-search-params": ["error", "always"],
 
+    "n/prefer-node-protocol": "error",
+
     "n/prefer-promises/dns": "error",
 
     "n/prefer-promises/fs": "error",

package/src/react.ts

@@ -21,6 +21,11 @@ export default tseslint.config({
 
     "react/boolean-prop-naming": "off",
 
+    "react/checked-requires-onchange-or-readonly": ["error", {
+      ignoreExclusiveCheckedAttribute: false,
+      ignoreMissingProperties: false,
+    }],
+
     // Sometimes we do need `props` as a whole, e.g. for spreading
     "react/destructuring-assignment": "off",
 

package/src/regex.ts

@@ -30,7 +30,6 @@ export default tseslint.config({
 
     "regexp/no-contradiction-with-assertion": "error",
 
-     
     "no-control-regex": "off",
     "regexp/no-control-character": "error",
 
@@ -49,7 +48,6 @@ export default tseslint.config({
 
     "regexp/no-empty-capturing-group": "error",
 
-     
     "no-empty-character-class": "off",
     "regexp/no-empty-character-class": "error",
 
@@ -63,7 +61,6 @@ export default tseslint.config({
 
     "regexp/no-extra-lookaround-assertions": "error",
 
-     
     "no-invalid-regexp": "off",
     "regexp/no-invalid-regexp": "error",
 
@@ -78,7 +75,6 @@ export default tseslint.config({
       { reportBacktrackingEnds: true },
     ],
 
-     
     "no-misleading-character-class": "off",
     "regexp/no-misleading-unicode-character": ["error", { fixable: false }],
 
@@ -108,11 +104,15 @@ export default tseslint.config({
 
     "regexp/no-trivially-nested-quantifier": "error",
 
-    "regexp/no-unused-capturing-group": "warn",
+    "regexp/no-unused-capturing-group": [
+      "warn",
+      {
+        allowNamed: false,
+      },
+    ],
 
     "regexp/no-useless-assertions": "error",
 
-     
     "no-useless-backreference": "off",
     "regexp/no-useless-backreference": "error",
 
@@ -157,7 +157,6 @@ export default tseslint.config({
 
     "regexp/prefer-named-backreference": "error",
 
-     
     "prefer-named-capture-group": "off",
     "regexp/prefer-named-capture-group": "warn",
 
@@ -190,7 +189,7 @@ export default tseslint.config({
     "regexp/prefer-w": "error",
 
     "require-unicode-regexp": "off",
-     
+
     "regexp/require-unicode-regexp": "error",
 
     // Maybe in the future?
@@ -208,6 +207,19 @@ export default tseslint.config({
 
     "regexp/unicode-escape": ["error", "unicodeEscape"],
 
+    "regexp/unicode-property": [
+      "error",
+      {
+        generalCategory: "never",
+        key: "short",
+        property: {
+          binary: "long",
+          generalCategory: "long",
+          script: "long",
+        },
+      },
+    ],
+
     "regexp/use-ignore-case": "error",
   },
 });

package/src/typescript-typecheck.ts

@@ -5,6 +5,9 @@ export default tseslint.config({
     // https://jc-verse.github.io/js-style-guide/typescript/type-checked#await-thenable
     "@typescript-eslint/await-thenable": "error",
 
+    // Not worth turning on
+    "@typescript-eslint/consistent-return": "off",
+
     // Also enforced by --isolatedModules
     // https://jc-verse.github.io/js-style-guide/typescript/type-checked#consistent-type-exports
     "@typescript-eslint/consistent-type-exports": [
@@ -93,7 +96,10 @@ export default tseslint.config({
 
     "@typescript-eslint/prefer-return-this-type": "warn",
 
-    "@typescript-eslint/prefer-string-starts-ends-with": "warn",
+    "@typescript-eslint/prefer-string-starts-ends-with": [
+      "warn",
+      { allowSingleElementEquality: "never" },
+    ],
 
     // Not useful. Sometimes we intentionally make the function non-async.
     "@typescript-eslint/promise-function-async": "off",
@@ -108,6 +114,7 @@ export default tseslint.config({
       "warn",
       {
         allowAny: false,
+        allowArray: false,
         allowBoolean: false,
         allowNullish: false,
         allowNumber: true,
@@ -122,5 +129,7 @@ export default tseslint.config({
 
     // Not very useful in practice... A lot of false-positives
     "@typescript-eslint/unbound-method": "off",
+
+    "@typescript-eslint/use-unknown-in-catch-callback-variables": "error",
   },
 });