0.0.2 • Published 5 years ago

eslint-config-hsfe v0.0.2

Weekly downloads
2
License
MIT
Repository
-
Last release
5 years ago

eslint-config-hsfe

This package provides Hsfe's base JS .eslintrc as an extensible shared config. 这个包是黑识前端团队的基础代码规范ESLint的配置.

Usage

eslint-config-hsfe

Our default export contains all of our ESLint rules, including ECMAScript 6.

First, install this package

npm install --save-dev eslint-config-hsfe eslint@latest

Then add following contents to your .eslintrc file

{
  "extends": "hsfe"
}

eslint-config-hsfe/vue

First, install this package and necessary plugins

npm install --save-dev eslint-config-hsfe eslint@latest babel-eslint eslint-plugin-vue@next eslint-plugin-import

Then add following contents to your .eslintrc file

{
  "extends": "hsfe/vue"
}

vue-cli2 project

First, install this package and necessary plugins

npm install --save-dev eslint-config-hsfe eslint@latest babel-eslint eslint-plugin-vue@next eslint-plugin-import eslint-loader eslint-formatter-friendly

Then create .eslintrc.js file

module.exports = {
  globals: {

  },
  extends: [
    'hsfe',
    'hsfe/vue',
  ],
  parserOptions: {
    parser: 'babel-eslint'
  },
  rules: {
    'no-console': 0,
    'no-debugger': 0
  }
};

Then add following contents to your webpack.base.conf.js file

{
  test: /\.(js|vue)/,
  loader: 'eslint-loader',
  enforce: 'pre',
  include: [resolve('src')],
  options: {
    formatter: require('eslint-formatter-friendly')
  }
}

Then add following contents to your package.json file script object

"scripts": {
  "dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js",
  "start": "npm run dev",
  "build": "node build/build.js",
  // new
  "lint": "eslint --ext .js,.vue src/",
  "lint:fix": "eslint --ext .js,.vue src/ --fix"
},

> vue-cli3 project

First, go to your project directory

vue add @vue/cli-plugin-eslint

Then add ours eslint config package

npm install --save-dev eslint-config-hsfe eslint@latest eslint-plugin-vue@next

Then edit the .eslintrc.js file

module.exports = {
  root: true,
  env: {
    node: true
  },
  'extends': [
    // 删除以下两行
    'plugin:vue/essential',
    'eslint:recommended'
    // 新增以下两行
    'hsfe',
    'hsfe/vue',
  ],
  parserOptions: {
    parser: 'babel-eslint'
  },
  rules: {
    'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
    'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off'
  }
}

License

MIT