Auto generate rule notice (#1680)

Co-authored-by: Bryan Mishkin <698306+bmish@users.noreply.github.com>
sindresorhus · Jan 5, 2022 · 7a4bc97 · 7a4bc97
1 parent bd6c163
commit 7a4bc97
Show file tree

Hide file tree

Showing 103 changed files with 422 additions and 52 deletions.
diff --git a/docs/rules/better-regex.md b/docs/rules/better-regex.md
@@ -1,8 +1,11 @@
 # Improve regexes by making them shorter, consistent, and safer
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
 
 🔧 *This rule is [auto-fixable](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems).*
+<!-- /RULE_NOTICE -->
 
 Note: This rule uses [`regexp-tree`](https://github.com/DmitrySoshnikov/regexp-tree) and [`clean-regexp`](https://github.com/samverschueren/clean-regexp) under the hood.
 

diff --git a/docs/rules/catch-error-name.md b/docs/rules/catch-error-name.md
@@ -1,8 +1,11 @@
 # Enforce a specific parameter name in catch clauses
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
 
 🔧 *This rule is [auto-fixable](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems).*
+<!-- /RULE_NOTICE -->
 
 Applies to
 

diff --git a/docs/rules/consistent-destructuring.md b/docs/rules/consistent-destructuring.md
@@ -1,8 +1,11 @@
 # Use destructured variables over properties
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
 
 🔧💡 *This rule is [auto-fixable](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) and provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).*
+<!-- /RULE_NOTICE -->
 
 Enforces the use of already destructured objects and their variables over accessing each property individually. Previous destructurings are easily missed which leads to an inconsistent code style.
 

diff --git a/docs/rules/consistent-function-scoping.md b/docs/rules/consistent-function-scoping.md
@@ -1,6 +1,9 @@
 # Move function definitions to the highest possible scope
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
+<!-- /RULE_NOTICE -->
 
 A function definition should be placed as close to the top-level scope as possible without breaking its captured values. This improves readability, [directly improves performance](https://stackoverflow.com/a/81329/207247) and allows JavaScript engines to [better optimize performance](https://ponyfoo.com/articles/javascript-performance-pitfalls-v8#optimization-limit).
 

diff --git a/docs/rules/custom-error-definition.md b/docs/rules/custom-error-definition.md
@@ -1,6 +1,9 @@
 # Enforce correct `Error` subclassing
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 🔧 *This rule is [auto-fixable](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems).*
+<!-- /RULE_NOTICE -->
 
 Enforces the only valid way of `Error` subclassing. It works with any super class that ends in `Error`.
 

diff --git a/docs/rules/empty-brace-spaces.md b/docs/rules/empty-brace-spaces.md
@@ -1,8 +1,11 @@
 # Enforce no spaces between braces
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
 
 🔧 *This rule is [auto-fixable](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems).*
+<!-- /RULE_NOTICE -->
 
 ## Fail
 

diff --git a/docs/rules/error-message.md b/docs/rules/error-message.md
@@ -1,6 +1,9 @@
 # Enforce passing a `message` value when creating a built-in error
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
+<!-- /RULE_NOTICE -->
 
 This rule enforces a `message` value to be passed in when creating an instance of a built-in [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) object, which leads to more readable and debuggable code.
 

diff --git a/docs/rules/escape-case.md b/docs/rules/escape-case.md
@@ -1,8 +1,11 @@
 # Require escape sequences to use uppercase values
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
 
 🔧 *This rule is [auto-fixable](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems).*
+<!-- /RULE_NOTICE -->
 
 Enforces defining escape sequence values with uppercase characters rather than lowercase ones. This promotes readability by making the escaped value more distinguishable from the identifier.
 

diff --git a/docs/rules/expiring-todo-comments.md b/docs/rules/expiring-todo-comments.md
@@ -1,6 +1,9 @@
 # Add expiration conditions to TODO comments
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
+<!-- /RULE_NOTICE -->
 
 This rule makes it possible to pass arguments to TODO, FIXME and XXX comments to trigger ESLint to report.
 

diff --git a/docs/rules/explicit-length-check.md b/docs/rules/explicit-length-check.md
@@ -1,8 +1,11 @@
 # Enforce explicitly comparing the `length` or `size` property of a value
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
 
 🔧💡 *This rule is [auto-fixable](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) and provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).*
+<!-- /RULE_NOTICE -->
 
 Enforce explicitly checking the length of an object and enforce the comparison style.
 

diff --git a/docs/rules/filename-case.md b/docs/rules/filename-case.md
@@ -1,6 +1,9 @@
 # Enforce a case style for filenames
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
+<!-- /RULE_NOTICE -->
 
 Enforces all linted files to have their names in a certain case style and lowercase file extension. The default is `kebabCase`.
 

diff --git a/docs/rules/import-index.md b/docs/rules/import-index.md
@@ -1,6 +1,9 @@
 # Enforce importing index files with `.`
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 🔧 *This rule is [auto-fixable](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems).*
+<!-- /RULE_NOTICE -->
 
 Enforces importing index file with `.` instead of `./`, `./index` or `./index.js`.
 

diff --git a/docs/rules/import-style.md b/docs/rules/import-style.md
@@ -1,6 +1,9 @@
 # Enforce specific import styles per module
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
+<!-- /RULE_NOTICE -->
 
 Sometimes a module contains unrelated functions, like `util`, thus it is a good practice to enforce destructuring or named imports here. Other times, in modules like `path`, it is good to use default import as they have similar functions, all likely to be utilized.
 

diff --git a/docs/rules/new-for-builtins.md b/docs/rules/new-for-builtins.md
@@ -1,8 +1,11 @@
 # Enforce the use of `new` for all builtins, except `String`, `Number`, `Boolean`, `Symbol` and `BigInt`
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
 
 🔧 *This rule is [auto-fixable](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems).*
+<!-- /RULE_NOTICE -->
 
 They work the same, but `new` should be preferred for consistency with other constructors.
 

diff --git a/docs/rules/no-abusive-eslint-disable.md b/docs/rules/no-abusive-eslint-disable.md
@@ -1,6 +1,9 @@
 # Enforce specifying rules to disable in `eslint-disable` comments
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
+<!-- /RULE_NOTICE -->
 
 This rule makes you specify the rules you want to disable when using `eslint-disable`, `eslint-disable-line` or `eslint-disable-next-line` comments.
 

diff --git a/docs/rules/no-array-callback-reference.md b/docs/rules/no-array-callback-reference.md
@@ -1,8 +1,11 @@
 # Prevent passing a function reference directly to iterator methods
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
 
 💡 *This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).*
