@uva-glass/eslint-config 1.0.2

package/.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[Makefile]
+indent_style = tab

package/.idea/GLASS-eslint.iml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
+      <excludeFolder url="file://$MODULE_DIR$/temp" />
+      <excludeFolder url="file://$MODULE_DIR$/tmp" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
+  </profile>
+</component>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/GLASS-eslint.iml" filepath="$PROJECT_DIR$/.idea/GLASS-eslint.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

package/README.md

@@ -0,0 +1,75 @@
+# GLASS-eslint
+
+Eslint configuration for the Glass frontend
+
+The default configuration contains linting rules for [javascript][1], [imports][2], [React][3] and [Typescript][4]. Optionally, configuration for [Node][5], and [testing][6] can be included.
+
+## Installation and usage
+
+### Install
+
+> **Note**
+> 
+> Make sure Node >= 18 is installed
+
+```
+npm i git@github.com:uva/GLASS-eslint.git --save-dev
+```
+
+### Using
+
+Create an `.eslintrc.json` file in the root of your project and add the following configuration:
+
+#### Basic
+
+```json
+{
+  "extends": ["glass"]
+}
+```
+
+This will apply Eslint rules from `@typescript-eslint/recommended`, `plugin:import/recommended`, `plugin:react/recommended`, and `plugin:react/jsx-runtime`.
+
+#### Include rules for testing
+
+```json
+{
+  "extends": ["glass", "glass/testing-library-react"]
+}
+```
+
+### Overriding
+
+The default set of rules is (more or less) equal to those that are available in [create-react-app][7]. The reason behind this, is that both [Lens][8] and [Prism][9] were both initially created from a create-react-app template. For an easy transition, the applicable Eslint rules were copied into this repository.
+
+Some rules might not be too specific or limiting for your code. In those cases, the default configuration can be extended or overwritten. For instance for files that are used on the command line by Jest, but are included in the regular code base:
+
+```json
+{
+  "extends": ["glass", "glass/testing-library-react"],
+  "overrides": [
+    {
+      "extends": ["glass/node"],
+      "files": ["**/__mocks__/*.js"],
+      "env": {
+        "browser": false,
+        "node": true
+      },
+      "rules": {
+        "import/no-commonjs": "off",
+        "import/unambiguous": "off"
+      }
+    }
+  ]
+}
+```
+
+[1]: ./base.js
+[2]: ./import.js
+[3]: ./react.js
+[4]: ./typescript.js
+[5]: ./node.js
+[6]: ./testing-library-react.js
+[7]: https://github.com/facebook/create-react-app/tree/main/packages/eslint-config-react-app
+[8]: https://github.com/uva/GLASS-lens
+[9]: https://github.com/uva/GLASS-prism

package/base.js

