Merge branch 'main' into spelling

stylelint · Oct 11, 2022 · 3ca0de7 · 3ca0de7
2 parents baf4db3 + fd2f98d
commit 3ca0de7
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 35 deletions.
diff --git a/docs/user-guide/get-started.md b/docs/user-guide/get-started.md
@@ -27,6 +27,8 @@ npm install --save-dev stylelint stylelint-config-standard
 npx stylelint "**/*.css"
 ```
 
+_You should include quotation marks around file globs._
+
 If you use a pretty printer alongside Stylelint, you should turn off any conflicting rules. For example, you can use [Prettier's shared config](https://www.npmjs.com/package/stylelint-config-prettier) to do that:
 
 ```shell
@@ -67,6 +69,8 @@ npm install --save-dev stylelint stylelint-config-standard-scss
 npx stylelint "**/*.scss"
 ```
 
+_You should include quotation marks around file globs._
+
 This config includes the [postcss-scss syntax](https://www.npmjs.com/package/postcss-scss), configures the [built-in rules](../user-guide/rules.md) for SCSS, and includes the [stylelint-scss plugin](https://www.npmjs.com/package/stylelint-scss) (a collection of rules specific to SCSS).
 
 If you use Prettier alongside Stylelint, you should use their [shared config for SCSS](https://www.npmjs.com/package/stylelint-config-prettier-scss):

diff --git a/docs/user-guide/usage/cli.md b/docs/user-guide/usage/cli.md
@@ -6,6 +6,18 @@ You can use Stylelint on the command line. For example:
 npx stylelint "**/*.css"
 ```
 
+_You should include quotation marks around file globs._
+
+If you are using [npm scripts](https://docs.npmjs.com/cli/v8/using-npm/scripts), you'll need to escape the quotes:
+
+```json
+{
+  "scripts": {
+    "lint": "stylelint \"**/*.css\""
+  }
+}
+```
+
 Use `npx stylelint --help` to print the CLI documentation.
 
 ## Options
@@ -112,7 +124,7 @@ Show the currently installed version of Stylelint.
 
 The CLI expects input as either a [file glob](https://github.com/sindresorhus/globby) or `process.stdin`. It outputs formatted results into `process.stdout`.
 
-_Be sure to include quotation marks around file globs._
+_You should include quotation marks around file globs._
 
 ### Example A - recursive
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -171,7 +171,7 @@
     "benchmark": "^2.1.4",
     "common-tags": "^1.8.2",
     "deepmerge": "^4.2.2",
-    "eslint": "^8.24.0",
+    "eslint": "^8.25.0",
     "eslint-config-stylelint": "^17.0.0",
     "husky": "^8.0.1",
     "jest": "^28.1.3",