@commercetools-backend/eslint-config-node 0.0.0-canary-20220329132038

package/CHANGELOG.md

@@ -0,0 +1,19 @@
+# @commercetools-backend/eslint-config-node
+
+## 0.0.0-canary-20220329132038
+
+### Minor Changes
+
+- [#2527](https://github.com/commercetools/merchant-center-application-kit/pull/2527) [`a6be74b0`](https://github.com/commercetools/merchant-center-application-kit/commit/a6be74b06223544e7ddae8bb71e3bac380b352f2) Thanks [@emmenko](https://github.com/emmenko)! - Add new ESLint config for Node.js projects. It includes TypeScript support.
+
+  ```bash
+  $ yarn add eslint @commercetools-backend/eslint-config-node
+  ```
+
+  ```js
+  // .eslintrc.js
+
+  module.exports = {
+    extends: ['@commercetools-backend/eslint-config-node'],
+  };
+  ```

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 commercetools GmbH
+
+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,25 @@
+# @commercetools-backend/eslint-config-node
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@commercetools-backend/eslint-config-node"><img src="https://badgen.net/npm/v/@commercetools-backend/eslint-config-node" alt="Latest release (latest dist-tag)" /></a> <a href="https://www.npmjs.com/package/@commercetools-backend/eslint-config-node"><img src="https://badgen.net/npm/v/@commercetools-backend/eslint-config-node/next" alt="Latest release (next dist-tag)" /></a> <a href="https://bundlephobia.com/result?p=@commercetools-backend/eslint-config-node"><img src="https://badgen.net/bundlephobia/minzip/@commercetools-backend/eslint-config-node" alt="Minified + GZipped size" /></a> <a href="https://github.com/commercetools/merchant-center-application-kit/blob/main/LICENSE"><img src="https://badgen.net/github/license/commercetools/merchant-center-application-kit" alt="GitHub license" /></a>
+</p>
+
+ESLint config for Node.js projects.
+
+## Install
+
+```bash
+$ npm install --save @commercetools-backend/eslint-config-node
+
+$ npx install-peerdeps --dev @commercetools-backend/eslint-config-node
+```
+
+## Usage
+
+```js
+// .eslintrc.js
+
+module.exports = {
+  extends: ['@commercetools-backend/eslint-config-node'],
+};
+```

package/helpers/eslint.js

@@ -0,0 +1,8 @@
+const statusCode = {
+  error: 'error',
+  warn: 'warn',
+  off: 'off',
+};
+const allSupportedExtensions = ['.js', '.mjs', '.cjs', '.ts'];
+
+module.exports = { statusCode, allSupportedExtensions };

package/index.js

@@ -0,0 +1,221 @@
+// This is a workaround for https://github.com/eslint/eslint/issues/3458
+require('@rushstack/eslint-patch/modern-module-resolution');
+
+const { statusCode, allSupportedExtensions } = require('./helpers/eslint');
+
+/**
+ * @type {import("eslint").Linter.Config}
+ */
+module.exports = {
+  root: true,
+
+  parser: '@babel/eslint-parser',
+
+  parserOptions: {
+    sourceType: 'module',
+    requireConfigFile: false,
+    /**
+     * @type {import('@babel/core').TransformOptions}
+     */
+    babelOptions: {
+      presets: [['@babel/preset-env', { targets: { node: 'current' } }]],
+    },
+  },
+
+  env: {
+    browser: false,
+    commonjs: true,
+    es6: true,
+    jest: true,
+    node: true,
+  },
+
+  extends: [
+    'eslint:recommended',
+    // https://github.com/mysticatea/eslint-plugin-node
+    'plugin:node/recommended',
+    // https://github.com/benmosher/eslint-plugin-import
+    'plugin:import/errors',
+    'plugin:import/warnings',
+    // https://github.com/jest-community/eslint-plugin-jest
+    'plugin:jest/recommended',
+    // NOTE: this should go last.
+    'prettier',
+  ],
+
+  plugins: [
+    // https://github.com/import-js/eslint-plugin-import
+    'import',
+    // https://github.com/jest-community/eslint-plugin-jest
+    'jest',
+    // https://github.com/prettier/prettier-eslint
+    'prettier',
+  ],
+
+  settings: {
+    'import/resolver': {
+      node: {
+        extensions: allSupportedExtensions,
+      },
+    },
+  },
+
+  rules: {
+    // Nodejs
+    'node/no-missing-import': statusCode.off,
+    'node/no-unsupported-features/es-syntax': statusCode.off,
+
+    // NOTE: The regular rule does not support do-expressions. The equivalent rule of babel does.
+    'no-unused-expressions': statusCode.off,
+
+    // Imports
+    'import/extensions': [
+      statusCode.error,
+      {
+        js: 'never',
+        jsx: 'never',
+        ts: 'never',
+        tsx: 'never',
+        mjs: 'never',
+        json: 'always',
+        svg: 'always',
+        graphql: 'always',
+      },
+    ],
+    'import/default': statusCode.off,
+    'import/first': statusCode.error,
+    // TODO: enable this once there is support for `import type`
+    // 'import/order': statusCode.error,
+    'import/named': statusCode.off,
+    'import/namespace': statusCode.off,
+    'import/no-extraneous-dependencies': statusCode.off,
+    'import/no-named-as-default': statusCode.off,
+    'import/no-named-as-default-member': statusCode.off,
+    'import/no-unresolved': statusCode.error,
+
+    // Jest
+    'jest/expect-expect': statusCode.off,
+    'jest/no-identical-title': statusCode.warn,
+    'jest/no-focused-tests': statusCode.error,
+  },
+
+  overrides: [
+    {
+      files: ['*.{spec,test}.*'],
+      env: {
+        'jest/globals': true,
+      },
+      rules: {
+        'node/no-extraneous-require': [
+          statusCode.error,
+          {
+            allowModules: ['jest-each', 'msw'],
+          },
+        ],
+        // https://github.com/jest-community/eslint-plugin-jest
+        'jest/no-conditional-expect': statusCode.error,
+        'jest/no-identical-title': statusCode.error,
+        'jest/no-interpolation-in-snapshots': statusCode.error,
+        'jest/no-jasmine-globals': statusCode.error,
+        'jest/no-jest-import': statusCode.error,
+        'jest/no-mocks-import': statusCode.error,
+        'jest/valid-describe-callback': statusCode.error,
+        'jest/valid-expect': statusCode.error,
+        'jest/valid-expect-in-promise': statusCode.error,
+        'jest/valid-title': statusCode.warn,
+      },
+    },
+    {
+      files: ['**/*.ts?(x)'],
+      parser: '@typescript-eslint/parser',
+      parserOptions: {
+        ecmaVersion: 2022,
+        sourceType: 'module',
+        // typescript-eslint specific options
+        warnOnUnsupportedTypeScriptVersion: true,
+        /**
+         * @type {import('@babel/core').TransformOptions}
+         */
+        babelOptions: {
+          presets: [
+            ['@babel/preset-env', { targets: { node: 'current' } }],
+            ['@babel/preset-typescript'],
+          ],
+        },
+      },
+      plugins: ['@typescript-eslint'],
+      rules: {
+        // TypeScript's `noFallthroughCasesInSwitch` option is more robust (#6906)
+        'default-case': statusCode.off,
+        // 'tsc' already handles this (https://github.com/typescript-eslint/typescript-eslint/issues/291)
+        'no-dupe-class-members': statusCode.off,
+        // 'tsc' already handles this (https://github.com/typescript-eslint/typescript-eslint/issues/477)
+        'no-undef': statusCode.off,
+
+        // Add TypeScript specific rules (and turn off ESLint equivalents)
+        '@typescript-eslint/consistent-type-assertions': statusCode.warn,
+        'no-array-constructor': statusCode.off,
+        '@typescript-eslint/no-array-constructor': statusCode.warn,
+        'no-redeclare': statusCode.off,
+        '@typescript-eslint/no-redeclare': statusCode.warn,
+        'no-use-before-define': statusCode.off,
+        '@typescript-eslint/no-use-before-define': [
+          statusCode.error,
+          {
+            functions: false,
+            classes: false,
+            variables: false,
+            typedefs: false,
+          },
+        ],
+        'no-unused-expressions': statusCode.off,
+        '@typescript-eslint/no-unused-expressions': [
+          statusCode.error,
+          {
+            allowShortCircuit: true,
+            allowTernary: true,
+            allowTaggedTemplates: true,
+          },
+        ],
+        'no-unused-vars': statusCode.off,
+        '@typescript-eslint/no-unused-vars': [
+          statusCode.warn,
+          {
+            args: 'none',
+            ignoreRestSiblings: true,
+          },
+        ],
+        'no-useless-constructor': statusCode.off,
+        '@typescript-eslint/no-useless-constructor': statusCode.warn,
+
+        // TypeScript
+        '@typescript-eslint/ban-types': statusCode.off,
+        '@typescript-eslint/naming-convention': statusCode.off,
+        '@typescript-eslint/consistent-type-definitions': statusCode.off,
+        '@typescript-eslint/no-explicit-any': statusCode.error,
+        '@typescript-eslint/no-var-requires': statusCode.off,
+        '@typescript-eslint/unbound-method': statusCode.off,
+        '@typescript-eslint/ban-ts-comment': statusCode.off,
+        '@typescript-eslint/explicit-function-return-type': statusCode.off,
+        '@typescript-eslint/explicit-member-accessibility': [
+          statusCode.error,
+          { accessibility: 'no-public' },
+        ],
+        '@typescript-eslint/no-require-imports': statusCode.off,
+        '@typescript-eslint/promise-function-async': statusCode.off,
+      },
+      settings: {
+        'import/parsers': {
+          '@typescript-eslint/parser': allSupportedExtensions,
+        },
+        'import/resolver': {
+          'eslint-import-resolver-typescript': true,
+          typescript: {},
+          node: {
+            extensions: allSupportedExtensions,
+          },
+        },
+      },
+    },
+  ],
+};

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@commercetools-backend/eslint-config-node",
+  "version": "0.0.0-canary-20220329132038",
+  "description": "ESLint config for Node.js projects.",
+  "bugs": "https://github.com/commercetools/merchant-center-application-kit/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/commercetools/merchant-center-application-kit.git",
+    "directory": "packages-backend/eslint-config-node"
+  },
+  "homepage": "https://docs.commercetools.com/custom-applications",
+  "keywords": [
+    "javascript",
+    "nodejs",
+    "toolkit",
+    "eslint"
+  ],
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@babel/core": "^7.17.8",
+    "@babel/eslint-parser": "^7.17.0",
+    "@babel/preset-env": "^7.16.11",
+    "@babel/preset-typescript": "^7.16.7",
+    "@rushstack/eslint-patch": "^1.1.1",
+    "@typescript-eslint/eslint-plugin": "^5.16.0",
+    "@typescript-eslint/parser": "^5.16.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-import-resolver-typescript": "^2.7.0",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-jest": "^25.7.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^4.0.0"
+  },
+  "peerDependencies": {
+    "eslint": "8.x"
+  },
+  "devDependencies": {
+    "eslint": "8.11.0"
+  },
+  "engines": {
+    "node": ">=14"
+  }
+}