@@ -0,0 +1,87 @@
+module.exports = {
+  extends: ["eslint:recommended"],
+  plugins: ["promise"],
+  settings: { react: { version: "detect" } },
+  rules: {
+    "array-callback-return": "warn",
+    "dot-location": ["warn", "property"],
+    eqeqeq: ["warn", "smart"],
+    "new-parens": "warn",
+    "id-length": ["warn", { exceptions: ["t", "_"] }],
+    "no-caller": "warn",
+    "no-cond-assign": ["warn", "except-parens"],
+    "no-const-assign": "warn",
+    "no-control-regex": "warn",
+    "no-delete-var": "warn",
+    "no-dupe-args": "warn",
+    "no-dupe-keys": "warn",
+    "no-duplicate-case": "warn",
+    "no-empty-character-class": "warn",
+    "no-empty-pattern": "warn",
+    "no-eval": "warn",
+    "no-ex-assign": "warn",
+    "no-extend-native": "warn",
+    "no-extra-bind": "warn",
+    "no-extra-label": "warn",
+    "no-fallthrough": "warn",
+    "no-func-assign": "warn",
+    "no-implied-eval": "warn",
+    "no-invalid-regexp": "warn",
+    "no-iterator": "warn",
+    "no-label-var": "warn",
+    "no-labels": ["warn", { allowLoop: true, allowSwitch: false }],
+    "no-lone-blocks": "warn",
+    "no-loop-func": "warn",
+    "no-mixed-operators": [
+      "warn",
+      {
+        groups: [
+          ["&", "|", "^", "~", "<<", ">>", ">>>"],
+          ["==", "!=", "===", "!==", ">", ">=", "<", "<="],
+          ["&&", "||"],
+          ["in", "instanceof"],
+        ],
+        allowSamePrecedence: false,
+      },
+    ],
+    "no-multi-str": "warn",
+    "no-global-assign": "warn",
+    "no-unsafe-negation": "warn",
+    "no-new-func": "warn",
+    "no-new-object": "warn",
+    "no-new-symbol": "warn",
+    "no-new-wrappers": "warn",
+    "no-obj-calls": "warn",
+    "no-octal": "warn",
+    "no-octal-escape": "warn",
+    "no-regex-spaces": "warn",
+    "no-restricted-syntax": ["warn", "WithStatement"],
+    "no-script-url": "warn",
+    "no-self-assign": "warn",
+    "no-self-compare": "warn",
+    "no-sequences": "warn",
+    "no-shadow-restricted-names": "warn",
+    "no-sparse-arrays": "warn",
+    "no-template-curly-in-string": "warn",
+    "no-this-before-super": "warn",
+    "no-throw-literal": "warn",
+    "no-useless-computed-key": "warn",
+    "no-useless-concat": "warn",
+    "no-useless-escape": "warn",
+    "no-useless-rename": [
+      "warn",
+      {
+        ignoreDestructuring: false,
+        ignoreImport: false,
+        ignoreExport: false,
+      },
+    ],
+
+    "no-with": "warn",
+    "no-whitespace-before-property": "warn",
+    "require-yield": "warn",
+    "rest-spread-spacing": ["warn", "never"],
+    "no-lonely-if": "warn",
+    "no-implicit-coercion": "warn",
+  },
+};

package/import.js

@@ -0,0 +1,57 @@
+/** @type {import('eslint').ESLint} */
+module.exports = {
+  extends: ["plugin:import/recommended"],
+  plugins: ["import", "no-relative-import-paths"],
+  rules: {
+    "no-relative-import-paths/no-relative-import-paths": [
+      "warn",
+      { allowSameFolder: true, rootDir: "src" },
+    ],
+
+    // enabled rules
+    "import/no-anonymous-default-export": "error",
+    "import/no-commonjs": "error",
+    "import/no-webpack-loader-syntax": "error",
+    "import/unambiguous": "error",
+    "import/no-default-export": "error",
+    "import/first": "error",
+    "import/namespace": ["error", { allowComputed: true }],
+    "import/no-unassigned-import": ["error", { allow: ["**/*.css"] }],
+    "import/no-named-as-default": "error",
+    "import/prefer-default-export": "off",
+    "import/extensions": "error",
+    "import/first": "error",
+    "import/no-absolute-path": "error",
+    "import/no-amd": "error",
+    "import/no-cycle": "error",
+    "import/no-deprecated": "error",
+    "import/no-mutable-exports": "error",
+    "import/no-named-default": "error",
+    "import/no-nodejs-modules": "error",
+    "import/no-restricted-paths": "error",
+    "import/no-self-import": "error",
+    "import/no-unresolved": ["error", { commonjs: true }],
+    "import/no-unused-modules": "error",
+    "import/no-useless-path-segments": "error",
+    "import/order": [
+      "error",
+      {
+        groups: [
+          ["builtin", "external"],
+          "type",
+          ["parent", "sibling"],
+          "index",
+        ],
+        "newlines-between": "always",
+      },
+    ],
+  },
+  settings: {
+    "import/resolver": {
+      node: {
+        extensions: [".ts", ".tsx", ".js", ".jsx"],
+        moduleDirectory: ["node_modules", "./src"],
+      },
+    },
+  },
+};

package/index.js

@@ -0,0 +1,12 @@
+module.exports = {
+  extends: ["./base", "./import", "./react", "./typescript"],
+  // configs: {
+  //   base: require("./base"),
+  //   import: require("./import"),
+  //   node: require("./node"),
+  //   react: require("./react"),
+  //   "testing-library-react": require("./testing-library-react"),
+  //   typescript: require("./typescript"),
+  // },
+  // rules: {},
+};

