eslint-config-jc 2.1.0 → 2.1.1

package/README.md

@@ -8,14 +8,43 @@ This is designed to be a replacement for `eslint:recommended`, `plugin:react-hoo
 
 It requires the following plugins:
 
-- `eslint-plugin-react-hooks`
-- `@typescript-eslint/eslint-plugin`
-- `eslint-plugin-import`
-- `eslint-plugin-jsx-a11y`
-- `eslint-plugin-react`
+```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:
+
+```json
+{
+  "root": true,
+  "extends": ["jc"]
+}
+```
+
+Prettier config:
+
+```json
+{
+  "bracketSameLine": true,
+  "trailingComma": "all"
+}
+```
+
 ## Configuration philosophy
 
 When analyzing whether a rule should be `error`, `warn`, or `off`, the following assumptions are made:
@@ -51,3 +80,5 @@ A rule will _not_ be off solely because:
 - It enforces a practice concerning a construct that we never use in the first place
 
 Instead, in such case, we'd rather have multiple errors.
+
+All rules are considered as `error` by default, unless there are enough justifications to turn it into a warning or turn it off, as outlined above.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-jc",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "Josh-Cena's personal coding style",
   "main": "index.js",
   "repository": {
@@ -17,6 +17,15 @@
     "url": "https://github.com/jc-verse/eslint-config-jc/issues"
   },
   "homepage": "https://github.com/jc-verse/eslint-config-jc#readme",
+  "exports": {
+    ".": "./index.js",
+    "./base": "./rules/base.js",
+    "./import": "./rules/import.js",
+    "./jsx": "./rules/jsx.js",
+    "./react": "./rules/react.js",
+    "./typescript": "./rules/typescript.js",
+    "./typescript-typecheck": "./rules/typescript-typecheck.js"
+  },
   "peerDependencies": {
     "@typescript-eslint/eslint-plugin": "^5.10.2",
     "@typescript-eslint/parser": "^5.10.2",

package/rules/base.js

@@ -5,8 +5,14 @@ module.exports = {
     node: true,
   },
   rules: {
-    // Only warn if there's a set but not a get. Allows readonly members.
-    "accessor-pairs": "warn",
+    "accessor-pairs": [
+      "error",
+      {
+        enforceForClassMembers: true,
+        getWithoutSet: true,
+        setWithoutGet: true,
+      },
+    ],
 
     "array-callback-return": [
       "error",
@@ -40,7 +46,7 @@ module.exports = {
 
     // Requires return statements to either always or never specify values.
     // TypeScript sometimes enforces this, but it can be stylistic as well.
-    "consistent-return": "error",
+    "consistent-return": ["error", { treatUndefinedAsUnspecified: false }],
 
     // Enforces consistent naming when capturing the current execution context.
     // We warn against aliasing `this` altogether, but when we do, the name
@@ -64,22 +70,21 @@ module.exports = {
     "default-param-last": "off",
 
     // e.g. `foo.bar` instead of `foo["bar"]`
-    "dot-notation": "error",
+    "dot-notation": ["error", { allowKeywords: true }],
 
-    // Requires the use of === and !==.
-    eqeqeq: "error",
+    eqeqeq: ["error", "always", { null: "ignore" }],
 
     "for-direction": "error",
 
     // We rarely use function expressions.
-    "func-name-matching": "warn",
+    "func-name-matching": ["warn", "always"],
 
     // We rarely use function expressions.
     "func-names": "warn",
 
     "func-style": ["warn", "declaration", { allowArrowFunctions: true }],
 
-    "getter-return": "error",
+    "getter-return": ["error", { allowImplicit: false }],
 
     // It's also common to have all getters in one place and setters in another.
     "grouped-accessor-pairs": "off",

package/rules/react.js

@@ -149,9 +149,9 @@ module.exports = {
 
     "react/void-dom-elements-no-children": "error",
 
-    'react-hooks/exhaustive-deps': "error",
+    "react-hooks/exhaustive-deps": "error",
 
-    'react-hooks/rules-of-hooks': "error",
+    "react-hooks/rules-of-hooks": "error",
   },
   settings: {
     react: {