eslint-plugin-vue-kuzzle 0.0.8

package/README.md

@@ -0,0 +1,48 @@
+# eslint-plugin-vue-kuzzle
+
+Kuzzle Coding Standard for Vue.js.
+
+This plugin is standalone, meaning that `eslint` and `prettier` are included in the package so you don't need to install them yourself.
+
+## Install our coding standard
+
+1) Install the plugin
+
+```sh
+npm i eslint-plugin-vue-kuzzle --save-dev
+```
+
+2) Add `kuzzle` to the plugins section of your `.eslintrc` configuration file and select the default rule set:
+
+```json
+{
+  "extends": [
+    "plugin:vue-kuzzle/defaultt",
+    "plugin:vue-kuzzle/base",
+    "plugin:vue-kuzzle/typescript"
+  ]
+}
+```
+
+3) Remove unused eslint-related dependencies (such as `@vue/eslint-config-standard`, `eslint` etc)
+
+4) Commit relevant files
+
+## Available rule sets
+
+  - `plugin:vue-kuzzle/default`: default combines base and typecript rules sets
+  - `plugin:vue-kuzzle/base`: rules for only Javascript projects
+  - `plugin:vue-kuzzle/typescript`: rules for Typescript projects
+
+You can disable the `import/order` rule on project that are not libraries:
+
+```json
+{
+  "extends": [
+    "plugin:vue-kuzzle/default",
+  ],
+  "rules": {
+    "import/order": ["off"]
+  }
+}
+```

package/lib/configs/base.js

@@ -0,0 +1,12 @@
+const importOptions = require('../importOption');
+
+module.exports = {
+  extends: ['plugin:vue/recommended', '@vue/standard', '@vue/prettier'],
+  rules: {
+    'no-console': ['error', { allow: ['warn', 'error'] }],
+    'no-debugger': 'error',
+    'import/order': ['error', importOptions(['~', '@'])],
+    'prefer-arrow-callback': 'error',
+    'arrow-body-style': ['error', 'as-needed'],
+  },
+};

package/lib/configs/default.js

@@ -0,0 +1,19 @@
+const baseConfig = require('./base');
+const typescriptConfig = require('./typescript');
+
+module.exports = {
+  ...baseConfig,
+  overrides: [
+    {
+      files: ['vite.config.ts'],
+      parserOptions: {
+        parser: '@typescript-eslint/parser',
+      },
+    },
+    {
+      // Apply vue and typescript rules only on Vue SFC and typescript files
+      files: ['src/**/*.{vue,ts}'],
+      ...typescriptConfig,
+    },
+  ],
+};

package/lib/configs/typescript.js

@@ -0,0 +1,45 @@
+module.exports = {
+  parser: 'vue-eslint-parser',
+  parserOptions: {
+    parser: '@typescript-eslint/parser',
+  },
+  extends: [
+    '@vue/typescript/recommended',
+    '@vue/eslint-config-standard-with-typescript',
+    // Need to repeat prettier here to keep rules priority over previous rulesset
+    '@vue/prettier',
+  ],
+  rules: {
+    // Normalize eqeqeq rules in template like in script
+    'vue/eqeqeq': ['error', 'always'],
+    // Force self-closing to improve readability of templates
+    'vue/html-self-closing': [
+      'error',
+      {
+        html: {
+          void: 'any',
+          normal: 'always',
+          component: 'always',
+        },
+        svg: 'always',
+        math: 'always',
+      },
+    ],
+    /**
+     * Force consistent type imports
+     *
+     * @see https://typescript-eslint.io/blog/consistent-type-imports-and-exports-why-and-how/
+     */
+    '@typescript-eslint/consistent-type-imports': [
+      'error',
+      {
+        disallowTypeAnnotations: true,
+        fixStyle: 'inline-type-imports',
+        prefer: 'type-imports',
+      },
+    ],
+    '@typescript-eslint/no-import-type-side-effects': 'error',
+    // Normalize methode signature style
+    '@typescript-eslint/method-signature-style': 'error',
+  },
+};

package/lib/importOption.js

@@ -0,0 +1,27 @@
+// ? Eslint plugin rules are not applicable for this function, because it's not a code of eslint rule
+/* eslint-disable eslint-plugin/prefer-message-ids, eslint-plugin/prefer-object-rule, eslint-plugin/require-meta-type, eslint-plugin/require-meta-schema */
+module.exports = (alias) => {
+  const aliases = Array.isArray(alias) ? alias : [alias];
+
+  return {
+    groups: ['builtin', 'external', 'parent', 'sibling'],
+    pathGroups: [
+      { pattern: 'vue', group: 'external', position: 'before' },
+      // ? Patterns should be sorting of more precise to more generic
+      ...aliases.map((alias) => ({ pattern: `${alias}/**/*.vue`, group: 'sibling' })),
+      { pattern: './**/*.vue', group: 'sibling', position: 'after' },
+      ...aliases.map((alias) => ({ pattern: `${alias}/**/*`, group: 'parent' })),
+      { pattern: './**/*', group: 'parent', position: 'after' },
+    ],
+    /**
+     * ? Particular case: need to exclude `vue` of external import group to can be sorted with pattern
+     * @see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/order.md#pathgroupsexcludedimporttypes-array
+     */
+    pathGroupsExcludedImportTypes: ['vue'],
+    'newlines-between': 'always',
+    distinctGroup: false,
+    alphabetize: {
+      order: 'asc',
+    },
+  };
+};

package/lib/index.js

@@ -0,0 +1,7 @@
+module.exports = {
+  configs: {
+    default: require('./configs/default'),
+    base: require('./configs/base'),
+    typescript: require('./configs/typescript'),
+  },
+};

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "eslint-plugin-vue-kuzzle",
+  "version": "0.0.8",
+  "description": "Kuzzle Vue Coding Standard",
+  "homepage": "https://github.com/kuzzleio/eslint-plugin-kuzzle",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/kuzzleio/eslint-plugin-kuzzle.git",
+    "directory": "packages/frontend"
+  },
+  "keywords": [
+    "eslint",
+    "eslint-plugin",
+    "vue",
+    "kuzzle"
+  ],
+  "author": "The Kuzzle Team",
+  "main": "lib/index.js",
+  "scripts": {
+    "lint": "eslint lib"
+  },
+  "dependencies": {
+    "@vue/eslint-config-prettier": "8.0.*",
+    "@vue/eslint-config-standard": "8.0.*",
+    "@vue/eslint-config-standard-with-typescript": "8.0.*",
+    "@vue/eslint-config-typescript": "11.0.*"
+  },
+  "devDependencies": {
+    "eslint-plugin-eslint-plugin": "^5.0.6"
+  },
+  "license": "Apache 2",
+  "files": [
+    "lib/",
+    "README.md",
+    "package.json"
+  ],
+  "exports": {
+    ".": "./lib/index.js",
+    "./importOption": "./lib/importOption.js"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  }
+}