package/node.js

@@ -0,0 +1,21 @@
+module.exports = {
+  extends: ["eslint:recommended", "plugin:node/recommended"],
+  parserOptions: { ecmaVersion: 2020 },
+  rules: {
+    "node/exports-style": ["error", "module.exports"],
+    "node/file-extension-in-import": ["error", "always"],
+    "node/prefer-global/buffer": ["error", "always"],
+    "node/prefer-global/console": ["error", "always"],
+    "node/prefer-global/process": ["error", "always"],
+    "node/prefer-global/url-search-params": ["error", "always"],
+    "node/prefer-global/url": ["error", "always"],
+    "node/prefer-promises/dns": "error",
+    "node/prefer-promises/fs": "error",
+    "node/no-unsupported-features/es-builtins": [
+      "error",
+      {
+        version: ">=18",
+      },
+    ],
+  },
+};

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@uva-glass/eslint-config",
+  "version": "1.0.2",
+  "engines": {
+    "node": ">=18"
+  },
+  "private": false,
+  "description": "GLASS eslint configuration",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/uva/GLASS-eslint.git"
+  },
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/uva/GLASS-eslint/issues"
+  },
+  "homepage": "https://github.com/uva/GLASS-eslint#readme",
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^5.48.2",
+    "@typescript-eslint/parser": "^5.48.2"
+  },
+  "dependencies": {
+    "eslint-import-resolver-typescript": "^3.5.3",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jest": "^27.2.1",
+    "eslint-plugin-jsx-a11y": "^6.7.1",
+    "eslint-plugin-no-relative-import-paths": "^1.5.2",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-react": "^7.32.1",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-testing-library": "^5.9.1"
+  },
+  "peerDependencies": {
+    "eslint": "^8"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
+}

package/react.js

@@ -0,0 +1,81 @@
+module.exports = {
+  extends: ["plugin:react/recommended", "plugin:react/jsx-runtime"],
+  plugins: ["jsx-a11y", "react", "react-hooks"],
+  env: { browser: true },
+  settings: { react: { version: "detect" } },
+  parserOptions: { ecmaVersion: 2020, sourceType: "module" },
+  rules: {
+    "react/display-name": "off",
+    "react/button-has-type": "off",
+
+    // jsx-a11y
+    "jsx-a11y/alt-text": "error",
+    "jsx-a11y/anchor-has-content": "error",
+    "jsx-a11y/anchor-is-valid": [
+      "error",
+      { aspects: ["noHref", "invalidHref"] },
+    ],
+    "jsx-a11y/aria-activedescendant-has-tabindex": "error",
+    "jsx-a11y/aria-props": "error",
+    "jsx-a11y/aria-proptypes": "error",
+    "jsx-a11y/aria-role": ["error", { ignoreNonDOM: true }],
+    "jsx-a11y/aria-unsupported-elements": "error",
+    "jsx-a11y/autocomplete-valid": "error",
+    "jsx-a11y/click-events-have-key-events": "error",
+    "jsx-a11y/heading-has-content": "error",
+    "jsx-a11y/html-has-lang": "error",
+    "jsx-a11y/iframe-has-title": "error",
+    "jsx-a11y/img-redundant-alt": "error",
+    "jsx-a11y/interactive-supports-focus": "error",
+    "jsx-a11y/label-has-associated-control": [
+      "error",
+      { controlComponents: ["Input"] },
+    ],
+    "jsx-a11y/lang": "error",
+    "jsx-a11y/media-has-caption": "error",
+    "jsx-a11y/mouse-events-have-key-events": "error",
+    "jsx-a11y/no-access-key": "error",
+    "jsx-a11y/no-distracting-elements": "error",
+    "jsx-a11y/no-interactive-element-to-noninteractive-role": "error",
+    "jsx-a11y/no-noninteractive-element-interactions": "error",
+    "jsx-a11y/no-noninteractive-element-to-interactive-role": "error",
+    "jsx-a11y/no-noninteractive-tabindex": "error",
+    "jsx-a11y/no-redundant-roles": "error",
+    "jsx-a11y/no-static-element-interactions": "error",
+    "jsx-a11y/role-has-required-aria-props": "error",
+    "jsx-a11y/role-supports-aria-props": "error",
+    "jsx-a11y/scope": "error",
+    "jsx-a11y/tabindex-no-positive": "error",
+
+    // react-hooks
+    "react-hooks/exhaustive-deps": "error",
+    "react-hooks/rules-of-hooks": "error",
+
+    // rules
+    "react/boolean-prop-naming": "error",
+    "react/forbid-foreign-prop-types": ["error", { allowInPropTypes: true }],
+    "react/jsx-closing-bracket-location": ["error", "tag-aligned"],
+    "react/jsx-curly-spacing": "error",
+    "react/jsx-first-prop-new-line": ["error", "multiline-multiprop"],
+    "react/jsx-fragments": ["error", "syntax"],
+    "react/jsx-key": "error",
+    "react/jsx-no-comment-textnodes": "error",
+    "react/jsx-no-duplicate-props": "error",
+    "react/jsx-no-undef": "error",
+    "react/jsx-no-useless-fragment": "error",
+    "react/jsx-pascal-case": ["error", { allowAllCaps: true, ignore: [] }],
+    "react/jsx-tag-spacing": "error",
+    "react/jsx-uses-react": "error",
+    "react/jsx-uses-vars": "error",
+    "react/no-danger-with-children": "error",
+    "react/no-deprecated": "error",
+    "react/no-did-mount-set-state": "error",
+    "react/no-direct-mutation-state": "error",
+    "react/no-is-mounted": "error",
+    "react/no-typos": "error",
+    "react/prop-types": "error",
+    "react/require-optimization": "error",
+    "react/require-render-return": "error",
+    "react/style-prop-object": "error",
+  },
+};

