bump version to 8.4.0-3

[pve-eslint.git] / eslint / docs / rules / no-inline-comments.md

diff --git a/eslint/docs/rules/no-inline-comments.md b/eslint/docs/rules/no-inline-comments.md
index cde77e9e49914e852ede3ab9e50a58e937081398..237b2485a72dbfff5417deae3face3198062b050 100644 (file)
--- a/eslint/docs/rules/no-inline-comments.md
+++ b/eslint/docs/rules/no-inline-comments.md
@@ -87,3 +87,25 @@ var quux = (
     </div>
 )
 ```
+
+## Options
+
+### ignorePattern
+
+To make this rule ignore specific comments, set the `ignorePattern` option to a string pattern that will be passed to the [`RegExp` constructor](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/RegExp).
+
+Examples of **correct** code for the `ignorePattern` option:
+
+```js
+/*eslint no-inline-comments: ["error", { "ignorePattern": "webpackChunkName:\\s.+" }]*/
+
+import(/* webpackChunkName: "my-chunk-name" */ './locale/en');
+```
+
+Examples of **incorrect** code for the `ignorePattern` option:
+
+```js
+/*eslint no-inline-comments: ["error", { "ignorePattern": "something" }] */
+
+var foo = 4; // other thing
+```