eslint-config-jc 4.3.0 → 5.0.0

package/README.md

@@ -4,27 +4,6 @@ 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`.
 
-## Dependencies
-
-It requires the following plugins:
-
-```json
-{
-  "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.10.2",
-    "@typescript-eslint/parser": "^5.10.2",
-    "eslint": "^8.8.0",
-    "eslint-plugin-header": "^3.1.1",
-    "eslint-plugin-import": "^2.25.3",
-    "eslint-plugin-jsx-a11y": "^6.5.1",
-    "eslint-plugin-react": "^7.27.0",
-    "eslint-plugin-react-hooks": "^4.3.0"
-  }
-}
-```
-
-Although peer dependencies are evil, we can't self-install these plugins if the downstream user depends on a different version—the wrong one will be resolved.
-
 ## Configuration
 
 ESLint config:

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "eslint-config-jc",
-  "version": "4.3.0",
+  "version": "5.0.0",
   "description": "Josh-Cena's personal coding style",
-  "main": "index.js",
+  "type": "module",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/jc-verse/js-style-guide.git",
@@ -23,48 +23,27 @@
   },
   "homepage": "https://jc-verse.github.io/js-style-guide/",
   "exports": {
-    ".": "./index.js",
-    "./base": "./rules/base.js",
-    "./regex": "./rules/regex.js",
-    "./import": "./rules/import.js",
-    "./node": "./rules/node.js",
-    "./jsx": "./rules/jsx.js",
-    "./react": "./rules/react.js",
-    "./react-class-comps": "./rules/react-class-comps.js",
-    "./react-prop-types": "./rules/react-prop-types.js",
-    "./typescript": "./rules/typescript.js",
-    "./typescript-typecheck": "./rules/typescript-typecheck.js"
+    ".": "./dist/index.js"
   },
-  "dependencies": {
-    "eslint-config-prettier": "^9.1.0"
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "yarn build"
   },
-  "peerDependencies": {
-    "@typescript-eslint/eslint-plugin": "^7.0.1",
-    "@typescript-eslint/parser": "^7.0.1",
-    "eslint": "^8.56.0",
+  "dependencies": {
+    "@typescript-eslint/eslint-plugin": "^7.7.0",
+    "@typescript-eslint/parser": "^7.7.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": "^16.6.2",
-    "eslint-plugin-react": "^7.33.2",
+    "eslint-plugin-n": "^17.2.1",
+    "eslint-plugin-react": "^7.34.1",
     "eslint-plugin-react-hooks": "^4.6.0",
-    "eslint-plugin-regexp": "^2.2.0"
+    "eslint-plugin-regexp": "^2.5.0",
+    "globals": "^15.0.0",
+    "typescript-eslint": "^7.7.0"
   },
-  "peerDependenciesMeta": {
-    "eslint-plugin-header": {
-      "optional": true
-    },
-    "eslint-plugin-jsx-a11y": {
-      "optional": true
-    },
-    "eslint-plugin-n": {
-      "optional": true
-    },
-    "eslint-plugin-react": {
-      "optional": true
-    },
-    "eslint-plugin-react-hooks": {
-      "optional": true
-    }
+  "devDependencies": {
+    "@types/eslint-config-prettier": "^6.11.3"
   }
 }

package/{rules/base.js → src/base.ts}

@@ -1,11 +1,6 @@
-module.exports = {
-  env: {
-    browser: true,
-    commonjs: true,
-    es6: true,
-    node: true,
-  },
-  reportUnusedDisableDirectives: true,
+import tseslint from "typescript-eslint";
+
+export default tseslint.config({
   rules: {
     // https://jc-verse.github.io/js-style-guide/eslint-base/objects-classes#accessor-pairs
     "accessor-pairs": [
@@ -908,4 +903,4 @@ module.exports = {
     // https://jc-verse.github.io/js-style-guide/eslint-base/operatorss#yoda
     yoda: ["error", "never", { exceptRange: true }],
   },
-};
+});

package/{rules/import.js → src/import.ts}

@@ -1,5 +1,10 @@
-module.exports = {
-  plugins: ["import"],
+import importPlugin from "eslint-plugin-import";
+import tseslint from "typescript-eslint";
+
+export default tseslint.config({
+  plugins: {
+    import: importPlugin,
+  },
   rules: {
     // We use @typescript-eslint/no-import-type-side-effects
     "import/consistent-type-specifier-style": "off",
@@ -131,4 +136,4 @@ module.exports = {
       },
     },
   },
-};
+});

package/src/index.ts

@@ -0,0 +1,53 @@
+import tseslint from "typescript-eslint";
+import tseslintParser from "@typescript-eslint/parser";
+import type { TSESLint } from "@typescript-eslint/utils";
+import prettierRules from "eslint-config-prettier";
+
+import baseRules from "./base.js";
+import regexRules from "./regex.js";
+import typescriptRules from "./typescript.js";
+import importRules from "./import.js";
+import reactRules from "./react.js";
+import jsxRules from "./jsx.js";
+
+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";
+
+export default function configCreator({
+  react,
+  typescriptTypeCheck,
+  node,
+  reactClassComp,
+  reactPropTypes,
+}: {
+  react?: boolean;
+  typescriptTypeCheck?: boolean;
+  node?: boolean;
+  reactClassComp?: boolean;
+  reactPropTypes?: boolean;
+} = {}): TSESLint.FlatConfig.ConfigArray {
+  return tseslint.config(
+    {
+      linterOptions: {
+        reportUnusedDisableDirectives: true,
+      },
+      languageOptions: {
+        ecmaVersion: "latest",
+        parser: tseslintParser,
+      },
+    },
+    prettierRules,
+    ...baseRules,
+    ...regexRules,
+    ...typescriptRules,
+    ...importRules,
+    ...(react ? reactRules : []),
+    ...(react ? jsxRules : []),
+    ...(typescriptTypeCheck ? typescriptTypeCheckRules : []),
+    ...(node ? nodeRules : []),
+    ...(reactClassComp ? reactClassCompRules : []),
+    ...(reactPropTypes ? reactPropTypesRules : []),
+  );
+}

package/{rules/jsx.js → src/jsx.ts}

@@ -1,5 +1,12 @@
-module.exports = {
-  plugins: ["jsx-a11y", "react"],
+import jsxA11yPlugin from "eslint-plugin-jsx-a11y";
+import reactPlugin from "eslint-plugin-react";
+import tseslint from "typescript-eslint";
+
+export default tseslint.config({
+  plugins: {
+    "jsx-a11y": jsxA11yPlugin,
+    react: reactPlugin,
+  },
   rules: {
     // JSX a11y rules are taken from airbnb, not adjusted yet
     "jsx-a11y/alt-text": [
@@ -382,4 +389,4 @@ module.exports = {
 
     "react/void-dom-elements-no-children": "error",
   },
-};
+});

package/{rules/node.js → src/node.ts}

@@ -1,5 +1,17 @@
-module.exports = {
-  plugins: ["n"],
+import nPlugin from "eslint-plugin-n";
+import tseslint from "typescript-eslint";
+import globals from "globals";
+
+export default tseslint.config({
+  languageOptions: {
+    globals: {
+      ...globals.node,
+      ...globals.nodeBuiltin,
+    },
+  },
+  plugins: {
+    n: nPlugin,
+  },
   rules: {
     // Callback-related
     "n/callback-return": "off",
@@ -15,6 +27,9 @@ module.exports = {
     // Callback-related
     "n/handle-callback-err": "off",
 
+    // Errors on TypeScript bin
+    "n/hashbang": "off",
+
     // Callback-related
     "n/no-callback-literal": "off",
 
@@ -77,8 +92,5 @@ module.exports = {
     "n/prefer-promises/fs": "error",
 
     "n/process-exit-as-throw": "warn",
-
-    // Errors on TypeScript bin
-    "n/shebang": "off",
   },
-};
+});

package/src/plugins.d.ts

@@ -0,0 +1,4 @@
+declare module "eslint-plugin-import";
+declare module "eslint-plugin-jsx-a11y";
+declare module "eslint-plugin-react";
+declare module "eslint-plugin-react-hooks";

package/{rules/react-class-comps.js → src/react-class-comps.ts}

@@ -1,4 +1,6 @@
-module.exports = {
+import tseslint from "typescript-eslint";
+
+export default tseslint.config({
   rules: {
     "react/no-access-state-in-setstate": "error",
 
@@ -38,4 +40,4 @@ module.exports = {
 
     "react/static-property-placement": ["error", "static public field"],
   },
-};
+});

package/{rules/react-prop-types.js → src/react-prop-types.ts}

@@ -1,4 +1,6 @@
-module.exports = {
+import tseslint from "typescript-eslint";
+
+export default tseslint.config({
   rules: {
     "react/default-props-match-prop-types": "off",
 
@@ -18,4 +20,4 @@ module.exports = {
 
     "react/sort-prop-types": "off",
   },
-};
+});

package/{rules/react.js → src/react.ts}

@@ -1,10 +1,19 @@
-module.exports = {
-  parserOptions: {
-    ecmaFeatures: {
-      jsx: true,
+import reactPlugin from "eslint-plugin-react";
+import reactHooksPlugin from "eslint-plugin-react-hooks";
+import tseslint from "typescript-eslint";
+import globals from "globals";
+
+export default tseslint.config({
+  languageOptions: {
+    globals: {
+      ...globals.browser,
+      ...globals.node,
     },
   },
-  plugins: ["react", "react-hooks"],
+  plugins: {
+    react: reactPlugin,
+    "react-hooks": reactHooksPlugin,
+  },
   rules: {
     "react-hooks/exhaustive-deps": "error",
 
@@ -116,4 +125,4 @@ module.exports = {
       version: "18",
     },
   },
-};
+});

package/{rules/regex.js → src/regex.ts}

@@ -1,5 +1,10 @@
-module.exports = {
-  plugins: ["regexp"],
+import regexPlugin from "eslint-plugin-regexp";
+import tseslint from "typescript-eslint";
+
+export default tseslint.config({
+  plugins: {
+    regexp: regexPlugin,
+  },
   rules: {
     "regexp/confusing-quantifier": "error",
 
@@ -25,7 +30,7 @@ module.exports = {
 
     "regexp/no-contradiction-with-assertion": "error",
 
-    // eslint-disable-next-line sort-keys
+     
     "no-control-regex": "off",
     "regexp/no-control-character": "error",
 
@@ -44,7 +49,7 @@ module.exports = {
 
     "regexp/no-empty-capturing-group": "error",
 
-    // eslint-disable-next-line sort-keys
+     
     "no-empty-character-class": "off",
     "regexp/no-empty-character-class": "error",
 
@@ -58,7 +63,7 @@ module.exports = {
 
     "regexp/no-extra-lookaround-assertions": "error",
 
-    // eslint-disable-next-line sort-keys
+     
     "no-invalid-regexp": "off",
     "regexp/no-invalid-regexp": "error",
 
@@ -73,7 +78,7 @@ module.exports = {
       { reportBacktrackingEnds: true },
     ],
 
-    // eslint-disable-next-line sort-keys
+     
     "no-misleading-character-class": "off",
     "regexp/no-misleading-unicode-character": ["error", { fixable: false }],
 
@@ -107,7 +112,7 @@ module.exports = {
 
     "regexp/no-useless-assertions": "error",
 
-    // eslint-disable-next-line sort-keys
+     
     "no-useless-backreference": "off",
     "regexp/no-useless-backreference": "error",
 
@@ -152,7 +157,7 @@ module.exports = {
 
     "regexp/prefer-named-backreference": "error",
 
-    // eslint-disable-next-line sort-keys
+     
     "prefer-named-capture-group": "off",
     "regexp/prefer-named-capture-group": "warn",
 
@@ -185,7 +190,7 @@ module.exports = {
     "regexp/prefer-w": "error",
 
     "require-unicode-regexp": "off",
-    // eslint-disable-next-line sort-keys
+     
     "regexp/require-unicode-regexp": "error",
 
     // Maybe in the future?
@@ -205,4 +210,4 @@ module.exports = {
 
     "regexp/use-ignore-case": "error",
   },
-};
+});

package/{rules/typescript-typecheck.js → src/typescript-typecheck.ts}

@@ -1,4 +1,6 @@
-module.exports = {
+import tseslint from "typescript-eslint";
+
+export default tseslint.config({
   rules: {
     // https://jc-verse.github.io/js-style-guide/typescript/type-checked#await-thenable
     "@typescript-eslint/await-thenable": "error",
@@ -121,4 +123,4 @@ module.exports = {
     // Not very useful in practice... A lot of false-positives
     "@typescript-eslint/unbound-method": "off",
   },
-};
+});

package/src/typescript.ts

@@ -0,0 +1,360 @@
+import tseslintPlugin from "@typescript-eslint/eslint-plugin";
+import tseslint from "typescript-eslint";
+
+export default tseslint.config(
+  {
+    plugins: {
+      "@typescript-eslint": tseslintPlugin,
+    },
+    rules: {
+      // https://jc-verse.github.io/js-style-guide/typescript/base#adjacent-overload-signatures
+      "@typescript-eslint/adjacent-overload-signatures": "error",
+
+      // I wish this rule can be more flexible to allow T[] where T is a union
+      // https://jc-verse.github.io/js-style-guide/typescript/base#adjacent-overload-signatures
+      "@typescript-eslint/array-type": [
+        "error",
+        { default: "array", readonly: "array" },
+      ],
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#ban-ts-comment
+      "@typescript-eslint/ban-ts-comment": [
+        "error",
+        {
+          minimumDescriptionLength: 3,
+          "ts-check": false,
+          "ts-expect-error": "allow-with-description",
+          "ts-ignore": true,
+          "ts-nocheck": true,
+        },
+      ],
+
+      // We've never used TSLint anyway
+      // https://jc-verse.github.io/js-style-guide/typescript/base#ban-tslint-comment
+      "@typescript-eslint/ban-tslint-comment": "error",
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#ban-types
+      "@typescript-eslint/ban-types": [
+        "error",
+        {
+          extendDefaults: true,
+          types: {
+            "{}": false,
+          },
+        },
+      ],
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#class-literal-property-style
+      "@typescript-eslint/class-literal-property-style": ["warn", "getters"],
+
+      // We turn off the base rule too
+      "@typescript-eslint/class-methods-use-this": "off",
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#consistent-generic-constructors
+      "@typescript-eslint/consistent-generic-constructors": [
+        "error",
+        "constructor",
+      ],
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#consistent-indexed-object-style
+      "@typescript-eslint/consistent-indexed-object-style": [
+        "error",
+        "index-signature",
+      ],
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#consistent-type-assertions
+      "@typescript-eslint/consistent-type-assertions": [
+        "error",
+        { assertionStyle: "as", objectLiteralTypeAssertions: "allow" },
+      ],
+
+      // We sometimes allow declaration merging
+      // https://jc-verse.github.io/js-style-guide/typescript/base#consistent-type-definitions
+      "@typescript-eslint/consistent-type-definitions": "off",
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#consistent-type-imports
+      "@typescript-eslint/consistent-type-imports": [
+        "error",
+        {
+          disallowTypeAnnotations: false,
+          fixStyle: "inline-type-imports",
+          prefer: "type-imports",
+        },
+      ],
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#default-param-last
+      "@typescript-eslint/default-param-last": "error",
+
+      // No—too verbose
+      // https://jc-verse.github.io/js-style-guide/typescript/base#explicit-function-return-type
+      "@typescript-eslint/explicit-function-return-type": "off",
+
+      // Defaulting to public makes sense
+      // https://jc-verse.github.io/js-style-guide/typescript/base#explicit-member-accessibility
+      "@typescript-eslint/explicit-member-accessibility": "off",
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#explicit-module-boundary-types
+      "@typescript-eslint/explicit-module-boundary-types": "warn",
+
+      "init-declarations": "off",
+      // https://jc-verse.github.io/js-style-guide/typescript/base#init-declarations
+       
+      "@typescript-eslint/init-declarations": ["error", "always"],
+
+      // We turn off the base rule too
+      "@typescript-eslint/max-params": "off",
+
+      // TODO figure out how this should be configured
+      "@typescript-eslint/member-ordering": 0,
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#method-signature-style
+      "@typescript-eslint/method-signature-style": ["error", "property"],
+
+      // TODO
+      "@typescript-eslint/naming-convention": 0,
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#no-array-constructor
+      "@typescript-eslint/no-array-constructor": "off",
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#no-confusing-non-null-assertion
+      "@typescript-eslint/no-confusing-non-null-assertion": "error",
+
+      "no-dupe-class-members": "off",
+      // https://jc-verse.github.io/js-style-guide/typescript/base#no-dupe-class-members
+       
+      "@typescript-eslint/no-dupe-class-members": "error",
+
+      // This can be useful for dynamic object transformations
+      // https://jc-verse.github.io/js-style-guide/typescript/base#no-dynamic-delete
+      "@typescript-eslint/no-dynamic-delete": "off",
+
+      // We turn off the base rule too
+      "@typescript-eslint/no-empty-function": "off",
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#no-empty-interface
+      "@typescript-eslint/no-empty-interface": [
+        "error",
+        { allowSingleExtends: true },
+      ],
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#no-explicit-any
+      "@typescript-eslint/no-explicit-any": "warn",
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#no-extra-non-null-assertion
+      "@typescript-eslint/no-extra-non-null-assertion": "error",
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#no-extraneous-class
+      "@typescript-eslint/no-extraneous-class": [
+        "warn",
+        {
+          allowConstructorOnly: false,
+          allowEmpty: false,
+          allowStaticOnly: false,
+          allowWithDecorator: false,
+        },
+      ],
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#no-import-type-side-effects
+      "@typescript-eslint/no-import-type-side-effects": "error",
+
+      // Annotating parameters makes the code more uniform
+      "@typescript-eslint/no-inferrable-types": [
+        "error",
+        { ignoreParameters: true },
+      ],
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#no-invalid-this
+      "@typescript-eslint/no-invalid-this": "off",
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#no-invalid-void-type
+      "@typescript-eslint/no-invalid-void-type": [
+        "warn",
+        { allowAsThisParameter: false, allowInGenericTypeArguments: true },
+      ],
+
+      // We turn off the base rule too
+      "@typescript-eslint/no-loop-func": "off",
+
+      // To be deprecated
+      "@typescript-eslint/no-loss-of-precision": "off",
+
+      // We turn off the base rule too
+      "@typescript-eslint/no-magic-numbers": "off",
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#no-misused-new
+      "@typescript-eslint/no-misused-new": "error",
+
+      // Use namespaces to organize your code
+      // https://jc-verse.github.io/js-style-guide/typescript/base#no-namespace
+      "@typescript-eslint/no-namespace": "off",
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#no-non-null-asserted-nullish-coalescing
+      "@typescript-eslint/no-non-null-asserted-nullish-coalescing": "error",
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#no-non-null-asserted-optional-chain
+      "@typescript-eslint/no-non-null-asserted-optional-chain": "error",
+
+      // It's useful.
+      // https://jc-verse.github.io/js-style-guide/typescript/base#no-non-null-assertion
+      "@typescript-eslint/no-non-null-assertion": "off",
+
+      "no-redeclare": "off",
+      // https://jc-verse.github.io/js-style-guide/typescript/base#no-redeclare
+       
+      "@typescript-eslint/no-redeclare": [
+        "error",
+        {
+          builtinGlobals: true,
+          // We also allow redeclaring between variables and types although the
+          // rule doesn't allow that
+          ignoreDeclarationMerge: true,
+        },
+      ],
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#no-require-imports
+      "@typescript-eslint/no-require-imports": "error",
+
+      "no-shadow": "off",
+      // https://jc-verse.github.io/js-style-guide/typescript/base#no-shadow
+       
+      "@typescript-eslint/no-shadow": [
+        "warn",
+        {
+          allow: [],
+          builtinGlobals: false,
+          hoist: "all",
+          ignoreFunctionTypeParameterNameValueShadow: false,
+          ignoreOnInitialization: true,
+          ignoreTypeValueShadow: true,
+        },
+      ],
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#no-this-alias
+      "@typescript-eslint/no-this-alias": [
+        "warn",
+        { allowDestructuring: true, allowedNames: [] },
+      ],
+
+      // Deprecated
+      "@typescript-eslint/no-type-alias": "off",
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#no-unnecessary-type-constraint
+      "@typescript-eslint/no-unnecessary-type-constraint": "error",
+
+      "no-unused-expressions": "off",
+      // https://jc-verse.github.io/js-style-guide/typescript/base#no-unused-expressions
+       
+      "@typescript-eslint/no-unused-expressions": [
+        "error",
+        {
+          allowShortCircuit: true,
+          allowTaggedTemplates: true,
+          allowTernary: true,
+          enforceForJSX: true,
+        },
+      ],
+
+      "no-unused-vars": "off",
+      // https://jc-verse.github.io/js-style-guide/typescript/base#no-unused-vars
+       
+      "@typescript-eslint/no-unused-vars": [
+        "error",
+        {
+          args: "after-used",
+          caughtErrors: "all",
+          ignoreRestSiblings: true,
+          vars: "all",
+        },
+      ],
+
+      "no-use-before-define": "off",
+       
+      "@typescript-eslint/no-use-before-define": [
+        "error",
+        {
+          allowNamedExports: true,
+          classes: true,
+          enums: false,
+          functions: false,
+          ignoreTypeReferences: true,
+          typedefs: false,
+          variables: true,
+        },
+      ],
+
+      "no-useless-constructor": "off",
+       
+      "@typescript-eslint/no-useless-constructor": "error",
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#no-useless-empty-export
+      "@typescript-eslint/no-useless-empty-export": "error",
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#no-var-requires
+      "@typescript-eslint/no-var-requires": "error",
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#parameter-properties
+      "@typescript-eslint/parameter-properties": [
+        "warn",
+        { allow: [], prefer: "class-property" },
+      ],
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#prefer-as-const
+      "@typescript-eslint/prefer-as-const": "error",
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#prefer-enum-initializers
+      "@typescript-eslint/prefer-enum-initializers": "error",
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#prefer-for-of
+      "@typescript-eslint/prefer-for-of": "error",
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#prefer-function-type
+      "@typescript-eslint/prefer-function-type": "error",
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#prefer-literal-enum-member
+      "@typescript-eslint/prefer-literal-enum-member": [
+        "warn",
+        { allowBitwiseExpressions: true },
+      ],
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#prefer-namespace-keyword
+      "@typescript-eslint/prefer-namespace-keyword": "error",
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#prefer-ts-expect-error
+      "@typescript-eslint/prefer-ts-expect-error": "error",
+
+      "@typescript-eslint/sort-type-constituents": 0,
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#triple-slash-reference
+      "@typescript-eslint/triple-slash-reference": [
+        "error",
+        { lib: "never", path: "never", types: "prefer-import" },
+      ],
+
+      // We use strict TS options instead.
+      // https://jc-verse.github.io/js-style-guide/typescript/base#typedef
+      "@typescript-eslint/typedef": "off",
+
+      // https://jc-verse.github.io/js-style-guide/typescript/base#unified-signatures
+      "@typescript-eslint/unified-signatures": [
+        "warn",
+        { ignoreDifferentlyNamedParameters: false },
+      ],
+    },
+  },
+  {
+    files: ["**/*.{js,cjs,mjs,jsx}"],
+    rules: {
+      "@typescript-eslint/default-param-last": "off",
+      "@typescript-eslint/explicit-module-boundary-types": "off",
+      "@typescript-eslint/no-require-imports": "off",
+      "@typescript-eslint/no-var-requires": "off",
+    },
+  },
+  {
+    files: ["**/*.{ts,tsx,cts,mts}"],
+    rules: {
+      // Use TypeScript's checker instead
+      "no-undef": "off",
+    },
+  },
+);

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "tsconfig-jc",
+  "compilerOptions": {
+    "declaration": true,
+    "rootDir": "./src",
+    "outDir": "./dist"
+  }
+}

package/index.js

@@ -1,17 +0,0 @@
-module.exports = {
-  root: true,
-  extends: [
-    "prettier",
-    "./rules/base.js",
-    "./rules/regex.js",
-    "./rules/typescript.js",
-    "./rules/import.js",
-    "./rules/react.js",
-    "./rules/jsx.js",
-    // Not included by default:
-    // "./rules/typescript-typecheck.js",
-    // "./rules/node.js",
-    // "./rules/react-class-comps.js",
-    // "./rules/react-prop-types.js",
-  ],
-};

package/rules/typescript.js

@@ -1,362 +0,0 @@
-module.exports = {
-  globals: {
-    JSX: true,
-  },
-  overrides: [
-    {
-      files: ["**/*.{js,cjs,mjs,jsx}"],
-      rules: {
-        "@typescript-eslint/default-param-last": "off",
-        "@typescript-eslint/explicit-module-boundary-types": "off",
-        "@typescript-eslint/no-require-imports": "off",
-        "@typescript-eslint/no-var-requires": "off",
-      },
-    },
-    {
-      files: ["**/*.{ts,tsx,cts,mts}"],
-      rules: {
-        // Use TypeScript's checker instead
-        "no-undef": "off",
-      },
-    },
-  ],
-  parser: "@typescript-eslint/parser",
-  parserOptions: {
-    sourceType: "module",
-  },
-  plugins: ["@typescript-eslint"],
-  rules: {
-    // https://jc-verse.github.io/js-style-guide/typescript/base#adjacent-overload-signatures
-    "@typescript-eslint/adjacent-overload-signatures": "error",
-
-    // I wish this rule can be more flexible to allow T[] where T is a union
-    // https://jc-verse.github.io/js-style-guide/typescript/base#adjacent-overload-signatures
-    "@typescript-eslint/array-type": [
-      "error",
-      { default: "array", readonly: "array" },
-    ],
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#ban-ts-comment
-    "@typescript-eslint/ban-ts-comment": [
-      "error",
-      {
-        minimumDescriptionLength: 3,
-        "ts-check": false,
-        "ts-expect-error": "allow-with-description",
-        "ts-ignore": true,
-        "ts-nocheck": true,
-      },
-    ],
-
-    // We've never used TSLint anyway
-    // https://jc-verse.github.io/js-style-guide/typescript/base#ban-tslint-comment
-    "@typescript-eslint/ban-tslint-comment": "error",
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#ban-types
-    "@typescript-eslint/ban-types": [
-      "error",
-      {
-        extendDefaults: true,
-        types: {
-          "{}": false,
-        },
-      },
-    ],
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#class-literal-property-style
-    "@typescript-eslint/class-literal-property-style": ["warn", "getters"],
-
-    // We turn off the base rule too
-    "@typescript-eslint/class-methods-use-this": "off",
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#consistent-generic-constructors
-    "@typescript-eslint/consistent-generic-constructors": [
-      "error",
-      "constructor",
-    ],
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#consistent-indexed-object-style
-    "@typescript-eslint/consistent-indexed-object-style": [
-      "error",
-      "index-signature",
-    ],
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#consistent-type-assertions
-    "@typescript-eslint/consistent-type-assertions": [
-      "error",
-      { assertionStyle: "as", objectLiteralTypeAssertions: "allow" },
-    ],
-
-    // We sometimes allow declaration merging
-    // https://jc-verse.github.io/js-style-guide/typescript/base#consistent-type-definitions
-    "@typescript-eslint/consistent-type-definitions": "off",
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#consistent-type-imports
-    "@typescript-eslint/consistent-type-imports": [
-      "error",
-      {
-        disallowTypeAnnotations: false,
-        fixStyle: "inline-type-imports",
-        prefer: "type-imports",
-      },
-    ],
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#default-param-last
-    "@typescript-eslint/default-param-last": "error",
-
-    // No—too verbose
-    // https://jc-verse.github.io/js-style-guide/typescript/base#explicit-function-return-type
-    "@typescript-eslint/explicit-function-return-type": "off",
-
-    // Defaulting to public makes sense
-    // https://jc-verse.github.io/js-style-guide/typescript/base#explicit-member-accessibility
-    "@typescript-eslint/explicit-member-accessibility": "off",
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#explicit-module-boundary-types
-    "@typescript-eslint/explicit-module-boundary-types": "warn",
-
-    "init-declarations": "off",
-    // https://jc-verse.github.io/js-style-guide/typescript/base#init-declarations
-    // eslint-disable-next-line sort-keys
-    "@typescript-eslint/init-declarations": ["error", "always"],
-
-    // We turn off the base rule too
-    "@typescript-eslint/max-params": "off",
-
-    // TODO figure out how this should be configured
-    "@typescript-eslint/member-ordering": 0,
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#method-signature-style
-    "@typescript-eslint/method-signature-style": ["error", "property"],
-
-    // TODO
-    "@typescript-eslint/naming-convention": 0,
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#no-array-constructor
-    "@typescript-eslint/no-array-constructor": "off",
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#no-confusing-non-null-assertion
-    "@typescript-eslint/no-confusing-non-null-assertion": "error",
-
-    "no-dupe-class-members": "off",
-    // https://jc-verse.github.io/js-style-guide/typescript/base#no-dupe-class-members
-    // eslint-disable-next-line sort-keys
-    "@typescript-eslint/no-dupe-class-members": "error",
-
-    // This can be useful for dynamic object transformations
-    // https://jc-verse.github.io/js-style-guide/typescript/base#no-dynamic-delete
-    "@typescript-eslint/no-dynamic-delete": "off",
-
-    // We turn off the base rule too
-    "@typescript-eslint/no-empty-function": "off",
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#no-empty-interface
-    "@typescript-eslint/no-empty-interface": [
-      "error",
-      { allowSingleExtends: true },
-    ],
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#no-explicit-any
-    "@typescript-eslint/no-explicit-any": "warn",
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#no-extra-non-null-assertion
-    "@typescript-eslint/no-extra-non-null-assertion": "error",
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#no-extraneous-class
-    "@typescript-eslint/no-extraneous-class": [
-      "warn",
-      {
-        allowConstructorOnly: false,
-        allowEmpty: false,
-        allowStaticOnly: false,
-        allowWithDecorator: false,
-      },
-    ],
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#no-import-type-side-effects
-    "@typescript-eslint/no-import-type-side-effects": "error",
-
-    // Annotating parameters makes the code more uniform
-    "@typescript-eslint/no-inferrable-types": [
-      "error",
-      { ignoreParameters: true },
-    ],
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#no-invalid-this
-    "@typescript-eslint/no-invalid-this": "off",
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#no-invalid-void-type
-    "@typescript-eslint/no-invalid-void-type": [
-      "warn",
-      { allowAsThisParameter: false, allowInGenericTypeArguments: true },
-    ],
-
-    // We turn off the base rule too
-    "@typescript-eslint/no-loop-func": "off",
-
-    // To be deprecated
-    "@typescript-eslint/no-loss-of-precision": "off",
-
-    // We turn off the base rule too
-    "@typescript-eslint/no-magic-numbers": "off",
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#no-misused-new
-    "@typescript-eslint/no-misused-new": "error",
-
-    // Use namespaces to organize your code
-    // https://jc-verse.github.io/js-style-guide/typescript/base#no-namespace
-    "@typescript-eslint/no-namespace": "off",
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#no-non-null-asserted-nullish-coalescing
-    "@typescript-eslint/no-non-null-asserted-nullish-coalescing": "error",
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#no-non-null-asserted-optional-chain
-    "@typescript-eslint/no-non-null-asserted-optional-chain": "error",
-
-    // It's useful.
-    // https://jc-verse.github.io/js-style-guide/typescript/base#no-non-null-assertion
-    "@typescript-eslint/no-non-null-assertion": "off",
-
-    "no-redeclare": "off",
-    // https://jc-verse.github.io/js-style-guide/typescript/base#no-redeclare
-    // eslint-disable-next-line sort-keys
-    "@typescript-eslint/no-redeclare": [
-      "error",
-      {
-        builtinGlobals: true,
-        // We also allow redeclaring between variables and types although the
-        // rule doesn't allow that
-        ignoreDeclarationMerge: true,
-      },
-    ],
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#no-require-imports
-    "@typescript-eslint/no-require-imports": "error",
-
-    "no-shadow": "off",
-    // https://jc-verse.github.io/js-style-guide/typescript/base#no-shadow
-    // eslint-disable-next-line sort-keys
-    "@typescript-eslint/no-shadow": [
-      "warn",
-      {
-        allow: [],
-        builtinGlobals: false,
-        hoist: "all",
-        ignoreFunctionTypeParameterNameValueShadow: false,
-        ignoreOnInitialization: true,
-        ignoreTypeValueShadow: true,
-      },
-    ],
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#no-this-alias
-    "@typescript-eslint/no-this-alias": [
-      "warn",
-      { allowDestructuring: true, allowedNames: [] },
-    ],
-
-    // Deprecated
-    "@typescript-eslint/no-type-alias": "off",
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#no-unnecessary-type-constraint
-    "@typescript-eslint/no-unnecessary-type-constraint": "error",
-
-    "no-unused-expressions": "off",
-    // https://jc-verse.github.io/js-style-guide/typescript/base#no-unused-expressions
-    // eslint-disable-next-line sort-keys
-    "@typescript-eslint/no-unused-expressions": [
-      "error",
-      {
-        allowShortCircuit: true,
-        allowTaggedTemplates: true,
-        allowTernary: true,
-        enforceForJSX: true,
-      },
-    ],
-
-    "no-unused-vars": "off",
-    // https://jc-verse.github.io/js-style-guide/typescript/base#no-unused-vars
-    // eslint-disable-next-line sort-keys
-    "@typescript-eslint/no-unused-vars": [
-      "error",
-      {
-        args: "after-used",
-        caughtErrors: "all",
-        ignoreRestSiblings: true,
-        vars: "all",
-      },
-    ],
-
-    "no-use-before-define": "off",
-    // eslint-disable-next-line sort-keys
-    "@typescript-eslint/no-use-before-define": [
-      "error",
-      {
-        allowNamedExports: true,
-        classes: true,
-        enums: false,
-        functions: false,
-        ignoreTypeReferences: true,
-        typedefs: false,
-        variables: true,
-      },
-    ],
-
-    "no-useless-constructor": "off",
-    // eslint-disable-next-line sort-keys
-    "@typescript-eslint/no-useless-constructor": "error",
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#no-useless-empty-export
-    "@typescript-eslint/no-useless-empty-export": "error",
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#no-var-requires
-    "@typescript-eslint/no-var-requires": "error",
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#parameter-properties
-    "@typescript-eslint/parameter-properties": [
-      "warn",
-      { allow: [], prefer: "class-property" },
-    ],
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#prefer-as-const
-    "@typescript-eslint/prefer-as-const": "error",
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#prefer-enum-initializers
-    "@typescript-eslint/prefer-enum-initializers": "error",
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#prefer-for-of
-    "@typescript-eslint/prefer-for-of": "error",
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#prefer-function-type
-    "@typescript-eslint/prefer-function-type": "error",
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#prefer-literal-enum-member
-    "@typescript-eslint/prefer-literal-enum-member": [
-      "warn",
-      { allowBitwiseExpressions: true },
-    ],
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#prefer-namespace-keyword
-    "@typescript-eslint/prefer-namespace-keyword": "error",
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#prefer-ts-expect-error
-    "@typescript-eslint/prefer-ts-expect-error": "error",
-
-    "@typescript-eslint/sort-type-constituents": 0,
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#triple-slash-reference
-    "@typescript-eslint/triple-slash-reference": [
-      "error",
-      { lib: "never", path: "never", types: "prefer-import" },
-    ],
-
-    // We use strict TS options instead.
-    // https://jc-verse.github.io/js-style-guide/typescript/base#typedef
-    "@typescript-eslint/typedef": "off",
-
-    // https://jc-verse.github.io/js-style-guide/typescript/base#unified-signatures
-    "@typescript-eslint/unified-signatures": [
-      "warn",
-      { ignoreDifferentlyNamedParameters: false },
-    ],
-  },
-};