Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #562 from nextcloud/feat/support-vue-ts
- Loading branch information
Showing
13 changed files
with
301 additions
and
169 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,166 +1,21 @@ | ||
| const base = require('./parts/base.js') | ||
| const typescriptOverrides = require('./parts/typescript.js') | ||
| const vueOverrides = require('./parts/vue.js') | ||
|
|
||
| /** | ||
| * Config for Vue + Javascript projects (optionally with parts, except vue files, written in Typescript) | ||
| */ | ||
| module.exports = { | ||
| root: true, | ||
| env: { | ||
| browser: true, | ||
| commonjs: true, | ||
| es6: true, | ||
| node: true, | ||
| // Allow jest syntax in the src folder | ||
| jest: true, | ||
| }, | ||
| parserOptions: { | ||
| parser: '@babel/eslint-parser', | ||
| ecmaVersion: 6, | ||
| requireConfigFile: false, | ||
| }, | ||
| extends: [ | ||
| 'eslint:recommended', | ||
| 'plugin:import/errors', | ||
| 'plugin:import/warnings', | ||
| 'plugin:n/recommended', | ||
| 'plugin:vue/recommended', | ||
| 'plugin:@nextcloud/recommended', | ||
| 'plugin:jsdoc/recommended', | ||
| 'standard', | ||
| ], | ||
| settings: { | ||
| 'import/resolver': { | ||
| node: { | ||
| paths: ['src'], | ||
| extensions: ['.js', '.vue'], | ||
| }, | ||
| exports: { | ||
| conditions: ['import'], | ||
| }, | ||
| }, | ||
| jsdoc: { | ||
| tagNamePreference: { | ||
| returns: 'return', | ||
| }, | ||
| mode: 'typescript', | ||
| }, | ||
| }, | ||
| plugins: ['vue', 'n', 'jsdoc'], | ||
| rules: { | ||
| // space before function () | ||
| 'space-before-function-paren': ['error', { | ||
| anonymous: 'never', | ||
| named: 'never', | ||
| asyncArrow: 'always', | ||
| }], | ||
| // stay consistent with array brackets | ||
| 'array-bracket-newline': ['error', 'consistent'], | ||
| // tabs only for indentation | ||
| indent: ['error', 'tab'], | ||
| 'no-tabs': ['error', { allowIndentationTabs: true }], | ||
| 'vue/html-indent': ['error', 'tab'], | ||
| // allow spaces after tabs for alignment | ||
| 'no-mixed-spaces-and-tabs': ['error', 'smart-tabs'], | ||
| // only debug console | ||
| 'no-console': ['error', { allow: ['error', 'warn', 'info', 'debug'] }], | ||
| // classes blocks | ||
| 'padded-blocks': ['error', { classes: 'always' }], | ||
| // always have the operator in front | ||
| 'operator-linebreak': ['error', 'before'], | ||
| // ternary on multiline | ||
| 'multiline-ternary': ['error', 'always-multiline'], | ||
| // force proper JSDocs | ||
| 'jsdoc/require-returns': 0, | ||
| 'jsdoc/require-returns-description': 0, | ||
| 'jsdoc/tag-lines': ['off'], | ||
| // disallow use of "var" | ||
| 'no-var': 'error', | ||
| // suggest using const | ||
| 'prefer-const': 'error', | ||
| // es6 import/export and require | ||
| 'n/no-unpublished-require': ['off'], | ||
| 'n/no-unsupported-features/es-syntax': ['off'], | ||
| // PascalCase components names for vuejs | ||
| // https://vuejs.org/v2/style-guide/#Single-file-component-filename-casing-strongly-recommended | ||
| 'vue/component-name-in-template-casing': ['error', 'PascalCase'], | ||
| // force name | ||
| 'vue/match-component-file-name': ['error', { | ||
| extensions: ['jsx', 'vue', 'js'], | ||
| shouldMatchCase: true, | ||
| }], | ||
| // space before self-closing elements | ||
| 'vue/html-closing-bracket-spacing': 'error', | ||
| // no ending html tag on a new line | ||
| 'vue/html-closing-bracket-newline': ['error', { multiline: 'never' }], | ||
| // check vue files too | ||
| 'n/no-missing-import': ['error', {}], | ||
| // code spacing with attributes | ||
| 'vue/max-attributes-per-line': ['error', { | ||
| singleline: 3, | ||
| multiline: 1, | ||
| }], | ||
| 'vue/first-attribute-linebreak': ['error', { | ||
| singleline: 'beside', | ||
| multiline: 'beside', | ||
| }], | ||
| // Allow single-word components names | ||
| 'vue/multi-word-component-names': ['off'], | ||
| // custom event naming convention | ||
| 'vue/custom-event-name-casing': ['error', 'kebab-case', { | ||
| // allows custom xxxx:xxx events formats | ||
| ignores: ['/^[a-z]+(?:-[a-z]+)*:[a-z]+(?:-[a-z]+)*$/u'], | ||
| }], | ||
| // always add a trailing comma (for diff readability) | ||
| 'comma-dangle': ['warn', 'always-multiline'], | ||
| // Allow shallow import of @vue/test-utils and @testing-library/vue in order to be able to use it in | ||
| // the src folder | ||
| 'n/no-unpublished-import': ['error', { | ||
| allowModules: ['@vue/test-utils', '@testing-library/vue'], | ||
| }], | ||
| // require object literal shorthand syntax | ||
| 'object-shorthand': ['error', 'always'], | ||
| // Warn when file extensions are not used on import paths | ||
| 'import/extensions': ['warn', 'always', { | ||
| ignorePackages: true, | ||
| }], | ||
| // ignore camelcase for __webpack variables | ||
| camelcase: ['error', { | ||
| allow: ['^UNSAFE_', '^__webpack_'], | ||
| properties: 'never', | ||
| ignoreGlobals: true, | ||
| }], | ||
| }, | ||
| // Base rules | ||
| ...base, | ||
| // basic Typescript rules | ||
| overrides: [ | ||
| { | ||
| files: ['**/*.ts', '**/*.tsx'], | ||
| extends: [ | ||
| '@vue/eslint-config-typescript/recommended', | ||
| 'plugin:import/typescript', | ||
| ], | ||
| parserOptions: { | ||
| parser: '@typescript-eslint/parser', | ||
| }, | ||
| rules: { | ||
| 'n/no-missing-import': 'off', | ||
| 'import/extensions': 'off', | ||
| 'jsdoc/check-tag-names': [ | ||
| 'warn', { | ||
| // for projects using typedoc | ||
| definedTags: [ | ||
| 'notExported', | ||
| 'packageDocumentation', | ||
| ], | ||
| }, | ||
| ], | ||
| // Does not make sense with TypeScript | ||
| 'jsdoc/require-param-type': 'off', | ||
| }, | ||
| settings: { | ||
| 'import/resolver': { | ||
| typescript: { | ||
| alwaysTryTypes: true, | ||
| }, | ||
| node: { | ||
| paths: ['src'], | ||
| extensions: ['.(m|c)?js', '.ts', '.tsx', '.vue'], | ||
| }, | ||
| }, | ||
| }, | ||
| ...typescriptOverrides, | ||
| }, | ||
| // Setup different vue parser to support `<script setup>` correctly | ||
| { | ||
| ...vueOverrides, | ||
| }, | ||
| ], | ||
| } |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| /** Base rules */ | ||
| module.exports = { | ||
| root: true, | ||
| env: { | ||
| browser: true, | ||
| commonjs: true, | ||
| es6: true, | ||
| node: true, | ||
| // Allow jest syntax in the src folder | ||
| jest: true, | ||
| }, | ||
| parser: '@babel/eslint-parser', | ||
| parserOptions: { | ||
| requireConfigFile: false, | ||
| }, | ||
| extends: [ | ||
| 'eslint:recommended', | ||
| 'plugin:import/errors', | ||
| 'plugin:import/warnings', | ||
| 'plugin:n/recommended', | ||
| 'plugin:@nextcloud/recommended', | ||
| 'plugin:jsdoc/recommended', | ||
| 'standard', | ||
| ], | ||
| settings: { | ||
| 'import/resolver': { | ||
| node: { | ||
| paths: ['src'], | ||
| extensions: ['.js', '.vue'], | ||
| }, | ||
| exports: { | ||
| conditions: ['import'], | ||
| }, | ||
| }, | ||
| jsdoc: { | ||
| tagNamePreference: { | ||
| returns: 'return', | ||
| }, | ||
| mode: 'typescript', | ||
| }, | ||
| }, | ||
| plugins: ['vue', 'n', 'jsdoc'], | ||
| rules: { | ||
| // space before function () | ||
| 'space-before-function-paren': ['error', { | ||
| anonymous: 'never', | ||
| named: 'never', | ||
| asyncArrow: 'always', | ||
| }], | ||
| // stay consistent with array brackets | ||
| 'array-bracket-newline': ['error', 'consistent'], | ||
| // tabs only for indentation | ||
| indent: ['error', 'tab'], | ||
| 'no-tabs': ['error', { allowIndentationTabs: true }], | ||
| // allow spaces after tabs for alignment | ||
| 'no-mixed-spaces-and-tabs': ['error', 'smart-tabs'], | ||
| // only debug console | ||
| 'no-console': ['error', { allow: ['error', 'warn', 'info', 'debug'] }], | ||
| // classes blocks | ||
| 'padded-blocks': ['error', { classes: 'always' }], | ||
| // always have the operator in front | ||
| 'operator-linebreak': ['error', 'before'], | ||
| // ternary on multiline | ||
| 'multiline-ternary': ['error', 'always-multiline'], | ||
| // force proper JSDocs | ||
| 'jsdoc/require-returns': 0, | ||
| 'jsdoc/require-returns-description': 0, | ||
| 'jsdoc/tag-lines': ['off'], | ||
| // disallow use of "var" | ||
| 'no-var': 'error', | ||
| // suggest using const | ||
| 'prefer-const': 'error', | ||
| // es6 import/export and require | ||
| 'n/no-unpublished-require': ['off'], | ||
| 'n/no-unsupported-features/es-syntax': ['off'], | ||
| // always add a trailing comma (for diff readability) | ||
| 'comma-dangle': ['warn', 'always-multiline'], | ||
| // Allow shallow import of @vue/test-utils and @testing-library/vue in order to be able to use it in | ||
| // the src folder | ||
| 'n/no-unpublished-import': ['error', { | ||
| allowModules: ['@vue/test-utils', '@testing-library/vue'], | ||
| }], | ||
| // require object literal shorthand syntax | ||
| 'object-shorthand': ['error', 'always'], | ||
| // Warn when file extensions are not used on import paths | ||
| 'import/extensions': ['warn', 'always', { | ||
| ignorePackages: true, | ||
| }], | ||
| // ignore camelcase for __webpack variables | ||
| camelcase: ['error', { | ||
| allow: ['^UNSAFE_', '^__webpack_'], | ||
| properties: 'never', | ||
| ignoreGlobals: true, | ||
| }], | ||
| }, | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| /** Rules for typescript */ | ||
| module.exports = { | ||
| files: ['**/*.ts', '**/*.tsx'], | ||
| extends: [ | ||
| '@vue/eslint-config-typescript/recommended', | ||
| 'plugin:import/typescript', | ||
| ], | ||
| parser: '@typescript-eslint/parser', | ||
| parserOptions: {}, | ||
| rules: { | ||
| 'n/no-missing-import': 'off', | ||
| 'import/extensions': 'off', | ||
| 'jsdoc/check-tag-names': [ | ||
| 'warn', { | ||
| // for projects using typedoc | ||
| definedTags: [ | ||
| 'notExported', | ||
| 'packageDocumentation', | ||
| ], | ||
| }, | ||
| ], | ||
| // Does not make sense with TypeScript | ||
| 'jsdoc/require-param-type': 'off', | ||
| }, | ||
| settings: { | ||
| 'import/resolver': { | ||
| typescript: { | ||
| alwaysTryTypes: true, | ||
| }, | ||
| node: { | ||
| paths: ['src'], | ||
| extensions: ['.(m|c)?js', '.ts', '.tsx', '.vue'], | ||
| }, | ||
| }, | ||
| }, | ||
| } |
Oops, something went wrong.