@studyportals/eslint-config

Installation

Install the package

npm install --save-dev eslint @studyportals/eslint-config

Add beneath code to your package.json

"eslintConfig": {
  "extends": "@studyportals/eslint-config"
}

Vue

For vue projects you also need to install some extra depencies:

npm install --save-dev eslint-plugin-html eslint-plugin-vue

Add beneath code to your package.json

"eslintConfig": {
  "extends": "@studyportals/eslint-config/vue"
}

Basic usage

Usage within your command line

1. Make sure you have the packages installed.
2. Run eslint against your desired file(s), npx eslint --ext js,vue MyComponent.vue

Usage within webpack

1. Install eslint-loader, npm i -D eslint-loader
2. Add beneath rule to your webpack config file.

// webpack.config.js
module.exports = {
  // ... other options
  module: {
    rules: [
      {
        enforce: 'pre',
        test: /\.(js|vue)$/,
        loader: 'eslint-loader',
        exclude: /node_modules/
      }
    ]
  }
}

Guidelines

Coming soon!