xcc-standard-eslint

xcc eslint

Usage no npm install needed!

<script type="module">
  import xccStandardEslint from 'https://cdn.skypack.dev/xcc-standard-eslint';
</script>

README

xcc-standard-eslint

功能

  • 格式化代码，采用standard风格
  • 支持typescript与jsx，通过useTs参数区分，默认jsx

用法

  • 安装npm install xcc-standard-eslint eslint-plugin-react -D
  • 项目根目录添加文件.eslintrc.js
  • useTs字段含义为是否为typescript编写
  • ignorePatterns为需要忽略的文件
  • rules配置规则，可以覆盖默认规则
    • 老项目中有许多不符合规范的字段及代码风格，比如变量命名为style_id，就需要忽略掉
  // eslintrc.js
  const { getEslint } = require('xcc-standard-eslint')

  module.exports = {
    ...getEslint({
      ignorePatterns: ['.dll', 'build', '.temp'],
      useTs: true,
      rules: {
        'comma-dangle': 'off',
        'function-paren-newline': 'off',
        'global-require': 'off',
        'import/no-dynamic-require': 'off',
        'no-inner-declarations': 'off',
        ...
      }
    })
  }