Upgrade ESLint configs to modules

.vscode/settings.json

@@ -4,6 +4,7 @@
   "files.trimFinalNewlines": true,
   "files.trimTrailingWhitespace": true,
   "eslint.workingDirectories": [
+    "./clients",
     "./clients/admin-ui",
     "./clients/fides-js",
     "./clients/fidesui",

CHANGELOG.md

@@ -27,6 +27,9 @@ The types of changes are:
 - Fixed malformed HTML issue on switch components [#5166](https://github.com/ethyca/fides/pull/5166)
 - Fixed a timing issue with tcf/gpp locator iframe naming [#5173](https://github.com/ethyca/fides/pull/5173)
 
+### Developer Experience
+- Fixes some ESLint configuration issues [#5176](https://github.com/ethyca/fides/pull/5176)
+
 ## [2.42.1](https://github.com/ethyca/fides/compare/2.42.0...2.42.1)
 
 ### Fixed

clients/.eslintignore

@@ -0,0 +1 @@
+**/.eslintrc*

clients/.eslintrc.json → clients/.eslintrc.cjs

@@ -1,16 +1,16 @@
-{
-  "extends": ["airbnb", "airbnb-typescript", "plugin:prettier/recommended"],
-  "plugins": ["simple-import-sort"],
-  "root": true,
-  "rules": {
-    "curly": ["error", "all"],
+module.exports = {
+  extends: ["airbnb", "airbnb-typescript", "plugin:prettier/recommended"],
+  plugins: ["simple-import-sort"],
+  root: true,
+  rules: {
+    curly: ["error", "all"],
     "nonblock-statement-body-position": ["error", "below"],
     "react/function-component-definition": [
       2,
-      { "namedComponents": "arrow-function" }
+      { namedComponents: "arrow-function" },
     ],
-    "react/jsx-filename-extension": ["warn", { "extensions": [".tsx"] }],
-    "react/jsx-key": ["error", { "checkFragmentShorthand": true }],
+    "react/jsx-filename-extension": ["warn", { extensions: [".tsx"] }],
+    "react/jsx-key": ["error", { checkFragmentShorthand: true }],
     "react/jsx-props-no-spreading": "off",
     "simple-import-sort/imports": "error",
     "simple-import-sort/exports": "error",
@@ -22,20 +22,21 @@
     "no-param-reassign": [
       "error",
       {
-        "props": true,
-        "ignorePropertyModificationsForRegex": ["^draft"]
-      }
+        props: true,
+        ignorePropertyModificationsForRegex: ["^draft"],
+      },
     ],
     "@typescript-eslint/ban-types": [
       "error",
       {
-        "types": {
+        types: {
           "React.FC": {
-            "message": "Remove entirely and allow Typescript to infer JSX.Element."
-          }
-        }
-      }
+            message:
+              "Remove entirely and allow Typescript to infer JSX.Element.",
+          },
+        },
+      },
     ],
-    "prettier/prettier": "warn"
-  }
-}
+    "prettier/prettier": "warn",
+  },
+};

clients/admin-ui/.eslintignore

@@ -2,7 +2,6 @@ node_modules
 dist
 out
 public/**/*.js
-.eslintrc.json
 next.config.js
 jest.config.js
 cypress.config.ts

clients/admin-ui/.eslintrc.cjs

@@ -0,0 +1,11 @@
+module.exports = {
+  extends: ["next/core-web-vitals"],
+  parserOptions: {
+    project: "tsconfig.json",
+    tsconfigRootDir: __dirname,
+  },
+  rules: {
+    // since we are using static site export
+    "@next/next/no-img-element": "off",
+  },
+};

clients/admin-ui/cypress/.eslintrc.cjs

@@ -0,0 +1,13 @@
+module.exports = {
+  extends: ["plugin:cypress/recommended"],
+  plugins: ["no-only-tests", "cypress"],
+  root: true,
+  parserOptions: {
+    project: "./tsconfig.json",
+    tsconfigRootDir: __dirname,
+  },
+  rules: {
+    "no-only-tests/no-only-tests": "error",
+    "cypress/unsafe-to-chain-command": "off",
+  },
+};

clients/fides-js/.eslintignore

@@ -1,5 +1,4 @@
 node_modules
 dist
-.eslintrc.json
 jest.config.js
 rollup.config.mjs

clients/fides-js/.eslintrc.cjs

@@ -0,0 +1,16 @@
+module.exports = {
+  extends: ["preact"],
+  parserOptions: {
+    project: "tsconfig.json",
+    tsconfigRootDir: __dirname,
+  },
+  parser: "@typescript-eslint/parser",
+  rules: {
+    "import/no-cycle": "off",
+    "import/extensions": "off",
+    "react/prop-types": "off",
+    "no-undef": "off",
+    "no-unused-vars": "off", // the @typescript-eslint line below is smarter about handling unused variables, taking in to account TS interfaces
+    "@typescript-eslint/no-unused-vars": ["error", { varsIgnorePattern: "^_" }],
+  },
+};

clients/fides-js/src/components/tcf/TcfFeatures.tsx

@@ -1,12 +1,11 @@
 import { h } from "preact";
 
-import { UpdateEnabledIds } from "~/components/tcf/TcfTabs";
-
 import { PrivacyExperience } from "../../lib/consent-types";
 import { I18n } from "../../lib/i18n";
 import { TCFFeatureRecord, TCFSpecialFeatureRecord } from "../../lib/tcf/types";
 import EmbeddedVendorList from "./EmbeddedVendorList";
 import RecordsList, { RecordListType } from "./RecordsList";
+import { UpdateEnabledIds } from "./TcfTabs";
 
 const FeatureChildren = ({
   i18n,

clients/fides-js/src/services/api.ts

@@ -1,5 +1,3 @@
-import { Locale } from "~/fides";
-
 import {
   ComponentType,
   ConsentMethod,
@@ -13,6 +11,7 @@ import {
   RecordsServedResponse,
 } from "../lib/consent-types";
 import { debugLog } from "../lib/consent-utils";
+import { Locale } from "../lib/i18n";
 import { GVLTranslations } from "../lib/tcf/types";
 
 export enum FidesEndpointPaths {

clients/fidesui/.eslintrc.cjs

@@ -0,0 +1,15 @@
+module.exports = {
+  env: {
+    browser: true,
+    es2021: true,
+  },
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    project: "tsconfig.json",
+    tsconfigRootDir: __dirname,
+  },
+  rules: {
+    "import/no-extraneous-dependencies": "off",
+    "react/react-in-jsx-scope": "off",
+  },
+};

clients/privacy-center/.eslintignore

@@ -2,7 +2,6 @@ node_modules
 dist
 out
 public/**/*.js
-.eslintrc.json
 next.config.js
 jest.config.js
 cypress.config.ts

clients/privacy-center/.eslintrc.cjs

@@ -0,0 +1,30 @@
+module.exports = {
+  extends: ["next/core-web-vitals"],
+  parserOptions: {
+    project: "tsconfig.json",
+    tsconfigRootDir: __dirname,
+  },
+  overrides: [
+    {
+      // Require Swagger JSdoc for all /api routes
+      files: ["pages/api/**/*.ts"],
+      plugins: ["jsdoc"],
+      rules: {
+        "jsdoc/no-missing-syntax": [
+          "error",
+          {
+            contexts: [
+              {
+                comment: "JsdocBlock:has(JsdocTag[tag=swagger])",
+                context: "any",
+                message:
+                  "@swagger documentation is required. See: https://github.com/jellydn/next-swagger-doc",
+              },
+            ],
+          },
+        ],
+      },
+    },
+  ],
+  rules: {},
+};

clients/privacy-center/cypress/.eslintrc.cjs

@@ -0,0 +1,13 @@
+module.exports = {
+  extends: ["plugin:cypress/recommended"],
+  plugins: ["no-only-tests", "cypress"],
+  root: true,
+  parserOptions: {
+    project: "./tsconfig.json",
+    tsconfigRootDir: __dirname,
+  },
+  rules: {
+    "no-only-tests/no-only-tests": "error",
+    "cypress/unsafe-to-chain-command": "off",
+  },
+};

clients/sample-app/.eslintrc.js → clients/sample-app/.eslintrc.cjs

@@ -5,6 +5,14 @@ module.exports = {
     "prettier",
     "next/core-web-vitals",
   ],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaVersion: 2022,
+    sourceType: "module",
+    project: "tsconfig.json",
+    tsconfigRootDir: __dirname,
+    createDefaultProgram: true,
+  },
   root: true,
   rules: {
     // "curly": ["error", "all"],
@@ -20,11 +28,4 @@ module.exports = {
     ],
     "react/require-default-props": "off",
   },
-  parserOptions: {
-    ecmaVersion: 2022,
-    sourceType: "module",
-    project: "./tsconfig.json",
-    tsconfigRootDir: __dirname,
-    createDefaultProgram: true,
-  },
 };