[Focused Improvements] .eslintrc updates (#760)

* Modularized package .eslintrc each package extends the base repo's .eslintrc. typescript and react configs have been pulled out into their own eslint-config files in a new eslint-config directory at the repo root. This should make linting easier to maintain when adding additional frameworks, and will necessitate less file changes in the future. * Updated disable-next-line comments to work with new structure * Line endings added * Readd mistakenly removed rules, remove redudent extends * Remove trailing comma * Fixed linebreak-style rule * Revert no-unused-vars change * Add newlines to package*.json in root, also trimlines dev: true * Revert ignorePattern * Remove parser options
Sitecore · Aug 2, 2021 · b1aaa79 · b1aaa79
1 parent 57564b7
commit b1aaa79
Show file tree

Hide file tree

Showing 22 changed files with 151 additions and 131 deletions.
diff --git a/.eslintrc b/.eslintrc
@@ -2,7 +2,6 @@
   "root": true,
   "extends": [
     "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
     "plugin:jsdoc/recommended",
     "prettier",
     "prettier/@typescript-eslint"
@@ -15,7 +14,11 @@
     "ecmaVersion": 2020,
     "sourceType": "module"
   },
-  "plugins": ["@typescript-eslint", "prettier", "jsdoc"],
+  "plugins": [
+    "@typescript-eslint",
+    "prettier",
+    "jsdoc"
+  ],
   "env": {
     "browser": true,
     "node": true,
@@ -29,31 +32,21 @@
     "jsdoc/no-undefined-types": "off",
     "jsdoc/require-returns-type": "off",
     "prettier/prettier": "error",
-    "@typescript-eslint/naming-convention": [
+    "no-use-before-define": "off",
+    "no-useless-escape": "off",
+    "spaced-comment": "error",
+    "curly": [
       "error",
-      {
-        "format": ["PascalCase"],
-        "selector": "typeLike",
-        "custom": {
-          "regex": "^I[A-Z]",
-          "match": false
-        }
-      }
+      "multi-line"
     ],
-    "@typescript-eslint/member-ordering": "error",
-    "no-use-before-define": "off",
-    "@typescript-eslint/no-use-before-define": [
+    "eol-last": [
       "error",
-      { "functions": false, "variables": false }
+      "always"
+    ],
+    "linebreak-style": [
+      "error",
+      "windows"
     ],
-    "@typescript-eslint/typedef": "error",
-    "@typescript-eslint/type-annotation-spacing": "error",
-    "@typescript-eslint/semi": "error",
-    "@typescript-eslint/no-var-requires": "off",
-    "no-useless-escape": "off",
-    "spaced-comment": "error",
-    "curly": ["error", "multi-line"],
-    "eol-last": ["error", "always"],
     "guard-for-in": "error",
     "no-unused-labels": "error",
     "no-caller": "error",
@@ -63,12 +56,24 @@
     "no-eval": "error",
     "dot-notation": "error",
     "no-trailing-spaces": "error",
-    "no-unused-expressions": ["error", { "allowShortCircuit": true, "allowTernary": true }],
+    "no-unused-expressions": [
+      "error",
+      {
+        "allowShortCircuit": true,
+        "allowTernary": true
+      }
+    ],
     "brace-style": "error",
-    "quotes": ["error", "single"],
+    "quotes": [
+      "error",
+      "single"
+    ],
     "radix": "error",
     "default-case": "error",
     "eqeqeq": "error",
-    "jsx-quotes": ["error", "prefer-double"]
+    "jsx-quotes": [
+      "error",
+      "prefer-double"
+    ]
   }
 }
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,3 +1,3 @@
 {
     "editor.fontSize": 13,
-}
+}
diff --git a/eslint-configs/react.js b/eslint-configs/react.js
@@ -0,0 +1,13 @@
+module.exports = {
+  extends: ['plugin:react/recommended'],
+  plugins: ['react'],
+  settings: {
+    react: {
+      version: 'detect',
+    },
+  },
+  globals: {
+    React: 'writable',
+    JSX: 'true',
+  },
+};
diff --git a/eslint-configs/typescript.js b/eslint-configs/typescript.js
@@ -0,0 +1,27 @@
+module.exports = {
+  extends: ['plugin:@typescript-eslint/recommended'],
+  rules: {
+    '@typescript-eslint/naming-convention': [
+      'error',
+      {
+        format: ['PascalCase'],
+        selector: 'typeLike',
+        custom: {
+          regex: '^I[A-Z]',
+          match: false,
+        },
+      },
+    ],
+    '@typescript-eslint/member-ordering': 'error',
+    '@typescript-eslint/no-use-before-define': ['error', { functions: false, variables: false }],
+    '@typescript-eslint/typedef': 'error',
+    '@typescript-eslint/type-annotation-spacing': 'error',
+    '@typescript-eslint/semi': 'error',
+    '@typescript-eslint/no-var-requires': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+  },
+  globals: {
+    RequestInit: 'true',
+  },
+};
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -34,4 +34,4 @@
     "prettier": "^1.14.3",
     "typescript": "^3.9.6"
   }
