stylelint-order 3.0.1 → 4.1.0

package/CHANGELOG.md

@@ -1,7 +1,27 @@
 # Change Log
+
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](https://semver.org/).
 
+## 4.1.0
+
+* Added `name` option to extended rule object to improve error messaging (for `order`).
+* Fixed `order` not reporting warnings, if autofix didn't fix them.
+
+## 4.0.0
+
+* Breaking change: Dropped Node.js 8 support. Node.js 10 or greater is now required.
+* Breaking change: Always remove empty line before the first property if this property has any `emptyLineBefore*` option targeting it in `properties-order`. Even if option set to `always` empty line before the first property will be removed.
+* Fixed false positives for `emptyLineBeforeUnspecified`.
+
+## 3.1.1
+
+* Added `stylelint@11` as a peer dependency.
+
+## 3.1.0
+
+* Added `emptyLineBefore: "threshold"` option, and related options (`emptyLineMinimumPropertyThreshold`, `emptyLineBeforeUnspecified: "threshold"`) to `properties-order`.
+
 ## 3.0.1
 
 * Fixed `properties-order` not report warnings, if autofix didn't fix them.

package/README.md

@@ -1,16 +1,18 @@
-# stylelint-order [![Build Status][ci-img]][ci] [![npm version][npm-version-img]][npm] [![npm downloads last month][npm-downloads-img]][npm]
+# stylelint-order
 
-A plugin pack of order related linting rules for [stylelint]. Every rule support autofixing (`stylelint --fix`).
+[![npm version][npm-version-img]][npm] [![npm downloads last month][npm-downloads-img]][npm]
+
+A plugin pack of order-related linting rules for [stylelint]. Every rule supports autofixing (`stylelint --fix`).
 
 ## Installation
 
-First, install [stylelint]:
+1. If you haven't, install [stylelint]:
 
 ```
 npm install stylelint --save-dev
 ```
 
-Then install plugin:
+2.  Install `stylelint-order`:
 
 ```
 npm install stylelint-order --save-dev
@@ -18,29 +20,27 @@ npm install stylelint-order --save-dev
 
 ## Usage
 
-Add `stylelint-order` to your stylelint config plugins array, then add rules you need to the rules list. All rules from stylelint-order need to be namespaced with `order`.
-
-Like so:
+Add `stylelint-order` to your stylelint config `plugins` array, then add rules you need to the rules list. All rules from stylelint-order need to be namespaced with `order`.
 
-```js
-// .stylelintrc
+```json
 {
 	"plugins": [
 		"stylelint-order"
 	],
 	"rules": {
-		// ...
 		"order/order": [
 			"custom-properties",
 			"declarations"
 		],
-		"order/properties-alphabetical-order": true
-		// ...
+		"order/properties-order": [
+			"width",
+			"height"
+		]
 	}
 }
 ```
 
-## List of rules
+## Rules
 
 * [`order`](./rules/order/README.md): Specify the order of content within declaration blocks.
 * [`properties-order`](./rules/properties-order/README.md): Specify the order of properties within declaration blocks.
@@ -48,16 +48,15 @@ Like so:
 
 ## Autofixing
 
-Every rule support autofixing (`stylelint --fix`). [postcss-sorting] is using internally for order autofixing.
+Every rule supports autofixing with `stylelint --fix`. [postcss-sorting] is used internally for order autofixing.
 
-Automatic sortings has some limitation, which are described for every rule if any. Please, take a look at [how comments are handled](https://github.com/hudochenkov/postcss-sorting#handling-comments) by postcss-sorting.
+Automatic sorting has some limitations that are described for every rule, if any. Please, take a look at [how comments are handled](https://github.com/hudochenkov/postcss-sorting#handling-comments) by `postcss-sorting`.
 
-CSS-in-JS styles with template interpolation [could be ignored by autofixing](https://github.com/hudochenkov/postcss-sorting#css-in-js) to avoid styles corruption.
+CSS-in-JS styles with template interpolation [could be ignored by autofixing](https://github.com/hudochenkov/postcss-sorting#css-in-js) to avoid style corruption.
 
-Autofixing is enabled by default if it's enabled in stylelint configuration. Autofixing can be disabled on per rule basis using `disableFix: true` secondary option. E. g.:
+Autofixing is enabled by default if it's enabled in stylelint's configuration file. It can be disabled on a per rule basis using the secondary option `disableFix: true`. Here's an example:
 
 ```json
-{
 	"rules": {
 		"order/order": [
 			[
@@ -69,20 +68,25 @@ Autofixing is enabled by default if it's enabled in stylelint configuration. Aut
 			}
 		]
 	}
-}
 ```
 
-Less isn't supported. It might work, but haven't tested.
+Less may work but isn't officially supported.
+
+## Example configs
+
+All these configs have `properties-order` configured  with logical properties groups:
+
+* [`stylelint-config-idiomatic-order`](https://github.com/ream88/stylelint-config-idiomatic-order)
+* [`stylelint-config-hudochenkov/order`](https://github.com/hudochenkov/stylelint-config-hudochenkov/blob/master/order.js)
+* [`stylelint-config-recess-order`](https://github.com/stormwarning/stylelint-config-recess-order)
+* [`stylelint-config-property-sort-order-smacss`](https://github.com/cahamilton/stylelint-config-property-sort-order-smacss)
 
 ## Thanks
 
-`properties-order` and `properties-alphabetical-order` code and readme are based on `declaration-block-properties-order` rule which was a stylelint's core rule prior stylelint 8.0.0.
+`properties-order` and `properties-alphabetical-order` code and README were based on the `declaration-block-properties-order` rule which was a core rule prior to stylelint 8.0.0.
 
-[ci-img]: https://travis-ci.org/hudochenkov/stylelint-order.svg
-[ci]: https://travis-ci.org/hudochenkov/stylelint-order
 [npm-version-img]: https://img.shields.io/npm/v/stylelint-order.svg
 [npm-downloads-img]: https://img.shields.io/npm/dm/stylelint-order.svg
 [npm]: https://www.npmjs.com/package/stylelint-order
-
 [stylelint]: https://stylelint.io/
 [postcss-sorting]: https://github.com/hudochenkov/postcss-sorting

package/index.js

@@ -2,7 +2,7 @@ const { createPlugin } = require('stylelint');
 const { namespace } = require('./utils');
 const rules = require('./rules');
 
-const rulesPlugins = Object.keys(rules).map(ruleName => {
+const rulesPlugins = Object.keys(rules).map((ruleName) => {
 	return createPlugin(namespace(ruleName), rules[ruleName]);
 });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stylelint-order",
-  "version": "3.0.1",
+  "version": "4.1.0",
   "description": "A collection of order related linting rules for stylelint.",
   "keywords": [
     "stylelint-plugin",
@@ -12,13 +12,6 @@
   "author": "Aleks Hudochenkov <aleks@hudochenkov.com>",
   "license": "MIT",
   "repository": "hudochenkov/stylelint-order",
-  "bugs": {
-    "url": "https://github.com/hudochenkov/stylelint-order/issues"
-  },
-  "homepage": "https://github.com/hudochenkov/stylelint-order",
-  "engines": {
-    "node": ">=8.7.0"
-  },
   "files": [
     "rules",
     "utils",
@@ -28,42 +21,51 @@
   ],
   "main": "index.js",
   "dependencies": {
-    "lodash": "^4.17.14",
-    "postcss": "^7.0.17",
+    "lodash": "^4.17.15",
+    "postcss": "^7.0.31",
     "postcss-sorting": "^5.0.1"
   },
   "peerDependencies": {
-    "stylelint": "^10.0.1"
+    "stylelint": "^10.0.1 || ^11.0.0 || ^12.0.0 || ^13.0.0"
   },
   "devDependencies": {
-    "eslint": "^6.0.1",
-    "eslint-config-hudochenkov": "^3.0.1",
-    "eslint-config-prettier": "^6.0.0",
-    "husky": "^3.0.0",
-    "jest": "^24.8.0",
-    "lint-staged": "^9.2.0",
-    "prettier": "~1.18.2",
-    "stylelint": "^10.1.0"
+    "eslint": "^6.8.0",
+    "eslint-config-hudochenkov": "^5.0.3",
+    "eslint-config-prettier": "^6.11.0",
+    "eslint-plugin-import": "^2.20.2",
+    "eslint-plugin-unicorn": "^18.0.1",
+    "husky": "^4.2.5",
+    "jest": "^26.0.1",
+    "jest-preset-stylelint": "^3.0.0",
+    "jest-watch-typeahead": "^0.6.0",
+    "lint-staged": "^10.2.7",
+    "prettier": "~2.0.5",
+    "prettier-config-hudochenkov": "^0.2.0",
+    "stylelint": "^13.5.0"
   },
   "scripts": {
-    "pretest": "eslint .",
+    "pretest": "eslint . --max-warnings=0 && prettier '**/*.js' --check",
     "test": "jest",
     "jest": "jest",
     "watch": "jest --watch",
     "coverage": "jest --coverage",
-    "fix": "eslint . --fix && prettier '**/*.js' --write"
+    "fix": "eslint . --fix --max-warnings=0 && prettier '**/*.js' --write"
   },
   "lint-staged": {
     "*.js": [
-      "eslint --fix",
-      "prettier --write",
-      "git add"
+      "eslint --fix --max-warnings=0",
+      "prettier --write"
     ]
   },
   "jest": {
+    "preset": "jest-preset-stylelint",
     "setupFiles": [
       "./jest-setup.js"
     ],
+    "watchPlugins": [
+      "jest-watch-typeahead/filename",
+      "jest-watch-typeahead/testname"
+    ],
     "testEnvironment": "node",
     "testRegex": ".*\\.test\\.js$|rules/.*/tests/.*\\.js$"
   },
@@ -71,5 +73,6 @@
     "hooks": {
       "pre-commit": "lint-staged"
     }
-  }
+  },
+  "prettier": "prettier-config-hudochenkov"
 }