package/renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:base"
+  ]
+}

package/testing-library-react.js

@@ -0,0 +1,66 @@
+module.exports = {
+  extends: ["plugin:testing-library/react"],
+  plugins: ["jest", "testing-library"],
+  overrides: [
+    {
+      files: ["**/*.test.ts", "**/*.test.tsx"],
+      extends: ["plugin:jest/recommended"],
+      env: {
+        "jest/globals": true,
+      },
+      rules: {
+        // base overrides
+        "max-nested-callbacks": "off",
+        "no-constructor-return": "off",
+        "no-undef": "off",
+        "promise/always-return": "off",
+        "promise/avoid-new": "off",
+        "promise/catch-or-return": "off",
+        "promise/no-callback-in-promise": "off",
+
+        // rules
+        "max-len": "off",
+        "no-empty-function": "warn",
+        "require-await": "warn",
+        "import/no-unassigned-import": "off",
+        "class-methods-use-this": "off",
+
+        "jest/no-conditional-expect": "error",
+        "jest/no-identical-title": "error",
+        "jest/no-interpolation-in-snapshots": "error",
+        "jest/no-jasmine-globals": "error",
+        "jest/no-mocks-import": "error",
+        "jest/valid-describe-callback": "error",
+        "jest/valid-expect": "error",
+        "jest/valid-expect-in-promise": "error",
+        "jest/valid-title": "warn",
+        "jest/no-hooks": [
+          "error",
+          {
+            allow: ["beforeAll", "beforeEach", "afterAll", "afterEach"],
+          },
+        ],
+
+        "testing-library/await-async-query": "error",
+        "testing-library/await-async-utils": "error",
+        "testing-library/no-await-sync-query": "error",
+        "testing-library/no-container": "error",
+        "testing-library/no-debugging-utils": "error",
+        "testing-library/no-dom-import": ["error", "react"],
+        "testing-library/no-node-access": "error",
+        "testing-library/no-promise-in-fire-event": "error",
+        "testing-library/no-render-in-setup": "error",
+        "testing-library/no-unnecessary-act": "error",
+        "testing-library/no-wait-for-empty-callback": "error",
+        "testing-library/no-wait-for-multiple-assertions": "error",
+        "testing-library/no-wait-for-side-effects": "error",
+        "testing-library/no-wait-for-snapshot": "error",
+        "testing-library/prefer-find-by": "warn",
+        "testing-library/prefer-presence-queries": "error",
+        "testing-library/prefer-query-by-disappearance": "error",
+        "testing-library/prefer-screen-queries": "error",
+        "testing-library/render-result-naming-convention": "error",
+      },
+    },
+  ],
+};

