Vue typescript eslint prettier

Saved searches

Use saved searches to filter your results more quickly

You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.

My Vue + Typescript + ESLint + Prettier project settings

pensuke81/vue-ts-eslint-prettier

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Sign In Required

Please sign in to use Codespaces.

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching Xcode

If nothing happens, download Xcode and try again.

Launching Visual Studio Code

Your codespace will open once ready.

There was a problem preparing your codespace, please try again.

Latest commit

Git stats

Files

Failed to load latest commit information.

README.md

This is my Vue + Typescript + ESLint + Prettier project settings.

vue create my-project Vue CLI v3.9.1 ? Please pick a preset: Manually select features ? Check the features needed for your project: Babel, TS, Router, Vuex, Linter ? Use class-style component syntax? No ? Use Babel alongside TypeScript (required for modern mode, auto-detected polyfills, transpiling JSX)? Yes ? Use history mode for router? (Requires proper server setup for index fallback in production) Yes ? Pick a linter / formatter config: Prettier ? Pick additional lint features: (Press to select, to toggle all, to invert selection)Lint on save ? Where do you prefer placing config for Babel, PostCSS, ESLint, etc.? In dedicated config files ? Save this as a preset for future projects? No 

Turn off all ESLint rules that are conflict with Prettier

yarn add -D eslint-plugin-prettier 

add plugin:prettier/recommended in .esilntrc.js

extends: [ 'plugin:vue/recommended', '@vue/prettier', '@vue/typescript', 'plugin:prettier/recommended' ],

rules: < "no-console": process.env.NODE_ENV === "production" ? "error" : "off", "no-debugger": process.env.NODE_ENV === "production" ? "error" : "off", "prettier/prettier": ["error", < "singleQuote": true >], "no-unused-vars": "error", "@typescript-eslint/no-unused-vars": "error" >, 

ignore lint d.ts file setting in package.json

Add new file .editorconfig

root = true [*] charset = utf-8 indent_style = space indent_size = 2 end_of_line = lf insert_final_newline = true trim_trailing_whitespace = true 

Add new file .prettierrc.js

Add .vscode/settings.json file.

< "eslint.enable": true, "eslint.autoFixOnSave": true, "editor.formatOnSave": false, "eslint.validate": [ "javascript", "language": "typescript", "autoFix": true >, "language": "vue", "autoFix": true> ], >

Источник

User Guide ​

See the rule list to get the extends & rules that this plugin provides.

Bundle Configurations ​

This plugin provides some predefined configs. You can use the following configs by adding them to extends .

