@vue/eslint-config-prettier

What is @vue/eslint-config-prettier?

@vue/eslint-config-prettier is an ESLint configuration package that disables rules that might conflict with Prettier, a code formatting tool. This package ensures that your Vue.js project adheres to Prettier's formatting rules without any conflicts from ESLint.

What are @vue/eslint-config-prettier's main functionalities?

Disabling conflicting ESLint rules

By extending `@vue/eslint-config-prettier` in your ESLint configuration, you disable all ESLint rules that are unnecessary or might conflict with Prettier. This ensures that Prettier's formatting rules take precedence.

{
  "extends": [
    "@vue/eslint-config-prettier"
  ]
}

Integration with Vue.js projects

This configuration extends both Vue's essential linting rules and Prettier's rules, ensuring that your Vue.js project is linted according to best practices while also being formatted by Prettier.

{
  "extends": [
    "plugin:vue/essential",
    "@vue/eslint-config-prettier"
  ]
}

Other packages similar to @vue/eslint-config-prettier

eslint-config-prettier

eslint-config-prettier is a popular package that turns off all ESLint rules that are unnecessary or might conflict with Prettier. It is not specific to Vue.js and can be used with any JavaScript project.

eslint-plugin-prettier

eslint-plugin-prettier integrates Prettier into ESLint. It runs Prettier as an ESLint rule and reports differences as individual ESLint issues. This package can be used alongside eslint-config-prettier for a comprehensive setup.

eslint-config-airbnb

eslint-config-airbnb is a widely-used ESLint configuration that follows Airbnb's JavaScript style guide. While it does not specifically integrate with Prettier, it can be used in conjunction with eslint-config-prettier to avoid conflicts.

README

@vue/eslint-config-prettier

eslint-config-prettier for vue-cli

This config is specifically designed to be used by vue-cli setups and is not meant for outside use (it can be used but some adaptations on the user side might be needed - for details see the config file).

A part of its design is that this config may implicitly depend on other parts of vue-cli setups, such as eslint-plugin-vue being extended in the same resulting config.

Changelog

4.0.0 (2018-10-31)

Beaking Changes

• Update base configs and plugins, now requires ESLint v5 as a peer dependency