+<!-- /RULE_NOTICE -->
 
 Suppose you have a `unicorn` module:
 

diff --git a/docs/rules/no-array-for-each.md b/docs/rules/no-array-for-each.md
@@ -1,8 +1,11 @@
 # Prefer `for…of` over `Array#forEach(…)`
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
 
 🔧 *This rule is [auto-fixable](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems).*
+<!-- /RULE_NOTICE -->
 
 Benefits of [`for…of` statement](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for...of) over [`Array#forEach(…)`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach) can include:
 

diff --git a/docs/rules/no-array-method-this-argument.md b/docs/rules/no-array-method-this-argument.md
@@ -1,8 +1,11 @@
 # Disallow using the `this` argument in array methods
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
 
 🔧💡 *This rule is [auto-fixable](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) and provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).*
+<!-- /RULE_NOTICE -->
 
 The rule forbids using the `thisArg` argument in array methods:
 

diff --git a/docs/rules/no-array-push-push.md b/docs/rules/no-array-push-push.md
@@ -1,8 +1,11 @@
 # Enforce combining multiple `Array#push()` into one call
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
 
 🔧💡 *This rule is [auto-fixable](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) and provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).*
+<!-- /RULE_NOTICE -->
 
 [`Array#push()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/push) accepts multiple arguments. Multiple calls should be combined into one.
 

diff --git a/docs/rules/no-array-reduce.md b/docs/rules/no-array-reduce.md
@@ -1,6 +1,9 @@
 # Disallow `Array#reduce()` and `Array#reduceRight()`
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
+<!-- /RULE_NOTICE -->
 
 `Array#reduce()` and `Array#reduceRight()` usually result in [hard-to-read](https://twitter.com/jaffathecake/status/1213077702300852224) and [less performant](https://www.richsnapp.com/article/2019/06-09-reduce-spread-anti-pattern) code. In almost every case, it can be replaced by `.map`, `.filter`, or a `for-of` loop.
 

diff --git a/docs/rules/no-await-expression-member.md b/docs/rules/no-await-expression-member.md
@@ -1,8 +1,11 @@
 # Forbid member access from await expression
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
 
 🔧 *This rule is [auto-fixable](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems).*
+<!-- /RULE_NOTICE -->
 
 When accessing a member from an await expression, the await expression has to be parenthesized, which is not readable.
 

diff --git a/docs/rules/no-console-spaces.md b/docs/rules/no-console-spaces.md
@@ -1,8 +1,11 @@
 # Do not use leading/trailing space between `console.log` parameters
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
 
 🔧 *This rule is [auto-fixable](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems).*
+<!-- /RULE_NOTICE -->
 
 The [`console.log()` method](https://developer.mozilla.org/en-US/docs/Web/API/Console/log) and similar methods joins the parameters with a space, so adding a leading/trailing space to a parameter, results in two spaces being added.
 

diff --git a/docs/rules/no-document-cookie.md b/docs/rules/no-document-cookie.md
@@ -1,6 +1,9 @@
 # Do not use `document.cookie` directly
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
+<!-- /RULE_NOTICE -->
 
 It's not recommended to use [`document.cookie`](https://developer.mozilla.org/en-US/docs/Web/API/Document/cookie) directly as it's easy to get the string wrong. Instead, you should use the [Cookie Store API](https://developer.mozilla.org/en-US/docs/Web/API/Cookie_Store_API) or a [cookie library](https://www.npmjs.com/search?q=cookie).
 

diff --git a/docs/rules/no-empty-file.md b/docs/rules/no-empty-file.md
@@ -1,6 +1,9 @@
 # Disallow empty files
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
+<!-- /RULE_NOTICE -->
 
 Meaningless files clutter a codebase.
 

diff --git a/docs/rules/no-for-loop.md b/docs/rules/no-for-loop.md
@@ -1,8 +1,11 @@
 # Do not use a `for` loop that can be replaced with a `for-of` loop
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
 
 🔧 *This rule is [auto-fixable](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems).*
+<!-- /RULE_NOTICE -->
 
 There's no reason to use old school for loops anymore for the common case. You can instead use for-of loop (with `.entries()` if you need to access the index).
 

diff --git a/docs/rules/no-hex-escape.md b/docs/rules/no-hex-escape.md
@@ -1,8 +1,11 @@
 # Enforce the use of Unicode escapes instead of hexadecimal escapes
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
 
 🔧 *This rule is [auto-fixable](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems).*
+<!-- /RULE_NOTICE -->
 
 Enforces a convention of using [Unicode escapes](https://mathiasbynens.be/notes/javascript-escapes#unicode) instead of [hexadecimal escapes](https://mathiasbynens.be/notes/javascript-escapes#hexadecimal) for consistency and clarity.
 

diff --git a/docs/rules/no-instanceof-array.md b/docs/rules/no-instanceof-array.md
@@ -1,8 +1,11 @@
 # Require `Array.isArray()` instead of `instanceof Array`
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
 
 🔧 *This rule is [auto-fixable](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems).*
+<!-- /RULE_NOTICE -->
 
 The `instanceof Array` check doesn't work across realms/contexts, for example, frames/windows in browsers or the `vm` module in Node.js.
 

diff --git a/docs/rules/no-invalid-remove-event-listener.md b/docs/rules/no-invalid-remove-event-listener.md
@@ -1,6 +1,9 @@
 # Prevent calling `EventTarget#removeEventListener()` with the result of an expression
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
+<!-- /RULE_NOTICE -->
 
 The [`removeEventListener`](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener) function must be called with a reference to the same function that was passed to [`addEventListener`](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener). Calling `removeEventListener` with an inline function or the result of an inline `.bind()` call is indicative of an error, and won't actually remove the listener.
 

diff --git a/docs/rules/no-keyword-prefix.md b/docs/rules/no-keyword-prefix.md
@@ -1,5 +1,9 @@
 # Disallow identifiers starting with `new` or `class`
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
+<!-- /RULE_NOTICE -->
+
 `new Foo` and `newFoo` look very similar. Use alternatives that do not look like keyword usage.
 
 ## Fail

diff --git a/docs/rules/no-lonely-if.md b/docs/rules/no-lonely-if.md
@@ -1,8 +1,11 @@
 # Disallow `if` statements as the only statement in `if` blocks without `else`
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
 
 🔧 *This rule is [auto-fixable](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems).*
+<!-- /RULE_NOTICE -->
 
 This rule adds onto the built-in [`no-lonely-if`](https://eslint.org/docs/rules/no-lonely-if) rule, which only forbids `if` statements in `else`, not in `if`. It is recommended to use `unicorn/no-lonely-if` together with the core ESLint `no-lonely-if` rule.
 

diff --git a/docs/rules/no-nested-ternary.md b/docs/rules/no-nested-ternary.md
@@ -1,8 +1,11 @@
 # Disallow nested ternary expressions
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
 
 🔧 *This rule is [auto-fixable](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems).*
+<!-- /RULE_NOTICE -->
 
 Improved version of the [`no-nested-ternary`](https://eslint.org/docs/rules/no-nested-ternary) ESLint rule, which allows cases where the nested ternary is only one level and wrapped in parens.
 

diff --git a/docs/rules/no-new-array.md b/docs/rules/no-new-array.md
@@ -1,8 +1,11 @@
 # Disallow `new Array()`
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
 
 🔧💡 *This rule is [auto-fixable](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) and provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).*
+<!-- /RULE_NOTICE -->
 
 The ESLint built-in rule [`no-array-constructor`](https://eslint.org/docs/rules/no-array-constructor) enforces using an array literal instead of the `Array` constructor, but it still allows using the `Array` constructor with **one** argument. This rule fills that gap.
 

diff --git a/docs/rules/no-new-buffer.md b/docs/rules/no-new-buffer.md
@@ -1,8 +1,11 @@
 # Enforce the use of `Buffer.from()` and `Buffer.alloc()` instead of the deprecated `new Buffer()`
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
 
 🔧💡 *This rule is [auto-fixable](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) and provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).*
+<!-- /RULE_NOTICE -->
 
 Enforces the use of [Buffer.from](https://nodejs.org/api/buffer.html#buffer_class_method_buffer_from_array) and [Buffer.alloc()](https://nodejs.org/api/buffer.html#buffer_class_method_buffer_alloc_size_fill_encoding) instead of [new Buffer()](https://nodejs.org/api/buffer.html#buffer_new_buffer_array), which has been deprecated since Node.js 4.
 

diff --git a/docs/rules/no-null.md b/docs/rules/no-null.md
@@ -1,8 +1,11 @@
 # Disallow the use of the `null` literal
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
 
 🔧💡 *This rule is [auto-fixable](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) and provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).*
+<!-- /RULE_NOTICE -->
 
 Disallow the use of the `null` literal, to encourage using `undefined` instead.
 

diff --git a/docs/rules/no-object-as-default-parameter.md b/docs/rules/no-object-as-default-parameter.md
@@ -1,6 +1,9 @@
 # Disallow the use of objects as default parameters
 
+<!-- Do not manually modify RULE_NOTICE part -->
+<!-- RULE_NOTICE -->
 ✅ *This rule is part of the [recommended](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config) config.*
+<!-- /RULE_NOTICE -->
 
 Default parameters should not be passed to a function through an object literal. The `foo = {a: false}` parameter works fine if only used with one option. As soon as additional options are added, you risk replacing the whole `foo = {a: false, b: true}` object when passing only one option: `{a: true}`. For this reason, object destructuring should be used instead.