Skip to content
This repository has been archived by the owner on Jan 9, 2024. It is now read-only.

vuestorefront/eslint-config

Repository files navigation

vuestorefront/eslint-config

@vue-storefront/eslint-config

npm version npm downloads License

Vue Storefront eslint standards

Information

Eslint configuration for:

  • JavaScript
  • Typescript
  • Nuxt 3
  • Nuxt 2
  • Vue 3
  • Vue 2

For this eslint config package, we enable the following community standards:

  • AirBnb
  • Prettier

This configuration provides eslint rules for the following:

  • TypeScript
  • Vue
  • Nuxt
  • JSON
  • YAML / YML
  • Markdown

Usage

All Configs

Install

pnpm add -D eslint @vue-storefront/eslint-config

Config .eslintrc

{
  "extends": "@vue-storefront/eslint-config"
}

Base Config

Install

pnpm add -D eslint @vue-storefront/eslint-config-base

Config .eslintrc

{
  "extends": "@vue-storefront/eslint-config-base"
}

TypeScript Config

Install

pnpm add -D eslint @vue-storefront/eslint-config-typescript

Config .eslintrc

{
  "extends": "@vue-storefront/eslint-config-typescript"
}

Nuxt 3 Config

Install

pnpm add -D eslint @vue-storefront/eslint-config-nuxt

Config .eslintrc

{
  "extends": "@vue-storefront/eslint-config-nuxt"
}

Nuxt 2 Config

Install

pnpm add -D eslint @vue-storefront/eslint-config-nuxt2

Config .eslintrc

{
  "extends": "@vue-storefront/eslint-config-nuxt2"
}

Vue 3 Config

Install

pnpm add -D eslint @vue-storefront/eslint-config-vue

Config .eslintrc

{
  "extends": "@vue-storefront/eslint-config-vue"
}

Vue 2 Config

Install

pnpm add -D eslint @vue-storefront/eslint-config-vue2

Config .eslintrc

{
  "extends": "@vue-storefront/eslint-config-vue2"
}

Config VS Code auto fix

Update your .vscode/settings.json and add the following

{
  "prettier.enable": true,
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  }
}

Contributing

You can contribute to this module online with CodeSandBox:

Edit @vuestorefront/eslint-config

Or locally:

  1. Clone this repository
  2. Install dependencies using yarn install or npm install
  3. Start development server using yarn dev or npm run dev

License

MIT License

Copyright (c) Vue Storefront