Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@ued2345/stylelint-config

Package Overview
Dependencies
Maintainers
3
Versions
9
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@ued2345/stylelint-config

Stylelint config by UED2345

  • 0.2.1
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
3
Weekly downloads
 
Created
Source

stylelint-config

CSS 编码规范之 Stylelint 配置文件 ‧ UED2345

安装

在你的项目中安装 Stylelint 和本项目的 npm 包(以下简称 “本包”):

npm i -D stylelint
npm i -D @ued2345/stylelint-config

使用方法

  1. 在你的项目的根目录添加 .stylelintrc.js 文件:

    module.exports = {
    	extends: [
    		'@ued2345/stylelint-config',
    	],
    }
    
    • extends 字段指定预设的配置包,各配置包的具体含义参见下面的 “配置包” 段落。

    • 如果你的项目需要禁用或覆盖配置包中的某条规则,可以添加 rules 字段并写入你自己的规则配置:

      	rules: {
      		'block-no-empty': null,     // 禁用某条规则
      		'color-hex-case': 'lower',  // 覆盖某条规则
      	},
      
    • 如果你需要把特定文件排除在校验范围之外,可添加 ignoreFiles 字段:

      	ignoreFiles: [
      		'./src/vendor/**/*.*',
      	],
      
  2. 在你的项目的 package.json 文件中添加脚本:

    {
      "scripts": {
        "lint-css": "stylelint src/**/*.scss src/**/*.vue"
      }
    }
    
  3. 执行以下命令开始校验 CSS 代码:

    npm run lint-css
    

    如果需要 Stylelint 帮忙修复,执行以下命令:(注意:只有部分问题可以自动修复)

    npm run lint-css -- --fix
    

    如有必要,你可以把上述命令整合到 CI、Git hook 等工作流中。

规则

配置包

本包包含了多个预设的配置包,可以搭配使用。它们的含义分别如下:

配置包含义备注
'@ued2345/stylelint-config'包含 所有规则相当于同时启用以下三个配置包
'@ued2345/stylelint-config/preset/essential'包含 “疑似写错” 类型的规则强制所有项目使用
'@ued2345/stylelint-config/preset/recommended'包含 “限制语言特性” 类型的规则强烈推荐所有项目使用
'@ued2345/stylelint-config/preset/stylistic'包含 “代码风格约定” 类型的规则推荐使用

我们可以在 .stylelintrc.js 文件的 extends 字段同时指定多个配置包:

	extends: [
		'@ued2345/stylelint-config/preset/essential',
		'@ued2345/stylelint-config/preset/recommended',
	],

Keywords

FAQs

Package last updated on 29 Nov 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc