@ued2345/stylelint-config - npm Package Compare versions

Comparing version 0.1.4 to 0.2.0

package.json

 {
-  "name": "@ued2345/stylelint-config",
-  "version": "0.1.4",
-  "description": "stylelint by UED2345",
-  "main": "index.js",
-  "scripts": {
-    "test": "stylelint test/test.scss"
-  },
-  "keywords": [
-    "stylelint-config"
-  ],
-  "author": "UED2345",
-  "license": "ISC",
-  "engines": {
-    "node": ">=8",
-    "npm": ">=3"
-  },
-  "peerDependencies": {
-    "stylelint": ">= 11"
-  }
+	"name": "@ued2345/stylelint-config",
+	"version": "0.2.0",
+	"description": "stylelint by UED2345",
+	"main": "index.js",
+	"scripts": {
+		"test": "echo \"Tip: This script is not for unit-test!\n\"; stylelint test/test.scss"
+	},
+	"keywords": [
+		"stylelint-config"
+	],
+	"author": "UED2345",
+	"license": "ISC",
+	"engines": {
+		"node": ">=8",
+		"npm": ">=3"
+	},
+	"peerDependencies": {
+		"stylelint": ">= 11"
+	}
 }

README.md

@@ -5,2 +5,3 @@ # stylelint-config
 
+
 ## 安装
@@ -15,2 +16,3 @@
 
+
 ## 使用方法
@@ -23,3 +25,3 @@
 		extends: [
-			'@ued2345/stylelint-config'
+			'@ued2345/stylelint-config',
 		],
@@ -29,18 +31,20 @@ }
 	
-	如果你的项目需要禁用或覆盖配置包中预设的规则，可以添加 `rules` 字段，并写入你自己的规则配置：
+ 	* 在 `extends` 字段指定本配置包预设的规则集，各规则集的具体含义参见下面的 [“规则集”](#preset) 段落。
 	
-	```js
-		rules: {
-			'block-no-empty': null,     // 禁用某条规则
-			'color-hex-case': 'lower',  // 覆盖某条规则
-		},
-	```
+	* 如果你的项目需要禁用或覆盖规则集中的某条规则，可以添加 `rules` 字段并写入你自己的规则配置：
+	
+		```js
+			rules: {
+				'block-no-empty': null,     // 禁用某条规则
+				'color-hex-case': 'lower',  // 覆盖某条规则
+			},
+		```
 
-	如果你需要把特定文件排除在校验范围之外，可添加 `ignoreFiles` 字段：
+	* 如果你需要把特定文件排除在校验范围之外，可添加 `ignoreFiles` 字段：
 
-	```js
-		ignoreFiles: [
-			'./src/vendor/**/*.*',
-		],
-	```
+		```js
+			ignoreFiles: [
+				'./src/vendor/**/*.*',
+			],
+		```
 
@@ -71,10 +75,32 @@ 1. 在你的项目的 `package.json` 文件中添加脚本：
 
+
 ## 规则
 
-* [本配置包的规则配置](doc/rule.md)
+* [本配置包的所有规则配置](doc/rule.md)
 
-附：
+<!-- -->
 
-* [stylelint 规则官方文档](https://stylelint.io/user-guide/rules)
-* [stylelint 官方推荐的规则集（核心规则）](https://github.com/stylelint/stylelint-config-recommended/blob/master/index.js)
-* [stylelint 官方推荐的规则集（含代码风格）](https://github.com/stylelint/stylelint-config-standard/blob/master/index.js)
+* 附：[stylelint 规则官方文档](https://stylelint.io/user-guide/rules)
+* 附：[stylelint 官方推荐的规则集（核心规则）](https://github.com/stylelint/stylelint-config-recommended/blob/master/index.js)
+* 附：[stylelint 官方推荐的规则集（含代码风格）](https://github.com/stylelint/stylelint-config-standard/blob/master/index.js)
+
+
+### 规则集 <a name="preset">&nbsp;</a>
+
+本配置包包含了多个预设的规则集，可以搭配使用。它们的含义分别如下：
+
+规则集 | 含义 | 备注
+---|---|---
+`'@ued2345/stylelint-config'` | 包含 [所有规则](doc/rule.md) | 相当于同时启用以下三个规则集
+`'@ued2345/stylelint-config/preset/essential'` | 包含 [“疑似写错” 类型的规则](doc/rule.md#第一部分疑似写错) | **强制**所有项目使用
+`'@ued2345/stylelint-config/preset/recommended'` | 包含 [“限制语言特性” 类型的规则](doc/rule.md#第二部分限制语言特性) | 强烈推荐所有项目使用
+`'@ued2345/stylelint-config/preset/stylistic'` | 包含 [“代码风格约定” 类型的规则](doc/rule.md#第三部分代码风格约定) | 推荐使用
+
+我们可以在 `.stylelintrc.js` 文件的 `extends` 字段同时指定多个规则集：
+
+```js
+	extends: [
+		'@ued2345/stylelint-config/preset/essential',
+		'@ued2345/stylelint-config/preset/recommended',
+	],
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

12386

increased by11%

Number of lines in readme file

102

increased by34.21%

No dependency changes