-}
+}
diff --git a/packages/sitecore-jss-angular/.eslintrc b/packages/sitecore-jss-angular/.eslintrc
@@ -1,9 +1,7 @@
 {
   "extends": [
     "plugin:@angular-eslint/recommended",
-    "../../.eslintrc"
-	],
-	"rules": {
-		"@typescript-eslint/explicit-module-boundary-types": "off"
-	}
+    "../../.eslintrc",
+    "../../eslint-configs/typescript"
+	]
 }
diff --git a/packages/sitecore-jss-cli/.eslintrc b/packages/sitecore-jss-cli/.eslintrc
@@ -1,6 +1,6 @@
 {
-	"extends": "../../.eslintrc",
-	"rules": {
-		"@typescript-eslint/explicit-module-boundary-types": "off"
-	}
-}
+  "extends": [
+    "../../.eslintrc",
+    "../../eslint-configs/typescript"
+  ]
+}
diff --git a/packages/sitecore-jss-dev-tools/.eslintrc b/packages/sitecore-jss-dev-tools/.eslintrc
@@ -1,6 +1,6 @@
 {
-	"extends": "../../.eslintrc",
-	"rules": {
-		"@typescript-eslint/explicit-module-boundary-types": "off"
-	}
-}
+  "extends": [
+    "../../.eslintrc",
+    "../../eslint-configs/typescript"
+  ]
+}
diff --git a/packages/sitecore-jss-forms/.eslintrc b/packages/sitecore-jss-forms/.eslintrc
@@ -1,6 +1,6 @@
 {
-  "extends": "../../.eslintrc",
-  "rules": {
-    "@typescript-eslint/explicit-module-boundary-types": "off"
-  }
+  "extends": [
+    "../../.eslintrc",
+    "../../eslint-configs/typescript"
+  ]
 }
diff --git a/packages/sitecore-jss-manifest/.eslintrc b/packages/sitecore-jss-manifest/.eslintrc
@@ -1,7 +1,6 @@
 {
-  "extends": "../../.eslintrc",
-  "rules": {
-    "@typescript-eslint/no-explicit-any": "off",
-    "@typescript-eslint/explicit-module-boundary-types": "off"
-  }
+  "extends": [
+    "../../.eslintrc",
+    "../../eslint-configs/typescript"
+  ]
 }
diff --git a/packages/sitecore-jss-nextjs/.eslintrc b/packages/sitecore-jss-nextjs/.eslintrc
@@ -1,15 +1,7 @@
 {
   "extends": [
-    "plugin:react/recommended",
-    "../../.eslintrc"
-  ],
-  "plugins": ["react"],
-  "settings": {
-    "react": {
-      "version": "detect"
-    }
-  },
-  "globals": {
-    "React": "writable"
-  }
+    "../../.eslintrc",
+    "../../eslint-configs/react",
+    "../../eslint-configs/typescript"
+  ]
 }
diff --git a/packages/sitecore-jss-proxy/.eslintrc b/packages/sitecore-jss-proxy/.eslintrc
@@ -1,6 +1,6 @@
 {
-  "extends": "../../.eslintrc",
-  "rules": {
-    "@typescript-eslint/explicit-module-boundary-types": "off"
-  }
+  "extends": [
+    "../../.eslintrc",
+    "../../eslint-configs/typescript"
+  ]
 }
diff --git a/packages/sitecore-jss-react-forms/.eslintrc b/packages/sitecore-jss-react-forms/.eslintrc
@@ -1,19 +1,10 @@
 {
   "extends": [
-    "plugin:react/recommended",
-    "../../.eslintrc"
+    "../../.eslintrc",
+    "../../eslint-configs/react",
+    "../../eslint-configs/typescript"
   ],
-  "plugins": ["react"],
-  "settings": {
-    "react": {
-      "version": "detect"
-    }
-  },
-  "globals": {
-    "React": "writable"
-	},
-	"rules": {
-    "react/prop-types": "off",
-    "@typescript-eslint/explicit-module-boundary-types": "off"
-	}
+  "rules": {
+    "react/prop-types": "off"
+  }
 }