package/typescript.js

@@ -0,0 +1,96 @@
+module.exports = {
+  parser: "@typescript-eslint/parser",
+  overrides: [
+    {
+      files: ["**/*.ts", "**/*.tsx"],
+      plugins: ["@typescript-eslint"],
+      extends: ["plugin:@typescript-eslint/recommended"],
+      parserOptions: {
+        project: "./tsconfig.json",
+      },
+      rules: {
+        // disabled
+        "@typescript-eslint/typedef": "off",
+        "@typescript-eslint/brace-style": "off",
+        "@typescript-eslint/lines-between-class-members": "off",
+        "@typescript-eslint/comma-dangle": "off",
+        "@typescript-eslint/object-curly-spacing": "off",
+        "@typescript-eslint/prefer-readonly-parameter-types": "off",
+        "@typescript-eslint/restrict-template-expressions": "off",
+        "@typescript-eslint/explicit-function-return-type": "off",
+        "@typescript-eslint/no-extra-parens": "off",
+        "@typescript-eslint/no-type-alias": "off",
+        "@typescript-eslint/indent": "off",
+
+        // requires strictNullChecks compiler option
+        "@typescript-eslint/no-unnecessary-condition": "off",
+        "@typescript-eslint/strict-boolean-expressions": "off",
+        "@typescript-eslint/explicit-module-boundary-types": "off",
+
+        "@typescript-eslint/quotes": ["error", "single", { avoidEscape: true }],
+        "@typescript-eslint/no-unnecessary-type-assertion": "error",
+        "@typescript-eslint/consistent-type-assertions": "warn",
+        "@typescript-eslint/no-array-constructor": "warn",
+        "@typescript-eslint/no-redeclare": "warn",
+        "@typescript-eslint/no-use-before-define": [
+          "warn",
+          {
+            functions: false,
+            classes: false,
+            variables: false,
+            typedefs: false,
+          },
+        ],
+        "@typescript-eslint/no-unused-expressions": [
+          "error",
+          {
+            allowShortCircuit: true,
+            allowTernary: true,
+            allowTaggedTemplates: true,
+          },
+        ],
+        "@typescript-eslint/no-unused-vars": [
+          "warn",
+          {
+            args: "none",
+            ignoreRestSiblings: true,
+          },
+        ],
+        "@typescript-eslint/no-magic-numbers": [
+          "warn",
+          {
+            ignore: [0],
+            ignoreArrayIndexes: true,
+            ignoreEnums: true,
+            ignoreNumericLiteralTypes: true,
+            ignoreTypeIndexes: true,
+          },
+        ],
+        "@typescript-eslint/no-useless-constructor": "warn",
+        "@typescript-eslint/consistent-type-imports": "error",
+        "@typescript-eslint/consistent-type-assertions": "warn",
+        "@typescript-eslint/no-array-constructor": "warn",
+        "@typescript-eslint/dot-notation": "warn",
+
+        // disable for tests
+        "@typescript-eslint/init-declarations": "off",
+        "@typescript-eslint/semi": ["error", "always"],
+
+        // extensions (superseded by typescript rules)
+        "init-declarations": "off",
+        "no-use-before-define": "off",
+        "no-useless-constructor": "off",
+        "no-unused-vars": "off",
+        "no-unused-expressions": "off",
+        "no-use-before-define": "off",
+        "no-redeclare": "off",
+        "no-undef": "off",
+        "no-array-constructor": "off",
+        "no-magic-numbers": "off",
+        "space-before-function-paren": "off",
+        "dot-notation": "off",
+      },
+    },
+  ],
+  rules: {},
+};