@prowise/eslint-config-linting-rules 2.4.7 → 3.0.0

package/rules/plugin-jsdoc-rules.js

@@ -1,4 +1,7 @@
 import jsdocPlugin from "eslint-plugin-jsdoc";
+import jsdocNewlineBeforeReturns from "./jsdoc-newline-before-returns.js";
+import jsdocOptionalParamBrackets from "./jsdoc-optional-param-brackets.js";
+import jsdocSingleLine from "./jsdoc-single-line.js";
 
 export default {
     /*
@@ -9,61 +12,52 @@ export default {
      * 💭 requires type information
      */
 
-    plugins: { jsdoc: jsdocPlugin },
+    plugins: {
+        "jsdoc": jsdocPlugin,
+        "jsdoc-x": {
+            rules: {
+                "newline-before-returns": jsdocNewlineBeforeReturns,
+                "optional-param-brackets": jsdocOptionalParamBrackets,
+                "single-line": jsdocSingleLine,
+            },
+        },
+    },
 
     rules: {
         /**
          * Checks that `@access` tags have a valid value ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-access.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-access.md
          */
-        "jsdoc/check-access": "warn",
+        "jsdoc/check-access": "error",
 
         /**
          * Reports invalid alignment of JSDoc block asterisks ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-alignment.
-         */
-        "jsdoc/check-alignment": "warn",
-
-        /**
-         * Ensures that (JavaScript) examples within JSDoc adhere to ESLint rules
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-examples.
-         */
-        // "jsdoc/check-examples": "off",
-
-        /**
-         * Reports invalid padding inside JSDoc blocks
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-indentation.
-         */
-        // "jsdoc/check-indentation": "off",
-
-        /**
-         * Reports invalid alignment of JSDoc block lines
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-line-alignment.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-alignment.md
          */
-        // "jsdoc/check-line-alignment": "off",
+        "jsdoc/check-alignment": "error",
 
         /**
          * Ensures that parameter names in JSDoc match those in the function declaration ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-param-names.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-param-names.md
          */
-        "jsdoc/check-param-names": ["warn", { checkDestructured: false, allowExtraTrailingParamDocs: true }],
+        "jsdoc/check-param-names": ["error", { checkDestructured: false, allowExtraTrailingParamDocs: true }],
 
         /**
          * Ensures that property names in JSDoc are not duplicated on the same block and that nested
          * properties have defined roots ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-property-names.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-property-names.md
          */
         "jsdoc/check-property-names": "warn",
 
         /**
          * Reports against syntax not valid for the mode (e.g., Google Closure Compiler in non-Closure mode)
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-syntax.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-syntax.md
          */
         "jsdoc/check-syntax": "warn",
 
         /**
          * Reports invalid block tag names ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-tag-names.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-tag-names.md
          * Defined tags are valid typedoc tags
          */
         "jsdoc/check-tag-names": ["warn", {
@@ -91,31 +85,31 @@ export default {
 
         /**
          * Reports invalid types ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-types.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-types.md
          */
         "jsdoc/check-types": "warn",
 
         /**
          * This rule checks the values for a handful of tags: `@version`, `@since`, `@license` and `@author` ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-values.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-values.md
          */
         "jsdoc/check-values": "warn",
 
         /**
          * Expects specific tags to be empty of any content ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-empty-tags.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/empty-tags.md
          */
         "jsdoc/empty-tags": "warn",
 
         /**
          * Reports an issue with any non-constructor function using `@implements ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-implements-on-classes.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/implements-on-classes.md
          */
         "jsdoc/implements-on-classes": "warn",
 
         /**
          * Enforces a regular expression pattern on descriptions
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-match-description.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/match-description.md
          */
         "jsdoc/match-description": [
             "error",
@@ -126,107 +120,61 @@ export default {
         ],
         /**
          * Controls how and whether jsdoc blocks can be expressed as single or multiple line blocks ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-multiline-blocks.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/multiline-blocks.md
          */
         "jsdoc/multiline-blocks": "warn",
 
         /**
          * This rule checks for multi-line-style comments which fail to meet the criteria of a jsdoc block
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-bad-blocks.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-bad-blocks.md
          */
         "jsdoc/no-bad-blocks": "warn",
 
         /**
          * His rule reports defaults being used on the relevant portion of `@param` or `@default`
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-defaults.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-defaults.md
          */
         "jsdoc/no-defaults": "warn",
 
         /**
-         * Reports when certain comment structures are always expected
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-missing-syntax.
-         */
-        // "jsdoc/no-missing-syntax": "off",
-
-        /**
-         * ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-multi-asterisks.
+         * Prevents use of multiple asterisks at the beginning of lines. ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-multi-asterisks.md
          */
         "jsdoc/no-multi-asterisks": "warn",
 
-        /**
-         * Reports when certain comment structures are present
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-restricted-syntax.
-         */
-        // "jsdoc/no-restricted-syntax": "off",
-
         /**
          * This rule reports types being used on `@param` or `@returns`
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-types.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-types.md
          */
         "jsdoc/no-types": "warn",
 
         /**
          * Checks that types in jsdoc comments are defined ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-undefined-types.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-undefined-types.md
          */
         "jsdoc/no-undefined-types": "warn",
 
         /**
          * Checks that types in jsdoc comments are defined
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-undefined-types.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-undefined-types.md
          */
         "jsdoc/require-asterisk-prefix": "warn",
 
         /**
          * Requires that all functions have a description
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-description.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-description.md
          */
-        "jsdoc/require-description": "warn",
+        "jsdoc/require-description": "error",
 
         /**
-         * Requires that block description, explicit `@description`, and `@param`/`@returns`
-         * tag descriptions are written in complete sentences
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-description-complete-sentence.
-         *
-         * This is disabled for the following reason:
-         *
-         * - It makes a lot of mistakes, such as considering two words a sentence
-         *      or considering an URL a sentence.
-         * - It gets in the way of developer productivity, if you need a spell checker
-         *      or sentence tool, install one in your IDE.
-         * - The autofixer is very liberal with its autofixing of dots at the end
-         *      of the sentence, which often leads to wrong dots. Therefore, readability
-         *      actually gets worse.
-         *
-         * In conclusion, if you write JSDocs, please actually take time to write,
-         * instead of relying on some broken jsdoc rule.
-         *
-         * If you cannot do that, PR reviewers should call you out on it.
+         * Requires a hyphen before the `@param` description (and optionally before `@property` descriptions).
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-hyphen-before-param-description.md
          */
-        // "jsdoc/require-description-complete-sentence": "off",
-
-        /**
-         * Requires that all functions have examples
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-example.
-         */
-        // "jsdoc/require-example": "off",
-
-        /**
-         * Checks that all files have one `@file`, `@fileoverview`, or `@overview` tag at the beginning of the file
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-file-overview.
-         */
-        // "jsdoc/require-file-overview": "off",
-
-        /**
-         * Requires a hyphen before the `@param` description
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-hyphen-before-param-description.
-         */
-        // "jsdoc/require-hyphen-before-param-description": "off",
+        "jsdoc/require-hyphen-before-param-description": ["error", "always"],
 
         /**
          * Require JSDoc comments ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-jsdoc.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-jsdoc.md
          */
         "jsdoc/require-jsdoc": [
             "error",
@@ -257,105 +205,122 @@ export default {
 
         /**
          * Requires that all function parameters are documented ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param.md
          */
-        "jsdoc/require-param": "warn",
+        "jsdoc/require-param": ["error", { checkDestructured: false }],
 
         /**
          * Requires that each `@param` tag has a `description` value ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param-description.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param-description.md
          */
-        "jsdoc/require-param-description": "warn",
+        "jsdoc/require-param-description": "error",
 
         /**
          * Requires that all function parameters have names ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param-name.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param-name.md
          */
-        "jsdoc/require-param-name": "warn",
+        "jsdoc/require-param-name": "error",
 
         /**
          * Requires that each `@param` tag has a `type` value ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param-type.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param-type.md
          */
-        // "jsdoc/require-param-type": "off",
+        "jsdoc/require-param-type": "off",
 
         /**
          * Requires that all `@typedef` and `@namespace` tags have `@property` when their type ✅
          * is a plain `object`, `Object`, or `PlainObject
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-property.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property.md
          */
-        // "jsdoc/require-property": "off",
+        "jsdoc/require-property": "off",
 
         /**
          * Requires that each `@property` tag has a `description` value ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-property-description.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-description.md
          */
         "jsdoc/require-property-description": "warn",
 
         /**
          * Requires that all function `@property` tags have names ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-property-name.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-name.md
          */
         "jsdoc/require-property-name": "warn",
 
         /**
          * Requires that each `@property` tag has a `type` value ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-property-type.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-type.md
          */
         "jsdoc/require-property-type": "warn",
 
         /**
          * Requires that returns are documented ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns.md
          */
         "jsdoc/require-returns": "warn",
 
         /**
          * Requires a return statement in function body if a `@returns` tag is specified in jsdoc comment ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns-check.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-check.md
          */
         "jsdoc/require-returns-check": "warn",
 
         /**
          * Requires that the `@returns` tag has a `description` value ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns-description.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-description.md
          */
         "jsdoc/require-returns-description": "warn",
 
         /**
          * Requires that `@returns` tag has `type` value ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns-type.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-type.md
          */
         // "jsdoc/require-returns-type": "off",
 
         /**
          * Requires that throw statements are documented
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-throws.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-throws.md
          */
-        "jsdoc/require-throws": "warn",
+        "jsdoc/require-throws": "off",
 
         /**
          * Requires yields are documented ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-yields.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields.md
          */
         "jsdoc/require-yields": "warn",
 
         /**
          * Requires a yield statement in function body if a `@yields` tag is specified in jsdoc comment ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-yields-check.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields-check.md
          */
         "jsdoc/require-yields-check": "warn",
 
         /**
          * Enforces lines (or no lines) between tags ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-tag-lines.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/tag-lines.md
          */
         "jsdoc/tag-lines": ["warn", "any", { startLines: 1 }],
 
         /**
          * Requires all types to be valid JSDoc or Closure compiler types without syntax errors ✅
-         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-valid-types.
+         * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/valid-types.md
          */
         "jsdoc/valid-types": "warn",
+
+        /**
+         * Enforce a blank JSDoc line immediately before the @returns tag.
+         */
+        "jsdoc-x/newline-before-returns": "off",
+
+        /**
+         * Enforce brackets around optional parameter names in JSDoc @param tags.
+         * When a parameter has a `?` in its TypeScript signature or has a default value,
+         * the JSDoc @param tag should use brackets: `@param [paramName]` instead of `@param paramName`.
+         */
+        "jsdoc-x/optional-param-brackets": "off",
+
+        /**
+         * Enforce single-line JSDoc comments to use inline format.
+         */
+        "jsdoc-x/single-line": "off",
     },
 };

package/rules/plugin-jsx-a11y-rules.js

@@ -1,4 +1,4 @@
-import jsxA11yPlugin from "eslint-plugin-jsx-a11y";
+import jsxA11yPlugin from "@htmlacademy/eslint-plugin-jsx-a11y";
 
 export default {
     /*

package/rules/plugin-next-rules.js

@@ -1,107 +1,99 @@
 import nextPlugin from "@next/eslint-plugin-next";
 
-/*
-    * ✅ recommended
-    * 🔒 strict
-    * 🔧 fixable
-    * 💡 has suggestion
-    * 💭 requires type information
-    */
-
 export default {
+    /*
+     * ✅ recommended
+     * 🔒 strict
+     * 🔧 fixable
+     * 💡 has suggestion
+     * 💭 requires type information
+     */
+
     plugins: {
         next: nextPlugin,
     },
 
     rules: {
-        // warnings
-
         /**
-         * Enforce font-display behavior with Google Fonts.
+         * Enforce font-display behavior with Google Fonts. ✅
          * https://nextjs.org/docs/messages/google-font-display
          */
         "next/google-font-display": "warn",
 
         /**
-         * Ensure preconnect is used with Google Fonts.
+         * Ensure preconnect is used with Google Fonts. ✅
          * https://nextjs.org/docs/messages/google-font-preconnect
          */
         "next/google-font-preconnect": "warn",
 
         /**
-         * Prefer next/script component when using the inline script for Google Analytics.
+         * Prefer next/script component when using the inline script for Google Analytics. ✅
          * https://nextjs.org/docs/messages/next-script-for-ga
          */
         "next/next-script-for-ga": "warn",
 
         /**
-         * Prevent client components from being async functions.
+         * Prevent client components from being async functions. ✅
          * https://nextjs.org/docs/messages/no-async-client-component
          */
         "next/no-async-client-component": "warn",
 
         /**
-         * Prevent usage of next/script's beforeInteractive strategy outside of pages/_document.js.
+         * Prevent usage of next/script's beforeInteractive strategy outside of pages/_document.js. ✅
          * https://nextjs.org/docs/messages/no-before-interactive-script-outside-document
          */
         "next/no-before-interactive-script-outside-document": "warn",
 
         /**
-         * Prevent manual stylesheet tags.
+         * Prevent manual stylesheet tags. ✅
          * https://nextjs.org/docs/messages/no-css-tags
          */
         "next/no-css-tags": "warn",
 
         /**
-         * Prevent usage of <head> element.
+         * Prevent usage of <head> element. ✅
          * https://nextjs.org/docs/messages/no-head-element
          */
         "next/no-head-element": "warn",
 
         /**
-         * Prevent usage of <a> elements to navigate to internal Next.js pages.
-         * https://nextjs.org/docs/messages/no-html-link-for-pages
-         */
-        "next/no-html-link-for-pages": "warn",
-
-        /**
-         * Prevent usage of <img> element due to slower LCP and higher bandwidth.
+         * Prevent usage of <img> element due to slower LCP and higher bandwidth. ✅
          * https://nextjs.org/docs/messages/no-img-element
          */
         "next/no-img-element": "warn",
 
         /**
          * Prevent page-only custom fonts.
-         * https://nextjs.org/docs/messages/no-page-custom-font
+         * https://nextjs.org/docs/messages/no-page-custom-font ✅
          */
         "next/no-page-custom-font": "warn",
 
         /**
-         * Prevent usage of styled-jsx in pages/_document.js.
+         * Prevent usage of styled-jsx in pages/_document.js. ✅
          * https://nextjs.org/docs/messages/no-styled-jsx-in-document
          */
         "next/no-styled-jsx-in-document": "warn",
 
         /**
-         * Prevent synchronous scripts.
+         * Prevent synchronous scripts. ✅
          * https://nextjs.org/docs/messages/no-sync-scripts
          */
         "next/no-sync-scripts": "warn",
 
         /**
-         * Prevent usage of <title> with Head component from next/document.
+         * Prevent usage of <title> with Head component from next/document. ✅
          * https://nextjs.org/docs/messages/no-title-in-document-head
          */
         "next/no-title-in-document-head": "warn",
 
         /**
-         * Prevent common typos in Next.js's data fetching functions
+         * Prevent common typos in Next.js's data fetching functions. ✅
          * https://nextjs.org/docs
          */
         "next/no-typos": "warn",
 
         /**
-         * Prevent duplicate polyfills from Polyfill.io.
+         * Prevent duplicate polyfills from Polyfill.io. ✅
          * https://nextjs.org/docs/messages/no-unwanted-polyfillio
          */
         "next/no-unwanted-polyfillio": "warn",
@@ -109,37 +101,37 @@ export default {
         // errors
 
         /**
-         * Enforce id attribute on next/script components with inline content
+         * Enforce id attribute on next/script components with inline content. ✅
          * https://nextjs.org/docs/messages/inline-script-id
          */
         "next/inline-script-id": "error",
 
         /**
-         * Prevent assignment to the module variable.
+         * Prevent assignment to the module variable. ✅
          * https://nextjs.org/docs/messages/no-assign-module-variable
          */
         "next/no-assign-module-variable": "error",
 
         /**
-         * Prevent importing next/document outside of pages/_document.js
+         * Prevent importing next/document outside of pages/_document.js ✅
          * https://nextjs.org/docs/messages/no-document-import-in-page
          */
         "next/no-document-import-in-page": "error",
 
         /**
-         * Prevent duplicate usage of <Head> in pages/_document.js
+         * Prevent duplicate usage of <Head> in pages/_document.js ✅
          * https://nextjs.org/docs/messages/no-duplicate-head
          */
         "next/no-duplicate-head": "error",
 
         /**
-         * Prevent usage of next/head in pages/_document.js.
+         * Prevent usage of next/head in pages/_document.js. ✅
          * https://nextjs.org/docs/messages/no-head-import-in-document
          */
         "next/no-head-import-in-document": "error",
 
         /**
-         * Prevent usage of next/script in next/head component.
+         * Prevent usage of next/script in next/head component. ✅
          * https://nextjs.org/docs/messages/no-script-component-in-head
          */
         "next/no-script-component-in-head": "error",