• «plugin:vue/base» . Settings and rules to enable correct ESLint parsing.
• Configurations for using Vue.js 3.x.
  • «plugin:vue/vue3-essential» . base , plus rules to prevent errors or unintended behavior.
  • «plugin:vue/vue3-strongly-recommended» . Above, plus rules to considerably improve code readability and/or dev experience.
  • «plugin:vue/vue3-recommended» . Above, plus rules to enforce subjective community defaults to ensure consistency.
  • «plugin:vue/essential» . base , plus rules to prevent errors or unintended behavior.
  • «plugin:vue/strongly-recommended» . Above, plus rules to considerably improve code readability and/or dev experience.
  • «plugin:vue/recommended» . Above, plus rules to enforce subjective community defaults to ensure consistency

  By default all rules from base and essential categories report ESLint errors. Other rules — because they’re not covering potential bugs in the application — report warnings. What does it mean? By default — nothing, but if you want — you can set up a threshold and break the build after a certain amount of warnings, instead of any. More information here.

  Status of Vue.js 3.x supports

  This plugin supports the basic syntax of Vue.js 3.2, , and CSS variable injection, but the ref sugar, an experimental feature of Vue.js 3.2, is not yet supported.
  If you have issues with these, please also refer to the FAQ. If you can’t find a solution, search for the issue and if the issue doesn’t exist, open a new issue.

  Running ESLint from the command line ​

  If you want to run eslint from the command line, make sure you include the .vue extension using the —ext option or a glob pattern, because ESLint targets only .js files by default.

  eslint --ext .js,.vue src eslint "src/**/*. "

  If you installed @vue/cli-plugin-eslint, you should have the lint script added to your package.json . That means you can just run yarn lint or npm run lint .

  How to use a custom parser? ​

  If you want to use custom parsers such as @babel/eslint-parser or @typescript-eslint/parser, you have to use the parserOptions.parser option instead of the parser option. Because this plugin requires vue-eslint-parser to parse .vue files, this plugin doesn’t work if you overwrite the parser option.

  - "parser": "@typescript-eslint/parser", + "parser": "vue-eslint-parser",  "parserOptions":  + "parser": "@typescript-eslint/parser",  "sourceType": "module"  >

  The parserOptions.parser option can also specify an object to specify multiple parsers. See vue-eslint-parser README for more details.

  How does ESLint detect components? ​

  All component-related rules are applied to code that passes any of the following checks:

  • Vue.component() expression
  • Vue.extend() expression
  • Vue.mixin() expression
  • app.component() expression
  • app.mixin() expression
  • createApp() expression
  • defineComponent() expression
  • export default <> in .vue or .jsx file

  However, if you want to take advantage of the rules in any of your custom objects that are Vue components, you might need to use the special comment // @vue/component that marks an object in the next line as a Vue component in any file, e.g.:

  // @vue/component const CustomComponent =  name: 'custom-component', template: ' ' >

  Vue.component('AsyncComponent', (resolve, reject) =>  setTimeout(() =>  // @vue/component resolve(  name: 'async-component',  template: ' ' >) >, 500) >)

  Disabling rules via ​

  You can use -like HTML comments in the and in the block level of .vue files to disable a certain rule temporarily.

  template>  div a="1" b="2" c="3" d="4"> div> template>

  If you want to disallow eslint-disable functionality in , disable the vue/comment-directive rule.

  Parser Options ​

  This plugin uses vue-eslint-parser. For parserOptions , you can use the vueFeatures options of vue-eslint-parser .

   "parser": "vue-eslint-parser", "parserOptions":  "vueFeatures":  "filter": true, "interpolationAsNonHTML": false, > > >

  💻 Editor integrations ​

  Visual Studio Code ​

  Use the dbaeumer.vscode-eslint extension that Microsoft provides officially.

  You have to configure the eslint.validate option of the extension to check .vue files, because the extension targets only *.js or *.jsx files by default.

  Example .vscode/settings.json:

   "eslint.validate": [ "javascript", "javascriptreact", "vue" ] >

  If you use the Vetur plugin, set «vetur.validation.template»: false to avoid default Vetur template validation. Check out vetur documentation for more info.

  Sublime Text ​

  Use Package Control to install SublimeLinter and its ESLint extension SublimeLinter-eslint.

  In the menu go to Preferences > Package Settings > SublimeLinter > Settings and paste in this:

   "linters":  "eslint":  "selector": "text.html.vue, source.js - meta.attribute-with-value" > > >

  Atom editor ​

  Go into Settings -> Packages -> linter-eslint , under the option «List of scopes to run eslint on», add text.html.vue . You may need to restart Atom.

  IntelliJ IDEA / JetBrains WebStorm ​

  In the Settings/Preferences dialog ( Cmd+, / Ctrl+Alt+S ), choose JavaScript under Languages and Frameworks and then choose ESLint under Code Quality Tools. On the ESLint page that opens, select the Enable checkbox.

  If your ESLint configuration is updated (manually or from your version control), open it in the editor and choose Apply ESLint Code Style Rules in the context menu.

  ❓ FAQ ​

  What is the «Use the latest vue-eslint-parser» error? ​

  Most eslint-plugin-vue rules require vue-eslint-parser to check ASTs.

  Make sure you have one of the following settings in your .eslintrc:

  If you already use another parser (e.g. «parser»: «@typescript-eslint/parser» ), please move it into parserOptions , so it doesn’t collide with the vue-eslint-parser used by this plugin’s configuration:

  - "parser": "@typescript-eslint/parser", + "parser": "vue-eslint-parser",  "parserOptions":  + "parser": "@typescript-eslint/parser",  "ecmaVersion": 2020,  "sourceType": "module"  >

  Why doesn’t it work on .vue files? ​

  1. Make sure you don’t have eslint-plugin-html in your config. The eslint-plugin-html extracts the content from tags, but eslint-plugin-vue requires tags and tags in order to distinguish template and script in single file components.
  1. Make sure your tool is set to lint .vue files.
     • CLI targets only .js files by default. You have to specify additional extensions with the —ext option or glob patterns. E.g. eslint «src/**/*.» or eslint src —ext .vue . If you use @vue/cli-plugin-eslint and the vue-cli-service lint command — you don’t have to worry about it.
     • If you are having issues with configuring editor, please read editor integrations

  Conflict with Prettier ​

  Use eslint-config-prettier for Prettier not to conflict with the shareable config provided by this plugin.

  Example .eslintrc.js:

  module.exports =  // .  extends: [ // .  // 'eslint:recommended', // .  'plugin:vue/vue3-recommended', // .  "prettier" // Make sure "prettier" is the last element in this list.  ], // .  >

  If Prettier conflicts with a rule you have set, turn off that rule. For example, if you have vue/html-indent configured as error in rules , but it conflicts with Prettier, remove that line:

  module.exports =   // .   rules:   // .  - "vue/html-indent": "error",  // .   >,  // .  >

  Using JSX ​

  If you are using JSX, you need to enable JSX in your ESLint configuration.

  "parserOptions":   "ecmaVersion": 2020,  "ecmaFeatures":  + "jsx": true  >  >

  The same configuration is required when using JSX with TypeScript (TSX) in the .vue file.
  See also here.
  Note that you cannot use angle-bracket type assertion style ( var x = bar; ) when using jsx: true .

  Trouble with Visual Studio Code ​

  • Turning off the rule in the ESLint configuration file does not ignore the warning.
  • Using the comment does not suppress warnings.
  • Duplicate warnings are displayed.
  • Used @babel/eslint-parser , but the template still show vue/no-parsing-error warnings.

  You need to turn off Vetur’s template validation by adding vetur.validation.template: false to your .vscode/settings.json .

  Does not work well with ​

  The variables used in the are warned by no-unused-vars rule ​

  You need to use vue-eslint-parser v9.0.0 or later.

  Previously you had to use the vue/script-setup-uses-vars rule, this is no longer needed.

  Compiler macros such as defineProps and defineEmits generate no-undef warnings ​

  You need to use vue-eslint-parser v9.0.0 or later.

  Previously you had to use the vue/setup-compiler-macros environment, this is no longer needed.

  Parsing error with Top Level await ​

  Using ESLint

  The parser espree that comes with ESLint v7.x doesn’t understand the syntax of ES2022, so it can’t parse the Top Level await either.
  However, espree >= v8 can understand the syntax of ES2022 and parse the Top Level await .
  You install espree >= v8 and specify «espree» and ES2022 in your configuration, the parser will be able to parse it.

  module.exports =  parser: 'vue-eslint-parser', parserOptions:  parser: 'espree', //  ecmaVersion: 2022, //  sourceType: 'module' >, >

  However, note that the AST generated by espree v8+ may not work well with some rules of ESLint v7.x.

  Using ESLint >= v8.x ​

  You need to specify 2022 or «latest» for parserOptions.ecmaVersion .

  module.exports =  parserOptions:  ecmaVersion: 'latest', sourceType: 'module' >, >

  Other Problems ​

  Try searching for existing issues. If it does not exist, you should open a new issue and share your repository to reproduce the issue.

  Источник