@rebilly/eslint-config 0.0.3

package/README.md

@@ -0,0 +1,28 @@
+# Rebilly shared eslint configs
+
+These are the shared eslint configs for all Rebilly frontend projects.
+
+Where possible, we should exclusively try to `extend` these configs, and
+avoid adding overrides in our projects. This will keep the projects consistent and
+reduce the difficulty when switching between projects.
+
+## Usage
+
+1. Install the package in the project: `pnpm add -D @rebilly/eslint-config@workspace:*`
+2. Extend the appropriate config in the project's `.eslintrc.js` file:
+
+```js
+module.exports = {
+  root: true,
+  // Which config to extend depends on the project type, see below
+  extends: ["@rebilly/eslint-config/vue"],
+};
+```
+
+## Configs
+
+| Config     | Extend                                | Description                                                                            |
+| ---------- | ------------------------------------- | -------------------------------------------------------------------------------------- |
+| Base       | `@rebilly/eslint-config`            | Base config for all projects, containing generic Javascript and Prettier eslint rules. |
+| Typescript | `@rebilly/eslint-config/typescript` | TypeScript projects.                                                                   |
+| Vue        | `@rebilly/eslint-config/vue`        | Vue projects written in TypeScript.                                                    |

package/index.js

@@ -0,0 +1,58 @@
+const vitest = require('eslint-plugin-vitest');
+
+module.exports = {
+  extends: ['eslint:recommended', 'plugin:cypress/recommended', 'prettier'],
+  env: {
+    es6: true,
+  },
+  parserOptions: {
+    ecmaVersion: 'latest',
+  },
+  rules: {
+    'no-underscore-dangle': [
+      'error',
+      { allow: ['_links', '_embedded', '_dev'] },
+    ],
+    'prettier/prettier': 'error',
+    'no-lonely-if': 'error',
+    'no-implicit-coercion': 'error',
+  },
+  plugins: ['prettier', 'vitest'],
+  globals: {
+    // TODO: remove this and extend from vitest/recommended when there is time to fix the errors.
+    ...vitest.environments.env.globals,
+  },
+  overrides: [
+    {
+      // Config files are usually executed in the node environment, regardless of the project type
+      files: [
+        '.eslintrc.cjs',
+        '.eslintrc.js',
+        'babel.config.js',
+        'cypress.config.js',
+        'vite.config.js',
+      ],
+      env: {
+        node: true,
+      },
+    },
+    {
+      files: ['*.spec.js', '*.spec.ts'],
+      globals: {
+        // We configure vite with globals: true, which adds this global variable
+        // https://vitest.dev/config/#globals
+        global: true,
+      },
+    },
+  ],
+  ignorePatterns: [
+    'node_modules/',
+    'dist/',
+    'typings/',
+    'coverage/',
+    'public/static/',
+    '*.css',
+    '*.svg',
+    '*.min.js',
+  ],
+};

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@rebilly/eslint-config",
+  "description": "Shared ESLint config for Rebilly frontend projects",
+  "author": "Rebilly",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Rebilly/rebilly.git"
+  },
+  "main": "index.js",
+  "version": "0.0.3",
+  "scripts": {
+    "build": "echo 'Building ESLint config'"
+  },
+  "files": [
+    "index.js",
+    "typescript.js",
+    "vue.js"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@typescript-eslint/eslint-plugin": "^7.17.0",
+    "@typescript-eslint/parser": "^7.14.1",
+    "@vue/eslint-config-typescript": "^14.5.0",
+    "eslint": "^8.57.1",
+    "eslint-plugin-cypress": "^3.5.0",
+    "eslint-plugin-vitest": "^0.5.4",
+    "eslint-plugin-vue": "^9.32.0",
+    "vue-eslint-parser": "^10.1.1"
+  },
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^7.17.0",
+    "@typescript-eslint/parser": "^7.14.1",
+    "@vue/eslint-config-typescript": "^14.5.0",
+    "eslint": "^8.57.1",
+    "eslint-plugin-cypress": "^3.5.0",
+    "eslint-plugin-vitest": "^0.5.4",
+    "eslint-plugin-vue": "^9.32.0",
+    "prettier": "^3.1.0",
+    "vue-eslint-parser": "^10.1.1"
+  },
+  "engines": {
+    "node": ">=18.18"
+  }
+}

package/typescript.js

@@ -0,0 +1,34 @@
+module.exports = {
+  extends: ['plugin:@typescript-eslint/recommended', './index.js'],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    parser: '@typescript-eslint/parser',
+    ecmaVersion: 2022,
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint'],
+  rules: {
+    'no-undef': 'off',
+    'no-unused-vars': 'off',
+    '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
+    '@typescript-eslint/ban-ts-comment': [
+      'error',
+      {
+        'ts-ignore': true,
+        'ts-expect-error': 'allow-with-description',
+        'ts-nocheck': 'allow-with-description',
+      },
+    ],
+    '@typescript-eslint/consistent-type-imports': 'error',
+  },
+  overrides: [
+    {
+      files: ['*.ts'],
+      rules: {
+        // It is recommended to turn this rule off for typescript, as it does it's own checking:
+        // https://typescript-eslint.io/linting/troubleshooting#i-get-errors-from-the-no-undef-rule-about-global-variables-not-being-defined-even-though-there-are-no-typescript-errors
+        'no-undef': 'off',
+      },
+    },
+  ],
+};

package/vue.js

@@ -0,0 +1,46 @@
+module.exports = {
+  env: {
+    'vue/setup-compiler-macros': true,
+    browser: true,
+  },
+  extends: ['plugin:vue/vue3-recommended', './typescript.js'],
+  parser: 'vue-eslint-parser',
+  rules: {
+    'vue/require-v-for-key': 'error',
+    'vue/require-prop-types': 'error',
+    'vue/component-tags-order': [
+      'error',
+      {
+        order: ['script', 'template', 'style'],
+      },
+    ],
+    'vue/multi-word-component-names': 'off',
+    // Force lang="ts" in script tags
+    'vue/block-lang': [
+      'error',
+      {
+        script: {
+          lang: 'ts',
+        },
+      },
+    ],
+    'vue/component-api-style': ['error', ['script-setup']],
+  },
+  overrides: [
+    {
+      files: ['*.vue'],
+      rules: {
+        // It is recommended to turn this rule off for typescript, as it does it's own checking:
+        // https://typescript-eslint.io/linting/troubleshooting#i-get-errors-from-the-no-undef-rule-about-global-variables-not-being-defined-even-though-there-are-no-typescript-errors
+        'no-undef': 'off',
+      },
+    },
+    {
+      files: ['*.spec.js', '*.spec.ts'],
+      rules: {
+        // This can throw erroneously in test files, and doesn't apply
+        'vue/one-component-per-file': 'off',
+      },
+    },
+  ],
+};