Cleanup eslint config (#562)

.eslintrc

@@ -1,10 +1,7 @@
 {
   "root": true,
   "parser": "@typescript-eslint/parser",
-  "plugins": [
-    "@typescript-eslint",
-    "security"
-  ],
+  "plugins": ["@typescript-eslint", "security"],
   "env": {
     "browser": true
   },
@@ -13,6 +10,9 @@
       "webpack": {
         "config": "./browsers/webpack.config.js"
       }
+    },
+    "react": {
+      "version": "detect"
     }
   },
   "extends": [
@@ -21,12 +21,15 @@
     "plugin:@typescript-eslint/recommended",
     "plugin:react/recommended",
     "plugin:react-hooks/recommended",
-    "plugin:import/errors",
-    "plugin:import/warnings",
     "plugin:import/typescript",
     "plugin:security/recommended"
+
+    // TODO: Restore these after https://github.com/benmosher/eslint-plugin-import/issues/1931
+    // "plugin:import/errors",
+    // "plugin:import/warnings",
   ],
   "rules": {
+    "@typescript-eslint/no-empty-function": "off",
     "react/prop-types": "off",
     "@typescript-eslint/ban-types": ["warn"],
     "@typescript-eslint/no-unused-vars": [
@@ -41,19 +44,39 @@
       }
     ],
     "@typescript-eslint/no-explicit-any": ["warn"],
-    "@typescript-eslint/ban-ts-comment": ["error", {
-      "ts-ignore": "allow-with-description",
-      "minimumDescriptionLength": 3
-    }]
+    "@typescript-eslint/ban-ts-comment": [
+      "error",
+      {
+        "ts-ignore": "allow-with-description",
+        "minimumDescriptionLength": 3
+      }
+    ]
   },
   "ignorePatterns": [
-    "browsers/chrome/webpack/**",
-    "browsers/firefox/webpack/**",
-    "browsers/webpack.config.js",
-    "scripts/webpack.scripts.js",
-    "src/vendors/libraryDetector/**",
-    "src/**/*.test.ts",
-    "src/**/*.test.js",
+    "node_modules",
+    ".idea",
+    "browsers/dist",
+    "artifacts",
+    "scripts/bin",
+    "src/vendors",
     "src/support.js"
+  ],
+  "overrides": [
+    {
+      "files": [
+        "webpack.*.js",
+        "*.config.js",
+        "test-env.js",
+        "**/__mocks__/**",
+        "*.test.js"
+      ],
+      "env": {
+        "node": true,
+        "jest": true
+      },
+      "rules": {
+        "@typescript-eslint/no-var-requires": "off"
+      }
+    }
   ]
 }

.github/workflows/integration.yml

@@ -63,3 +63,20 @@ jobs:
           name: brick-headers
           path: headers.json
           retention-days: 5
+
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: "14.x"
+      - uses: bahmutov/npm-install@v1
+        # Run eslint without GitHub Actions annotations
+        # https://stackoverflow.com/a/65964721/288906
+      - name: npm run lint
+        run: |
+          echo "::remove-matcher owner=eslint-compact::"
+          echo "::remove-matcher owner=eslint-stylish::"
+          npm run lint

.gitignore

@@ -5,6 +5,7 @@ db.sqlite3
 .env
 .env.*
 staticfiles
+.vscode
 
 # User-specific stuff:
 .idea/workspace.xml

browsers/webpack.config.js

@@ -368,6 +368,10 @@ module.exports = (env, options) => ({
         type: "json", // Required by Webpack v4
         use: "yaml-loader",
       },
+      {
+        test: /\.txt/,
+        type: "asset/source",
+      },
     ],
   },
 });

package.json

@@ -6,7 +6,7 @@
   "scripts": {
     "test": "jest",
     "test:watch": "jest --watchAll",
-    "lint": "eslint src/**",
+    "lint": "eslint src",
     "watch": "ENV_FILE='.env.development' webpack --mode development --config browsers/webpack.config.js --watch",
     "build": "NODE_OPTIONS=--max_old_space_size=8192 webpack --mode production --config browsers/webpack.config.js",
     "build:scripts": "webpack --mode production --config scripts/webpack.scripts.js",
@@ -156,7 +156,7 @@
     "@types/webpack-env": "^1.16.0",
     "@types/yup": "^0.29.11",
     "@typescript-eslint/eslint-plugin": "^4.27.0",
-    "@typescript-eslint/parser": "^4.20.0",
+    "@typescript-eslint/parser": "^4.27.0",
     "axios-mock-adapter": "^1.19.0",
     "babel-jest": "^27.0.2",
     "compass-mixins": "^0.12.10",

src/devTools/editor/SelectorSelectorField.tsx

@@ -39,7 +39,6 @@ import { Framework } from "@/messaging/constants";
 import { reportError } from "@/telemetry/logging";
 
 // eslint is complaining that it can't parse the Option file
-// eslint-disable-next-line import/namespace
 import { OptionProps } from "react-select/src/components/Option";
 import { useToasts } from "react-toast-notifications";
 

src/helpers.ts

@@ -60,7 +60,7 @@ export function engineRenderer(
 }
 
 // first part of the path can be global context with a @
-const pathRegex = /^(@?[a-zA-Z0-9_\-]+\??)(\.[a-zA-Z0-9_\-]+\??)*$/;
+const pathRegex = /^(@?[a-zA-Z0-9_-]+\??)(\.[a-zA-Z0-9_-]+\??)*$/;
 
 /**
  * Return true if maybePath refers to a property in ctxt.

src/import-svg.d.ts → src/import-assets.d.ts

@@ -20,3 +20,8 @@ declare module "*.svg" {
   const value: any;
   export default value;
 }
+
+declare module "*.txt" {
+  const value: string;
+  export default value;
+}

src/options/pages/brickEditor/CodeEditor.tsx

@@ -21,21 +21,13 @@ import Select from "react-select";
 import React, { useState, useRef, Suspense, useEffect } from "react";
 import { useField, useFormikContext } from "formik";
 
-// https://webpack.js.org/loaders/raw-loader/#examples
-const serviceTemplate = require("raw-loader!@contrib/templates/service.txt?esModule=false")
-  .default;
-const emberjsTemplate = require("raw-loader!@contrib/templates/reader-emberjs.txt?esModule=false")
-  .default;
-const jqueryTemplate = require("raw-loader!@contrib/templates/reader-jquery.txt?esModule=false")
-  .default;
-const reactTemplate = require("raw-loader!@contrib/templates/reader-react.txt?esModule=false")
-  .default;
-const menuTemplate = require("raw-loader!@contrib/templates/foundation-menu-item.txt?esModule=false")
-  .default;
-const panelTemplate = require("raw-loader!@contrib/templates/foundation-panel.txt?esModule=false")
-  .default;
-const blueprintTemplate = require("raw-loader!@contrib/templates/blueprint-menu.txt?esModule=false")
-  .default;
+import serviceTemplate from "@contrib/templates/service.txt";
+import emberjsTemplate from "@contrib/templates/reader-emberjs.txt";
+import jqueryTemplate from "@contrib/templates/reader-jquery.txt";
+import reactTemplate from "@contrib/templates/reader-react.txt";
+import menuTemplate from "@contrib/templates/foundation-menu-item.txt";
+import panelTemplate from "@contrib/templates/foundation-panel.txt";
+import blueprintTemplate from "@contrib/templates/blueprint-menu.txt";
 
 const AceEditor = React.lazy(
   () =>