@mrhenry/stylelint-mrhenry-prop-order 1.0.10 → 2.0.0

package/README.md

@@ -2,33 +2,72 @@
 
 [![version](https://img.shields.io/npm/v/@mrhenry/stylelint-mrhenry-prop-order.svg)](https://www.npmjs.com/package/@mrhenry/stylelint-mrhenry-prop-order)
 
-Mr. Henry's preferred order for CSS properties.
+Specify a strict order for CSS properties.
 
-This package does not group properties.
-It only sorts them within "imaginary sections".
+```css
+/* valid */
+.foo {
+	width: 100px;
+	height: 20px;
+}
+
+/* invalid */
+.foo {
+	height: 20px; /* we prefer width before height */
+	width: 100px;
+}
+```
+
+```css
+/* valid */
+.foo {
+	margin: 20px;
+	margin-top: 10px;
+}
 
-Acts as a separator between sections :
-- ignored declarations
+/* invalid */
+.foo {
+	margin-top: 10px; /* longhand before a shorthand */
+	margin: 20px;
+}
+```
+
+This package doesn't create groups of properties.
+But it will respect patterns that are often used to group properties:
 - empty lines
 - comments
-
-Ignored declarations :
 - custom properties
 - vendor prefixed CSS
 
 ```css
 .foo {
-  a: 0; /* section : 1 */
-  b: 0; /* section : 1 */
-
-  c: 0; /* section : 2 */
-  d: 0; /* section : 2 */
-  /* a comment */
-  e: 0; /* section : 3 */
-  f: 0; /* section : 3 */
-  --a: 0; /* ignored */
-  --b: 0; /* ignored */
-  -webkit-foo: 0; /* ignored */
+	a: 0; /* section : 1 */
+	b: 0; /* section : 1 */
+
+	c: 0; /* section : 2 */
+	d: 0; /* section : 2 */
+	/* a comment */
+	e: 0; /* section : 3 */
+	f: 0; /* section : 3 */
+	--a: 0; /* ignored */
+	--b: 0; /* ignored */
+	-webkit-foo: 0; /* ignored */
+}
+```
+
+## Usage
+
+`npm install --save-dev @mrhenry/stylelint-mrhenry-prop-order`
+
+```js
+// stylelint.config.js
+module.exports = {
+	plugins: [
+		"@mrhenry/stylelint-mrhenry-prop-order",
+	],
+	rules: {
+		"@mrhenry/stylelint-mrhenry-prop-order": true,
+	},
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mrhenry/stylelint-mrhenry-prop-order",
-  "version": "1.0.10",
+  "version": "2.0.0",
   "description": "Mr. Henry's preferred order for CSS properties",
   "main": "stylelint-mrhenry-prop-order.js",
   "scripts": {

package/stylelint-mrhenry-prop-order.js

@@ -2,7 +2,7 @@ const stylelint = require("stylelint");
 const order = require('./order.js');
 const orderSet = new Set(order);
 
-const ruleName = "plugin/stylelint-mrhenry-prop-order";
+const ruleName = "@mrhenry/stylelint-mrhenry-prop-order";
 const messages = stylelint.utils.ruleMessages(ruleName, {
 	expected: (name) => {
 		return `Expected ${name} to appear at a different position.`;
@@ -112,8 +112,10 @@ const ruleFunction = (primaryOption, secondaryOptionObject, context) => {
 				}
 			});
 
-			for (const [comment, prev] of matchedComments) {
-				rule.insertAfter(prev, comment);
+			if (context.fix) {
+				for (const [comment, prev] of matchedComments) {
+					rule.insertAfter(prev, comment);
+				}
 			}
 		});
 	};