eslint-config-jc 2.2.0 → 2.3.2

package/index.js

@@ -1,11 +1,9 @@
 module.exports = {
   root: true,
-  reportUnusedDisableDirectives: true,
   extends: [
     "prettier",
     "./rules/base.js",
     "./rules/typescript.js",
-    "./rules/typescript-typecheck.js",
     "./rules/import.js",
     "./rules/react.js",
     "./rules/jsx.js",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-jc",
-  "version": "2.2.0",
+  "version": "2.3.2",
   "description": "Josh-Cena's personal coding style",
   "main": "index.js",
   "repository": {
@@ -12,8 +12,12 @@
     "eslint",
     "eslint-config"
   ],
-  "author": "Joshua Chen",
+  "author": "Joshua Chen <sidachen2003@gmail.com>",
   "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
   "bugs": {
     "url": "https://github.com/jc-verse/js-style-guide/issues"
   },
@@ -31,16 +35,19 @@
     "eslint-config-prettier": "^8.5.0"
   },
   "peerDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.18.0",
-    "@typescript-eslint/parser": "^5.18.0",
-    "eslint": "^8.13.0",
+    "@typescript-eslint/eslint-plugin": "^5.28.0",
+    "@typescript-eslint/parser": "^5.28.0",
+    "eslint": "^8.17.0",
     "eslint-plugin-header": "^3.1.1",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-jsx-a11y": "^6.5.1",
-    "eslint-plugin-react": "^7.29.4",
-    "eslint-plugin-react-hooks": "^4.4.0"
+    "eslint-plugin-react": "^7.30.0",
+    "eslint-plugin-react-hooks": "^4.6.0"
   },
   "peerDependenciesMeta": {
+    "eslint-plugin-header": {
+      "optional": true
+    },
     "eslint-plugin-jsx-a11y": {
       "optional": true
     },

package/rules/base.js

@@ -2,8 +2,10 @@ module.exports = {
   env: {
     browser: true,
     commonjs: true,
+    es6: true,
     node: true,
   },
+  reportUnusedDisableDirectives: true,
   rules: {
     "accessor-pairs": [
       "error",
@@ -34,9 +36,14 @@ module.exports = {
     // Properties are hard to check because they may come from other APIs
     camelcase: ["error", { properties: "never" }],
 
-    // Since we require comments to wrap at 80 characters, the next line will
-    // start with lowercase
-    "capitalized-comments": "off",
+    "capitalized-comments": [
+      "warn",
+      "always",
+      {
+        ignoreConsecutiveComments: true,
+        ignorePattern: "prettier-ignore|cSpell:ignore",
+      },
+    ],
 
     // It's a way of allowing private methods. (`this.myPrivateMethod()`)
     "class-methods-use-this": "off",
@@ -69,7 +76,7 @@ module.exports = {
     // Shadowed by TS-ESLint rule
     "default-param-last": "off",
 
-    // e.g. `foo.bar` instead of `foo["bar"]`
+    // E.g. `foo.bar` instead of `foo["bar"]`
     "dot-notation": ["error", { allowKeywords: true }],
 
     eqeqeq: ["error", "always", { null: "ignore" }],
@@ -170,6 +177,8 @@ module.exports = {
     // Also checked by TypeScript
     "no-const-assign": "error",
 
+    "no-constant-binary-expression": "error",
+
     "no-constant-condition": ["error", { checkLoops: true }],
 
     "no-constructor-return": "error",
@@ -203,7 +212,7 @@ module.exports = {
     // This rule is also in plugin-imports
     "no-duplicate-imports": "off",
 
-    // else-if is able to save one line, and also makes the flow more natural.
+    // `else-if` is able to save one line, and also makes the flow more natural.
     "no-else-return": ["error", { allowElseIf: true }],
 
     // Empty catch is useful.
@@ -345,6 +354,7 @@ module.exports = {
       "closed",
       "confirm",
       "defaultStatus",
+      // cSpell:ignore defaultstatus
       "defaultstatus",
       "event",
       "external",
@@ -588,11 +598,13 @@ module.exports = {
         block: {
           balanced: true,
           exceptions: ["-", "+"],
-          markers: ["=", "!", ":", "::"], // space here to support sprockets directives and flow comment types
+          // Space here to support sprockets directives and flow comment types
+          markers: ["=", "!", ":", "::"],
         },
         line: {
           exceptions: ["-", "+"],
-          markers: ["=", "!", "/"], // space here to support sprockets directives, slash for TS /// comments
+          // Space here to support sprockets directives, slash for /// comments
+          markers: ["=", "!", "/"],
         },
       },
     ],

package/rules/import.js

@@ -20,7 +20,9 @@ module.exports = {
 
     "import/no-duplicates": "error",
 
-    "import/no-unresolved": ["error", { caseSensitive: true, commonjs: true }],
+    // This rule doesn't play well with TypeScript + ESM. TS is able to catch
+    // missing import anyways.
+    "import/no-unresolved": ["off", { caseSensitive: true, commonjs: true }],
 
     // Going one directory above ensures transpilation doesn't mess with paths
     "import/no-useless-path-segments": "off",

package/rules/jsx.js

@@ -204,7 +204,7 @@ module.exports = {
 
     "react/jsx-curly-brace-presence": "error",
 
-    // js, jsx, tsx are all acceptable
+    // Js, jsx, tsx are all acceptable
     "react/jsx-filename-extension": "off",
 
     "react/jsx-fragments": "error",
@@ -216,7 +216,7 @@ module.exports = {
 
     "react/jsx-max-depth": "off",
 
-    "react/jsx-no-bind": "error",
+    "react/jsx-no-bind": ["error", { ignoreDOMComponents: true }],
 
     "react/jsx-no-comment-textnodes": "error",
 
@@ -224,6 +224,9 @@ module.exports = {
 
     "react/jsx-no-duplicate-props": "error",
 
+    // We'll use strict-boolean-expressions instead
+    "react/jsx-no-leaked-render": "off",
+
     "react/jsx-no-literals": "off",
 
     "react/jsx-no-script-url": "error",
@@ -235,7 +238,7 @@ module.exports = {
 
     "react/jsx-no-useless-fragment": ["error", { allowExpressions: true }],
 
-    "react/jsx-pascal-case": "error",
+    "react/jsx-pascal-case": ["error", { allowAllCaps: true }],
 
     "react/jsx-props-no-spreading": "off",
 

package/rules/typescript-typecheck.js

@@ -1,2 +1,114 @@
-// TODO enforce linting with typecheck
-module.exports = {};
+module.exports = {
+  rules: {
+    "@typescript-eslint/await-thenable": "error",
+
+    // Also enforced by --isolatedModules
+    "@typescript-eslint/consistent-type-exports": "error",
+
+    // TODO figure out how this should be configured
+    "@typescript-eslint/naming-convention": 0,
+
+    "@typescript-eslint/no-base-to-string": [
+      "warn",
+      { ignoredTypeNames: ["RegExp", "Error"] },
+    ],
+
+    "@typescript-eslint/no-confusing-void-expression": [
+      "error",
+      {
+        ignoreArrowShorthand: true,
+        ignoreVoidOperator: false,
+      },
+    ],
+
+    "@typescript-eslint/no-floating-promises": [
+      "warn",
+      {
+        ignoreIIFE: false,
+        ignoreVoid: true,
+      },
+    ],
+
+    "@typescript-eslint/no-for-in-array": "error",
+
+    "@typescript-eslint/no-meaningless-void-operator": "error",
+
+    "@typescript-eslint/no-misused-promises": "error",
+
+    "@typescript-eslint/no-redundant-type-constituents": "error",
+
+    "@typescript-eslint/no-unnecessary-boolean-literal-compare": "warn",
+
+    "@typescript-eslint/no-unnecessary-condition": [
+      "error",
+      { allowConstantLoopConditions: true },
+    ],
+
+    // Enums & namespaces aren't allowed anyway.
+    "@typescript-eslint/no-unnecessary-qualifier": "warn",
+
+    "@typescript-eslint/no-unnecessary-type-arguments": "warn",
+
+    "@typescript-eslint/no-unnecessary-type-assertion": "error",
+
+    "@typescript-eslint/no-unsafe-argument": "error",
+
+    "@typescript-eslint/no-unsafe-assignment": "error",
+
+    "@typescript-eslint/no-unsafe-call": "error",
+
+    "@typescript-eslint/no-unsafe-member-access": "error",
+
+    "@typescript-eslint/no-unsafe-return": "error",
+
+    "@typescript-eslint/non-nullable-type-assertion-style": "error",
+
+    "@typescript-eslint/prefer-includes": "error",
+
+    // This has a significant number of false-positives.
+    "@typescript-eslint/prefer-nullish-coalescing": "warn",
+
+    // Isn't useful.
+    "@typescript-eslint/prefer-readonly": "off",
+
+    // Isn't useful. If there's a readonly-by-default tsconfig option we would
+    // happily try it instead
+    "@typescript-eslint/prefer-readonly-parameter-types": "off",
+
+    "@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",
+
+    // Not useful. Sometimes we intentionally make the function non-async.
+    "@typescript-eslint/promise-function-async": "off",
+
+    "@typescript-eslint/require-array-sort-compare": "error",
+
+    // Implicit casting is fine.
+    "@typescript-eslint/restrict-plus-operands": "off",
+
+    // Default options work fine. However, not allowing `never` is a pain
+    "@typescript-eslint/restrict-template-expressions": [
+      "warn",
+      {
+        allowAny: false,
+        allowBoolean: false,
+        allowNullish: false,
+        allowNumber: true,
+        allowRegExp: false,
+      },
+    ],
+
+    // TODO configure it properly
+    "@typescript-eslint/strict-boolean-expressions": "off",
+
+    "@typescript-eslint/switch-exhaustiveness-check": "error",
+
+    // Not very useful in practice... A lot of false-positives
+    "@typescript-eslint/unbound-method": "off",
+  },
+};

package/rules/typescript.js

@@ -11,6 +11,13 @@ module.exports = {
         "@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: {
@@ -27,6 +34,11 @@ module.exports = {
 
     "@typescript-eslint/ban-types": "error",
 
+    "@typescript-eslint/consistent-generic-constructors": [
+      "error",
+      "constructor",
+    ],
+
     // Index signatures allows annotating the semantics of the key, while record
     // is more concise
     "@typescript-eslint/consistent-indexed-object-style": "off",
@@ -66,9 +78,6 @@ module.exports = {
 
     "@typescript-eslint/method-signature-style": ["error", "property"],
 
-    // TODO figure out how this should be configured
-    "@typescript-eslint/naming-convention": 0,
-
     "@typescript-eslint/no-array-constructor": "error",
 
     // This doesn't make much sense to me
@@ -147,7 +156,14 @@ module.exports = {
       { allowTaggedTemplates: true },
     ],
 
-    "@typescript-eslint/no-unused-vars": "error",
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      {
+        args: "after-used",
+        ignoreRestSiblings: true,
+        vars: "all",
+      },
+    ],
 
     // This reports a lot of valid cases, e.g. function declarations
     // TypeScript does a much better job