头图

stylelint 规范你的 css

TL;DR:

👉 stylelint 简介

👉 stylelint 配置

👉 stylelint 原理

stylelint 简介

A mighty, modern linter that helps you avoid errors and enforce conventions in your styles.

一个强大、现代的 linter 帮助团队避免规则错误,统一代码风格。和 eslint 类似可以继承开源社区的 config、自定义配置、写个性化的 rules 。

stylelint 配置

可按照官方引导 user-guide/get-started 进行配置。笔者目前公司项目采用的是 vue + scss + ts 实现的,这里主要会介绍 vue 和 scss 相关的配置。

相关依赖

stylelint 版本和依赖存在兼容性问题,下面依赖版本经过验证

  • stylelint@3.13.1
  • stylelint-config-recommended-scss@4.3.0
  • stylelint-scss@4.0.0
  • stylelint-config-recess-order@3.0.0
  • stylelint-prettier@2.0.0
  • stylelint-config-prettier@9.0.3

stylelint 插件提供扩展规则,不提供预设配置。(我只提供配置,用不用是你的事)。命名规范为 stylelint-xxxx

我们项目使用到了 scss 预处理器,需要利用 stylelint-config-recommended-scss 做 scss 规则检查。

stylelint-scss 提供了 n 多条规则,stylelint-config-recommended-scss 内开启了部分配置。

面试的时候我们经常会被问到 css 的重排和重绘,坦白讲写代码的时候并没有太多人关心这个。 让 linter 来帮助我们自动修复多香。stylelint-config-recess-order (属性配置 + stylelint-order插件)可以帮我们实现

stylelint 与 eslint 类似,都与 Prettier 规则有冲突,stylelint-config-prettier 可以解决这些冲突,stylelint-prettier 插件优化 Prettier 的执行时机

配置文件

可以是 .stylelintrc 或 .stylelintrc.js 或 stylelint.config.cjs 配置文件。推荐使用 .js 文件的形式方便自定义。

module.exports = {
  /* 继承公共配置 */
  "extends":[
    "stylelint-config-recommended-scss",
    "stylelint-config-recess-order",
    "stylelint-prettier/recommended"
  ],
  /* 扩展 stylelint 原生rules 的种类 */
  "plugins": ["stylelint-prettier"],
  /* 项目个性化的规则 */
   rules: {
    "selector-pseudo-element-no-unknown": [
      true,
      {
        ignorePseudoElements: ["v-deep"],
      }
    ],
    "prettier/prettier": true,
    "number-leading-zero": "always",
  }
}

之前搞不懂为啥有些工具配置能支持 monorepo 项目组织形式,读官方文档发现 cosmiconfig 库帮忙做到了这件事情。

Stylelint uses cosmiconfig to find and load your configuration object.

执行脚本

项目配置应结合 lint-stage 、git-hooks 对执行时机和范围做优化。本文只讲手动执行。

package.json:

 "lint:style": "stylelint 'src/**/*.{vue,htm,html,css,scss}' --fix"

在终端执行 npm run lint:style 看下代码的变化吧。

stylelint 原理

stylelint 通过使用 PostCSS API 来分析 CSS 的语法,实现样式的检查。

postcss 是 css 的 编译器。它和 babel 的功能设计类似, 有 parse -> transform -> generater 三个关键环节。开发者可以通过 parse 后的 AST 结构实现自定义的 lint 规则。

stylelint-config-demo


混子的日常
重学前端

自信、自洽、自在

4.7k 声望
2.4k 粉丝
0 条评论
推荐阅读
用 http-middleware-proxy 造了个代理工具
有啥用??可以用代理工具随意的搭配开发环境。`下图中可以将服务A、服务B、Web Server任意一个替换成本地服务,然后通过访问 代理服务地址 进行调试。

亖混子5阅读 860评论 3

封面图
从零搭建 Node.js 企业级 Web 服务器(零):静态服务
过去 5 年,我前后在菜鸟网络和蚂蚁金服做开发工作,一方面支撑业务团队开发各类业务系统,另一方面在自己的技术团队做基础技术建设。期间借着 Node.js 的锋芒做了不少 Web 系统,有的至今生气蓬勃、有的早已夭折...

乌柏木150阅读 12.3k评论 10

正则表达式实例
收集在业务中经常使用的正则表达式实例,方便以后进行查找,减少工作量。常用正则表达式实例1. 校验基本日期格式 {代码...} {代码...} 2. 校验密码强度密码的强度必须是包含大小写字母和数字的组合,不能使用特殊...

寒青56阅读 7.9k评论 11

JavaScript有用的代码片段和trick
平时工作过程中可以用到的实用代码集棉。判断对象否为空 {代码...} 浮点数取整 {代码...} 注意:前三种方法只适用于32个位整数,对于负数的处理上和Math.floor是不同的。 {代码...} 生成6位数字验证码 {代码...} ...

jenemy46阅读 6k评论 12

从零搭建 Node.js 企业级 Web 服务器(十五):总结与展望
总结截止到本章 “从零搭建 Node.js 企业级 Web 服务器” 主题共计 16 章内容就更新完毕了,回顾第零章曾写道:搭建一个 Node.js 企业级 Web 服务器并非难事,只是必须做好几个关键事项这几件必须做好的关键事项就...

乌柏木66阅读 6.2k评论 16

再也不学AJAX了!(二)使用AJAX ① XMLHttpRequest
「再也不学 AJAX 了」是一个以 AJAX 为主题的系列文章,希望读者通过阅读本系列文章,能够对 AJAX 技术有更加深入的认识和理解,从此能够再也不用专门学习 AJAX。本篇文章为该系列的第二篇,最近更新于 2023 年 1...

libinfs39阅读 6.3k评论 12

封面图
从零搭建 Node.js 企业级 Web 服务器(一):接口与分层
分层规范从本章起,正式进入企业级 Web 服务器核心内容。通常,一块完整的业务逻辑是由视图层、控制层、服务层、模型层共同定义与实现的,如下图:从上至下,抽象层次逐渐加深。从下至上,业务细节逐渐清晰。视图...

乌柏木44阅读 7.4k评论 6

自信、自洽、自在

4.7k 声望
2.4k 粉丝
宣传栏