diff --git a/packages/sitecore-jss-react-native/.eslintrc b/packages/sitecore-jss-react-native/.eslintrc
@@ -1,19 +1,17 @@
 {
-  "extends": ["../../.eslintrc"],
-  "parser": "@typescript-eslint/parser",
-  "plugins": ["react-native", "@typescript-eslint"],
-  "parserOptions": {
-    "ecmaFeatures": {
-      "jsx": true
-    }
-  },
+  "extends": [
+    "../../.eslintrc",
+    "../../eslint-configs/typescript"
+  ],
+  "plugins": [
+    "react-native"
+  ],
   "env": {
     "jest": true
   },
-  "ignorePatterns": ["src/**/*.test.*", "src/tests/*", "src/testData/*"],
-  "rules": {
-    "@typescript-eslint/explicit-module-boundary-types": "off",
-    "@typescript-eslint/no-empty-function": "off",
-    "@typescript-eslint/indent": ["error", 2]
-  }
+  "ignorePatterns": [
+    "src/**/*.test.*",
+    "src/tests/*",
+    "src/testData/*"
+  ]
 }
diff --git a/packages/sitecore-jss-react/.eslintrc b/packages/sitecore-jss-react/.eslintrc
@@ -1,18 +1,7 @@
 {
   "extends": [
-    "plugin:react/recommended",
-    "../../.eslintrc"
-  ],
-  "plugins": ["react"],
-  "settings": {
-    "react": {
-      "version": "detect"
-    }
-  },
-  "globals": {
-    "React": "writable"
-  },
-  "rules": {
-    "@typescript-eslint/explicit-module-boundary-types": "off"
-  }
+    "../../.eslintrc",
+    "../../eslint-configs/react",
+    "../../eslint-configs/typescript"
+  ]
 }
diff --git a/packages/sitecore-jss-rendering-host/.eslintrc b/packages/sitecore-jss-rendering-host/.eslintrc
@@ -1,6 +1,6 @@
 {
-  "extends": "../../.eslintrc",
-  "rules": {
-    "@typescript-eslint/explicit-module-boundary-types": "off"
-  }
+  "extends": [
+    "../../.eslintrc",
+    "../../eslint-configs/typescript"
+  ]
 }
diff --git a/packages/sitecore-jss-tracking/.eslintrc b/packages/sitecore-jss-tracking/.eslintrc
@@ -0,0 +1,6 @@
+{
+  "extends": [
+    "../../.eslintrc",
+    "../../eslint-configs/typescript"
+  ]
+}
diff --git a/packages/sitecore-jss-vue/.eslintrc b/packages/sitecore-jss-vue/.eslintrc
@@ -1,7 +1,7 @@
 {
-  "extends": ["plugin:vue/recommended", "../../.eslintrc"],
-  "rules": {
-    "@typescript-eslint/no-explicit-any": "off",
-    "@typescript-eslint/explicit-module-boundary-types": "off"
-  }
+  "extends": [
+    "plugin:vue/recommended",
+    "../../.eslintrc",
+    "../../eslint-configs/typescript"
+  ]
 }
diff --git a/packages/sitecore-jss/.eslintrc b/packages/sitecore-jss/.eslintrc
@@ -1,6 +1,6 @@
 {
-  "extends": "../../.eslintrc",
-  "rules": {
-    "@typescript-eslint/explicit-module-boundary-types": "off"
-  }
+  "extends": [
+    "../../.eslintrc",
+    "../../eslint-configs/typescript"
+  ]
 }
diff --git a/packages/sitecore-jss/src/layout/utils.ts b/packages/sitecore-jss/src/layout/utils.ts
@@ -10,6 +10,7 @@ export function getFieldValue<T>(
   renderingOrFields: ComponentRendering | Fields,
   fieldName: string
 ): T | undefined;
+// eslint-disable-next-line no-redeclare
 export function getFieldValue<T>(
   renderingOrFields: ComponentRendering | Fields,
   fieldName: string,
@@ -20,6 +21,7 @@ export function getFieldValue<T>(
  * @param {string} fieldName
  * @param {T} [defaultValue]
  */
+// eslint-disable-next-line no-redeclare
 export function getFieldValue<T>(
   renderingOrFields: ComponentRendering | Fields,
   fieldName: string,
-Original file line number
+Diff line change
@@ Expand Up / @@ -34,4 +34,4 @@ @@
         "prettier": "^1.14.3",
         "typescript": "^3.9.6"
       }
-    }
+    }