vue配置stylelint教程

stylelint可以让css样式代码在编辑、保存、提交git的时候按规范进行检查及美化,十分好用。

以下以vue项目为例分享一下配置步骤:

1.安装 stylelint

npm i -D stylelint stylelint-config-stand

如果想使用airbnb的规范,则后面改为stylelint-config-airbnb。

2.安装适配预处理语法的插件

以 sass 为例:

npm i -D stylelint-scss

3.安装缺失包

npm i stylelint-order

4.编辑package.json

{
  "scripts": {
      "lint:css": "stylelint **/*.{html,vue,css,sass,scss}"
  },
  "lint-staged": {
    "*.{html,vue,css,sass,scss}": [
      "stylelint --fix",
      "git add"
    ]
  }
}

5.添加stylelint.config.js和.stylelintignore文件,放到与package.json同级位置

//stylelint.config.js
module.exports = {
  defaultSeverity: 'error',
  extends: ['stylelint-config-airbnb'],
  plugins: ['stylelint-scss'],
  rules: {
    // 不要使用已被 autoprefixer 支持的浏览器前缀
    'media-feature-name-no-vendor-prefix': true,
    'at-rule-no-vendor-prefix': true,
    'selector-no-vendor-prefix': true,
    'property-no-vendor-prefix': true,
    'value-no-vendor-prefix': true,
    // 最多允许嵌套20层,去掉默认的最多2层
    'max-nesting-depth': 20,
    // 颜色值要小写
    'color-hex-case': 'lower',
    // 颜色值能短则短
    'color-hex-length': 'short',
    // 不能用important
    'declaration-no-important': true,
  },
};
# .stylelintignore
# 旧的不需打包的样式库
*.min.css
​
# 其他类型文件
*.js
*.jpg
*.woff
​
# 测试和打包目录
/test/
/dist/
​
# 通过反取忽略目录
/src/component/*
# 这样的效果是除 CompA 和 CompB 外其他目录都会被忽略

6.安装vscode的stylelint插件

vue配置stylelint教程_第1张图片

该插件可以在ide中显示错误、修改建议,还能保存时自动美化代码、修复可修复的代码。

vue配置stylelint教程_第2张图片
image

7.设置ide保存时使用该插件自动美化:

MAC的路径在/Users/用户名/Library/Application Support/code/User/setting.json

也可以在ide中跳转,操作方法如下:

vue配置stylelint教程_第3张图片
vue配置stylelint教程_第4张图片

然后添加如下代码:

{
    "editor.codeActionsOnSave": {
      "source.fixAll.stylelint": true
    }
}

之后在保存时就会自动美化代码、修复可修复的代码:

vue配置stylelint教程_第5张图片
image

8.安装 webpack 插件

npm i -D stylelint-webpack-plugin

我用的是webpack3.x,如果用最新版的1.2.3会报错,降为0.10.5后功能正常。

9.添加webpack相关配置:

在webpack.conf.js中添加如下代码:

const StylelintPlugin = require('stylelint-webpack-plugin');
​
plugins: [
    new StylelintPlugin({
      files: ['**/*.{html,vue,css,sass,scss}'],
      fix: false,
      cache: true,
      failOnError: false
  })
]

10.可以在命令行运行尝试效果

--fix 表示自动修复能修复的错误

npm run lint:css
npm run lint:css --fix
npm run lint:css -- --cache --fix

11.如果想修改样式规则,可以在stylelint.config.js中进行修改,相关的配置信息可以在这儿查看

vue配置stylelint教程_第6张图片

这个是不完整的中文配置文档:

vue配置stylelint教程_第7张图片

以上就是在vue上配置stylelint的过程了,大家也用起来吧。

你可能感兴趣的:(vue配置stylelint教程)