From 4311cb8e40941329672e221e5a39733ac98d1fae Mon Sep 17 00:00:00 2001 From: Ferdinand Thiessen Date: Tue, 25 May 2021 21:03:28 +0200 Subject: [PATCH] Added eslint for linting --- .eslintignore | 2 ++ .eslintrc.js | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++ package.json | 18 ++++++++----- tsconfig.json | 2 +- 4 files changed, 89 insertions(+), 8 deletions(-) create mode 100644 .eslintignore create mode 100644 .eslintrc.js diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 0000000..e06d000 --- /dev/null +++ b/.eslintignore @@ -0,0 +1,2 @@ +/node_modules +.* \ No newline at end of file diff --git a/.eslintrc.js b/.eslintrc.js new file mode 100644 index 0000000..ab9cd5e --- /dev/null +++ b/.eslintrc.js @@ -0,0 +1,75 @@ +const { resolve } = require('path'); +module.exports = { + // https://eslint.org/docs/user-guide/configuring#configuration-cascading-and-hierarchy + // This option interrupts the configuration hierarchy at this file + // Remove this if you have an higher level ESLint config file (it usually happens into a monorepos) + root: true, + + // https://eslint.vuejs.org/user-guide/#how-to-use-custom-parser + // Must use parserOptions instead of "parser" to allow vue-eslint-parser to keep working + // `parser: 'vue-eslint-parser'` is already included with any 'plugin:vue/**' config and should be omitted + parserOptions: { + // https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/parser#configuration + // https://github.com/TypeStrong/fork-ts-checker-webpack-plugin#eslint + // Needed to make the parser take into account 'vue' files + extraFileExtensions: ['.vue'], + parser: '@typescript-eslint/parser', + project: resolve(__dirname, './tsconfig.json'), + tsconfigRootDir: __dirname, + ecmaVersion: 2019, // Allows for the parsing of modern ECMAScript features + sourceType: 'module' // Allows for the use of imports + }, + + env: { + browser: true + }, + + // Rules order is important, please avoid shuffling them + extends: [ + // Base ESLint recommended rules + // 'eslint:recommended', + + // https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin#usage + // ESLint typescript rules + 'plugin:@typescript-eslint/recommended', + // consider disabling this class of rules if linting takes too long + 'plugin:@typescript-eslint/recommended-requiring-type-checking', + + // Uncomment any of the lines below to choose desired strictness, + // but leave only one uncommented! + // See https://eslint.vuejs.org/rules/#available-rules + // 'plugin:vue/vue3-essential', // Priority A: Essential (Error Prevention) + // 'plugin:vue/vue3-strongly-recommended', // Priority B: Strongly Recommended (Improving Readability) + 'plugin:vue/vue3-recommended', // Priority C: Recommended (Minimizing Arbitrary Choices and Cognitive Overhead) + + // https://github.com/prettier/eslint-config-prettier#installation + // usage with Prettier, provided by 'eslint-config-prettier'. + 'prettier', //'plugin:prettier/recommended' + ], + + plugins: [ + // required to apply rules which need type information + '@typescript-eslint', + + // https://eslint.vuejs.org/user-guide/#why-doesn-t-it-work-on-vue-file + // required to lint *.vue files + 'vue', + + // https://github.com/typescript-eslint/typescript-eslint/issues/389#issuecomment-509292674 + // Prettier has not been included as plugin to avoid performance impact + // add it as an extension for your IDE + ], + + // add your custom rules here + rules: { + 'prefer-promise-reject-errors': 'off', + + // TypeScript + quotes: ['warn', 'single', { avoidEscape: true }], + '@typescript-eslint/explicit-function-return-type': 'off', + '@typescript-eslint/explicit-module-boundary-types': 'off', + + // allow debugger during development only + 'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off' + } +} diff --git a/package.json b/package.json index 65acf32..0a070d6 100644 --- a/package.json +++ b/package.json @@ -14,21 +14,25 @@ "url": "https://flaschengeist.dev/Flaschengeist/flaschengeist-users" }, "main": "src/index.ts", - "types": "src/index.ts", "scripts": { - "valid": "tsc --noEmit", - "pretty": "prettier --config ./package.json --write '{,!(node_modules)/**/}*.ts'" + "pretty": "prettier --config ./package.json --write '{,!(node_modules)/**/}*.ts'", + "lint": "eslint --ext .js,.ts,.vue ./src" }, "devDependencies": { + "@flaschengeist/types": "git+https://flaschengeist.dev/ferfissimo/flaschengeist-types.git#develop", + "@quasar/app": "^3.0.0-beta.25", + "@typescript-eslint/eslint-plugin": "^4.24.0", + "@typescript-eslint/parser": "^4.24.0", + "eslint": "^7.26.0", + "eslint-config-prettier": "^8.3.0", + "eslint-plugin-vue": "^7.9.0", "prettier": "^2.3.0", + "quasar": "^2.0.0-beta.17", "typescript": "^4.2.4" }, "peerDependencies": { "@flaschengeist/types": "^1.0.0-alpha.1", - "@flaschengeist/api": "^1.0.0-alpha.1", - "pinia": "^2.0.0-alpha.18", - "quasar": "^2.0.0-beta.17", - "@quasar/app": "^3.0.0-beta.25" + "@flaschengeist/api": "^1.0.0-alpha.1" }, "prettier": { "singleQuote": true, diff --git a/tsconfig.json b/tsconfig.json index eb38103..2fc2c80 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -2,7 +2,7 @@ "extends": "@quasar/app/tsconfig-preset", "target": "esnext", "compilerOptions": { - "baseUrl": "src/", + "baseUrl": "src", "lib": [ "es2020", "dom"