@boehringer-ingelheim/eslint-config 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Boehringer Ingelheim
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,193 @@
+# ESLint Configuration
+
+> ESLint statically analyzes your code to quickly find problems. It is built into most text editors and you can run ESLint as part of your continuous integration pipeline. - <https://eslint.org/>
+
+This is the shared ESLint configuration used at [Boehringer Ingelheim](https://github.com/orgs/Boehringer-Ingelheim) for code styling.
+
+[![npm version](https://img.shields.io/npm/v/@boehringer-ingelheim/eslint-config?style=for-the-badge)](https://www.npmjs.com/package/@boehringer-ingelheim/eslint-config)
+[![npm downloads](https://img.shields.io/npm/dm/@boehringer-ingelheim/eslint-config?style=for-the-badge)](https://www.npmjs.com/package/@boehringer-ingelheim/eslint-config)
+[![License: Apache-2.0](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)](https://github.com/boehringer-ingelheim/eslint-config/blob/master/LICENSE)
+[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg?style=for-the-badge)](https://github.com/boehringer-ingelheim/eslint-config/graphs/commit-activity)
+[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-green.svg?logo=conventional-commits&style=for-the-badge)](https://conventionalcommits.org)
+[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-494949?logo=semantic-release&style=for-the-badge)](https://github.com/semantic-release/semantic-release)
+
+## Usage
+
+### Install the package
+
+```sh
+npm install --save-dev @boehringer-ingelheim/eslint-config
+```
+
+### Add the configuration
+
+Create or update the `.eslintrc.js` file in your projects root directory accordingly.
+
+```js
+module.exports = {
+  extends: ["@boehringer-ingelheim/eslint-config/base/strict"],
+};
+```
+
+#### Extend or Override configuration
+
+This is not recommended as the goal is to have similar code stylings in all projects, but if for some reason you need to add or change the configuration, it is possible in the following way:
+
+```js
+module.exports = {
+  extends: ["@boehringer-ingelheim/eslint-config/base/strict"],
+  rules: {
+    "no-empty-function": "off",
+  },
+};
+```
+
+More Information: [ESLint - Configuration Files
+](https://eslint.org/docs/latest/use/configure/configuration-files#extending-configuration-files)
+
+### Run
+
+```sh
+npx eslint .
+```
+
+## Shared Configurations
+
+Opinionated Options that differ from the standard/recommended eslint configurations.
+
+### `@boehringer-ingelheim/eslint-config/base`
+
+```js
+module.exports = {
+  extends: ["@boehringer-ingelheim/eslint-config/base"],
+};
+```
+
+This shared ESLint configuration is set up for TypeScript projects that adhere to modern JavaScript standards. It uses the latest version of TypeScript (ES2022) and extends several plugins and recommended rules to enforce best practices and catch potential errors.
+
+The following plugins are used in this configuration:
+
+- [`@typescript-eslint/eslint-plugin`](https://typescript-eslint.io/rules/)
+- [`eslint-plugin-import`](https://github.com/import-js/eslint-plugin-import)
+- [`eslint-plugin-sonarjs`](https://github.com/SonarSource/eslint-plugin-sonarjs)
+
+Additionally, the [`eslint-plugin-sort-keys-plus`](https://github.com/forivall/eslint-plugin-sort-keys-plus) is used to automatically fix sorting issues.
+
+This configuration also sets up the TypeScript parser [`@typescript-eslint/parser`](https://typescript-eslint.io/architecture/parser) and [`eslint-import-resolver-typescript`](https://github.com/import-js/eslint-import-resolver-typescript). The TypeScript project file `./tsconfig.json` is set as default value for the project option in the parser configuration. If this is not the case, this must be changed accordingly:
+
+```js
+module.exports = {
+  parserOptions: {
+    // Use `tsconfing.dev.json` as typescript project configuration, see: https://typescript-eslint.io/architecture/parser/#project
+    project: "./tsconfig.dev.json",
+  },
+};
+```
+
+### `@boehringer-ingelheim/eslint-config/base/strict`
+
+```js
+module.exports = {
+  extends: ["@boehringer-ingelheim/eslint-config/base/strict"],
+};
+```
+
+This shared ESLint configuration extends the `@boehringer-ingelheim/eslint-config/base` configuration and adds additional strict linting rules from the `@typescript-eslint/eslint-plugin` plugin. These strict rules aim to enforce a high standard of code quality and improve code maintainability.
+
+### `@boehringer-ingelheim/eslint-config/react`
+
+```js
+module.exports = {
+  extends: ["@boehringer-ingelheim/eslint-config/base/strict", "@boehringer-ingelheim/eslint-config/react"],
+};
+```
+
+This shared ESLint configuration is specifically tailored for [React](https://reactjs.org/) projects, and extends `@boehringer-ingelheim/eslint-config/base`. It uses the browser environment, and includes recommended configurations for the following plugins: jsx-a11y, react, and react-hooks.
+
+- [`eslint-plugin-jsx-a11y`](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y)
+- [`eslint-plugin-react`](https://github.com/jsx-eslint/eslint-plugin-react)
+- [`eslint-plugin-react-hooks`](https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks)
+
+The configuration sets several custom rules, including `@typescript-eslint/ban-types` and `@typescript-eslint/consistent-type-definitions`, as well as rules for organizing and formatting import statements.
+
+### `@boehringer-ingelheim/eslint-config/playwright`
+
+```js
+module.exports = {
+  extends: ["@boehringer-ingelheim/eslint-config/base/strict", "@boehringer-ingelheim/eslint-config/playwright"],
+};
+```
+
+This shared ESLint configuration is designed to enforce best practices and recommendations when writing tests with Playwright. It extends the [`eslint-plugin-playwright`](https://github.com/playwright-community/eslint-plugin-playwright) configuration and adds the following rules:
+
+- [`playwright/prefer-to-be`](https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/prefer-to-be.md): enforces the use of `.toBe()` instead of `.toEqual()` when testing for equality.
+- [`playwright/prefer-to-have-length`](https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/prefer-to-have-length.md): enforces the use of `.toHaveLength()` instead of `.toEqual(n)` when testing the length of an object.
+- [`playwright/require-top-level-describe`](https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/require-top-level-describe.md): requires tests to be organized into top-level `describe()` blocks.
+
+## Local Development
+
+### Install Dependencies
+
+```sh
+npm install
+```
+
+### Test
+
+```sh
+npm test
+```
+
+### Repair
+
+This command may be useful when obscure errors or issues are encountered. It removes and recreates dependencies of your project.
+
+```sh
+npm run repair
+```
+
+### Release
+
+Fully automated version management and package publishing via [semantic-release](https://github.com/semantic-release). It bumps the version according to conventional commits, publishes the package to npm and release a new version to GitHub.
+
+#### Automatic Release (GitHub Action) [Recommended]
+
+Make sure that the secrets `GITHUB_TOKEN` and `NPM_TOKEN` are available in GitHub repository.
+
+```sh
+npm run release:ci
+```
+
+#### Manual Release
+
+Make sure that the environment variables `GITHUB_TOKEN` and `NPM_TOKEN` are set or declared in `.env` and a productive build was previously created via `npm run build`.
+
+```sh
+npm run release
+```
+
+## Roadmap
+
+- [ ] Shared configuration: Angular
+- [ ] Shared configuration: Node.js
+- [ ] Test Cases
+- [ ] "[Flat](https://eslint.org/docs/latest/use/configure/configuration-files-new)" Config
+
+## Show your support
+
+Give a ⭐️ if this project helped you!
+
+## License
+
+Copyright © 2023 [Boehringer Ingelheim](https://github.com/boehringer-ingelheim).<br />
+This project is [MIT](https://github.com/boehringer-ingelheim/eslint-config/blob/master/LICENSE) licensed.
+
+## Resources
+
+- <https://eslint.org/>
+- <https://typescript-eslint.io/>
+- <https://react-typescript-cheatsheet.netlify.app/>
+- <https://prettier.io/>
+- <https://conventionalcommits.org/en/v1.0.0/>
+- <https://semantic-release.gitbook.io/>
+- <https://semver.org/>

package/base/index.js

@@ -0,0 +1,106 @@
+/**
+ * Workaround to allow ESLint to resolve plugins that were installed
+ * by an external config, see https://github.com/eslint/eslint/issues/3458.
+ */
+require("@rushstack/eslint-patch/modern-module-resolution");
+
+/** @type {import('eslint').ESLint.ConfigData & { parserOptions: import('eslint').ESLint.ConfigData & import('@typescript-eslint/parser').ParserOptions } }  */
+module.exports = {
+  env: {
+    es2022: true,
+  },
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:@typescript-eslint/recommended-requiring-type-checking",
+    "plugin:import/recommended",
+    "plugin:import/typescript",
+    "plugin:sonarjs/recommended",
+  ],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    project: "./tsconfig.json",
+  },
+  plugins: ["@typescript-eslint", "sonarjs", "sort-keys-plus"],
+  rules: {
+    // @typescript-eslint: https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/eslint-plugin/docs/rules
+    "@typescript-eslint/no-floating-promises": ["error", { ignoreVoid: true }],
+    "@typescript-eslint/no-misused-promises": [
+      "error",
+      {
+        checksVoidReturn: false,
+      },
+    ],
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      {
+        argsIgnorePattern: "^_",
+        caughtErrorsIgnorePattern: "^_",
+        varsIgnorePattern: "^_",
+      },
+    ],
+    "@typescript-eslint/sort-type-constituents": "error",
+
+    // eslint: https://github.com/eslint/eslint/tree/main/lib/rules
+    "arrow-body-style": ["error", "as-needed"],
+    camelcase: "warn",
+    curly: "error",
+    "default-case": "error",
+    "dot-notation": ["error", { allowPattern: "^[a-z]+(_[a-z]+)+$" }],
+    eqeqeq: "error",
+    "logical-assignment-operators": ["error", "never"],
+    "no-console": ["warn", { allow: ["warn", "error"] }],
+    "no-else-return": ["error", { allowElseIf: false }],
+    "no-empty-function": "error",
+    "no-lonely-if": "error",
+    "no-negated-condition": "error",
+    "no-nested-ternary": "error",
+    "no-plusplus": ["error", { allowForLoopAfterthoughts: true }],
+    "no-unneeded-ternary": "error",
+    "no-useless-concat": "error",
+    "operator-assignment": ["error", "never"],
+    "prefer-const": "error",
+    "prefer-rest-params": "error",
+    "prefer-template": "error",
+
+    // eslint-plugin-import: https://github.com/import-js/eslint-plugin-import/tree/main/docs/rules
+    "import/no-cycle": "error",
+    "import/no-unused-modules": [
+      "error",
+      {
+        missingExports: true,
+        src: ["."],
+        unusedExports: true,
+      },
+    ],
+    "import/order": [
+      "error",
+      {
+        alphabetize: {
+          caseInsensitive: true,
+          order: "asc",
+          orderImportKind: "asc",
+        },
+      },
+    ],
+    "import/prefer-default-export": "off",
+
+    /**
+     * Required to fix sort-keys automatically, since this is not done by default.
+     * See: https://github.com/forivall/eslint-plugin-sort-keys-plus
+     */
+    "sort-keys-plus/sort-keys": [
+      "error",
+      "asc",
+      {
+        caseSensitive: false,
+        natural: true,
+      },
+    ],
+  },
+  settings: {
+    "import/resolver": {
+      typescript: true,
+    },
+  },
+};

package/base/strict.js

@@ -0,0 +1,10 @@
+/**
+ * Workaround to allow ESLint to resolve plugins that were installed
+ * by an external config, see https://github.com/eslint/eslint/issues/3458.
+ */
+require("@rushstack/eslint-patch/modern-module-resolution");
+
+/** @type {import('eslint').ESLint.ConfigData}  */
+module.exports = {
+  extends: ["./index.js", "plugin:@typescript-eslint/strict"],
+};

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@boehringer-ingelheim/eslint-config",
+  "version": "1.0.0",
+  "description": "Shared eslint configuration used at Boehringer Ingelheim for code styling",
+  "keywords": [
+    "boehringer",
+    "boehringer-ingelheim",
+    "config",
+    "configuration",
+    "eslint",
+    "eslintrc",
+    "eslint-config",
+    "linter"
+  ],
+  "license": "MIT",
+  "files": [
+    "base",
+    "react",
+    "playwright"
+  ],
+  "main": "base/index.js",
+  "scripts": {
+    "prepare": "husky install && chmod ug+x .husky/*",
+    "release": "dotenv -- semantic-release --no-ci",
+    "release:ci": "semantic-release",
+    "repair": "npx --no rimraf .git/hooks node_modules package-lock.json && npm install"
+  },
+  "peerDependencies": {
+    "eslint": "8"
+  },
+  "dependencies": {
+    "@rushstack/eslint-patch": "1.2.0",
+    "@typescript-eslint/eslint-plugin": "5.51.0",
+    "@typescript-eslint/parser": "5.51.0",
+    "eslint-import-resolver-typescript": "3.5.3",
+    "eslint-plugin-import": "2.27.5",
+    "eslint-plugin-jsx-a11y": "6.7.1",
+    "eslint-plugin-playwright": "0.12.0",
+    "eslint-plugin-react": "7.32.2",
+    "eslint-plugin-react-hooks": "4.6.0",
+    "eslint-plugin-sonarjs": "0.18.0",
+    "eslint-plugin-sort-keys-plus": "1.3.1"
+  },
+  "devDependencies": {
+    "@boehringer-ingelheim/prettier-config": "1.0.0",
+    "@commitlint/cli": "17.4.2",
+    "@commitlint/config-conventional": "17.4.2",
+    "@commitlint/types": "17.4.0",
+    "@semantic-release/changelog": "6.0.2",
+    "@semantic-release/git": "10.0.1",
+    "dotenv-cli": "7.0.0",
+    "husky": "8.0.3",
+    "prettier": "2.8.3",
+    "semantic-release": "20.1.0"
+  }
+}

package/playwright/index.js

@@ -0,0 +1,16 @@
+/**
+ * Workaround to allow ESLint to resolve plugins that were installed
+ * by an external config, see https://github.com/eslint/eslint/issues/3458.
+ */
+require("@rushstack/eslint-patch/modern-module-resolution");
+
+/** @type {import('eslint').ESLint.ConfigData}  */
+module.exports = {
+  extends: ["plugin:playwright/playwright-test"],
+  rules: {
+    // eslint-plugin-playwright: https://github.com/playwright-community/eslint-plugin-playwright
+    "playwright/prefer-to-be": "error",
+    "playwright/prefer-to-have-length": "error",
+    "playwright/require-top-level-describe": "error",
+  },
+};

package/react/index.js

@@ -0,0 +1,84 @@
+/**
+ * Workaround to allow ESLint to resolve plugins that were installed
+ * by an external config, see https://github.com/eslint/eslint/issues/3458.
+ */
+require("@rushstack/eslint-patch/modern-module-resolution");
+
+/** @type {import('eslint').ESLint.ConfigData & { parserOptions: import('eslint').ESLint.ConfigData & import('@typescript-eslint/parser').ParserOptions } }  */
+module.exports = {
+  env: {
+    browser: true,
+  },
+  extends: ["../base/index.js", "plugin:jsx-a11y/recommended", "plugin:react/recommended", "plugin:react/jsx-runtime"],
+  parserOptions: {
+    ecmaFeatures: {
+      jsx: true,
+    },
+    ecmaVersion: "latest",
+    sourceType: "module",
+  },
+  plugins: ["jsx-a11y", "react", "react-hooks"],
+  rules: {
+    // @typescript-eslint: https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/eslint-plugin/docs/rules
+    "@typescript-eslint/ban-types": [
+      "error",
+      {
+        types: {
+          "React.FC": {
+            message:
+              "Please use object type destructure declaration, see: https://react-typescript-cheatsheet.netlify.app/docs/basic/getting-started/function_components",
+          },
+          "React.FunctionalComponent": {
+            message:
+              "Please use object type destructure declaration, see: https://react-typescript-cheatsheet.netlify.app/docs/basic/getting-started/function_components",
+          },
+        },
+      },
+    ],
+    "@typescript-eslint/consistent-type-definitions": ["error", "type"],
+
+    // eslint-plugin-import: https://github.com/import-js/eslint-plugin-import/tree/main/docs/rules
+    "import/order": [
+      "error",
+      {
+        alphabetize: {
+          caseInsensitive: true,
+          order: "asc",
+          orderImportKind: "asc",
+        },
+        pathGroups: [
+          {
+            group: "external",
+            pattern: "react",
+            position: "before",
+          },
+        ],
+        pathGroupsExcludedImportTypes: ["react"],
+      },
+    ],
+
+    // eslint-plugin-react: https://github.com/jsx-eslint/eslint-plugin-react/tree/master/lib/rules
+    "react/jsx-pascal-case": "error",
+    "react/jsx-sort-props": [
+      "error",
+      {
+        callbacksLast: true,
+        ignoreCase: true,
+        noSortAlphabetically: false,
+        reservedFirst: true,
+        shorthandFirst: false,
+        shorthandLast: false,
+      },
+    ],
+    "react/sort-default-props": "error",
+
+    // eslint-plugin-react-hooks: https://github.com/facebook/react/blob/main/packages/eslint-plugin-react-hooks/README.md
+    "react-hooks/exhaustive-deps": "error",
+    "react-hooks/rules-of-hooks": "error",
+  },
+  settings: {
+    react: {
+      version: "detect",
+    },
+  },
+};