Adds eslint-plugin-eslint-plugin to ensure eslint-plugin-next rules follow ESLint rule best practices along with enforcing some consistency. (#37920)

* Adds eslint-plugin-eslint-plugin and recommended rules. * Removes `fixable` as none of the rules contain fixers. * Adds description and url rules. * Adds message format. * Removes optional dependencies. * Lints eslint-plugin-next tests too. * Removes optional dependencies from pnpm lock file. * Resets pnpm lock file. * Resets package.json too. * Fixes pnpm lockfile.
2022-08-07 23:52:02 -05:00 · 2022-08-07 23:52:02 -05:00 · ab48f54786
commit ab48f54786
parent 160da6b806
23 changed files with 78 additions and 12 deletions
--- a/.eslintrc.json
+++ b/.eslintrc.json
@ -145,6 +145,30 @@
          }
        ]
      }
+    },
+    {
+      "files": [
+        "packages/eslint-plugin-next/**/*.js",
+        "test/unit/eslint-plugin-next/**/*.test.ts"
+      ],
+      "extends": ["plugin:eslint-plugin/recommended"],
+      "parserOptions": {
+        "sourceType": "script"
+      },
+      "rules": {
+        "eslint-plugin/prefer-replace-text": "error",
+        "eslint-plugin/report-message-format": [
+          "error",
+          ".+\\. See: https://nextjs.org/docs/messages/[a-z\\-]+$"
+        ],
+        "eslint-plugin/require-meta-docs-description": [
+          "error",
+          {
+            "pattern": ".+"
+          }
+        ],
+        "eslint-plugin/require-meta-docs-url": "error"
+      }
    }
  ],
  "rules": {
--- a/package.json
+++ b/package.json
@ -126,6 +126,7 @@
    "escape-string-regexp": "2.0.0",
    "eslint": "7.24.0",
    "eslint-config-next": "workspace:*",
+    "eslint-plugin-eslint-plugin": "4.3.0",
    "eslint-plugin-import": "2.22.1",
    "eslint-plugin-jest": "24.3.5",
    "eslint-plugin-react": "7.23.2",
--- a/packages/eslint-plugin-next/lib/rules/google-font-display.js
+++ b/packages/eslint-plugin-next/lib/rules/google-font-display.js
@ -9,6 +9,8 @@ module.exports = {
      recommended: true,
      url,
    },
+    type: 'problem',
+    schema: [],
  },
  create: function (context) {
    return {
--- a/packages/eslint-plugin-next/lib/rules/google-font-preconnect.js
+++ b/packages/eslint-plugin-next/lib/rules/google-font-preconnect.js
@ -9,6 +9,8 @@ module.exports = {
      recommended: true,
      url,
    },
+    type: 'problem',
+    schema: [],
  },
  create: function (context) {
    return {
--- a/packages/eslint-plugin-next/lib/rules/inline-script-id.js
+++ b/packages/eslint-plugin-next/lib/rules/inline-script-id.js
@ -8,6 +8,8 @@ module.exports = {
      recommended: true,
      url,
    },
+    type: 'problem',
+    schema: [],
  },
  create: function (context) {
    let nextScriptImportName = null
--- a/packages/eslint-plugin-next/lib/rules/next-script-for-ga.js
+++ b/packages/eslint-plugin-next/lib/rules/next-script-for-ga.js
@ -25,8 +25,9 @@ module.exports = {
      recommended: true,
      url,
    },
+    type: 'problem',
+    schema: [],
  },
-  schema: [],
  create: function (context) {
    return {
      JSXOpeningElement(node) {
--- a/packages/eslint-plugin-next/lib/rules/no-assign-module-variable.js
+++ b/packages/eslint-plugin-next/lib/rules/no-assign-module-variable.js
@ -7,6 +7,8 @@ module.exports = {
      recommended: true,
      url,
    },
+    type: 'problem',
+    schema: [],
  },

  create: function (context) {
--- a/packages/eslint-plugin-next/lib/rules/no-before-interactive-script-outside-document.js
+++ b/packages/eslint-plugin-next/lib/rules/no-before-interactive-script-outside-document.js
@ -11,6 +11,8 @@ module.exports = {
      recommended: true,
      url,
    },
+    type: 'problem',
+    schema: [],
  },
  create: function (context) {
    let scriptImportName = null
--- a/packages/eslint-plugin-next/lib/rules/no-css-tags.js
+++ b/packages/eslint-plugin-next/lib/rules/no-css-tags.js
@ -7,8 +7,9 @@ module.exports = {
      recommended: true,
      url,
    },
+    type: 'problem',
+    schema: [],
  },
-  schema: [],
  create: function (context) {
    return {
      JSXOpeningElement(node) {
--- a/packages/eslint-plugin-next/lib/rules/no-document-import-in-page.js
+++ b/packages/eslint-plugin-next/lib/rules/no-document-import-in-page.js
@ -10,6 +10,8 @@ module.exports = {
      recommended: true,
      url,
    },
+    type: 'problem',
+    schema: [],
  },
  create: function (context) {
    return {
--- a/packages/eslint-plugin-next/lib/rules/no-duplicate-head.js
+++ b/packages/eslint-plugin-next/lib/rules/no-duplicate-head.js
@ -8,6 +8,8 @@ module.exports = {
      recommended: true,
      url,
    },
+    type: 'problem',
+    schema: [],
  },
  create: function (context) {
    let documentImportName
--- a/packages/eslint-plugin-next/lib/rules/no-head-element.js
+++ b/packages/eslint-plugin-next/lib/rules/no-head-element.js
@ -8,7 +8,8 @@ module.exports = {
      recommended: true,
      url,
    },
-    fixable: 'code',
+    type: 'problem',
+    schema: [],
  },
  create: function (context) {
    return {
--- a/packages/eslint-plugin-next/lib/rules/no-head-import-in-document.js
+++ b/packages/eslint-plugin-next/lib/rules/no-head-import-in-document.js
@ -9,6 +9,8 @@ module.exports = {
      recommended: true,
      url,
    },
+    type: 'problem',
+    schema: [],
  },
  create: function (context) {
    return {
--- a/packages/eslint-plugin-next/lib/rules/no-html-link-for-pages.js
+++ b/packages/eslint-plugin-next/lib/rules/no-html-link-for-pages.js
@ -30,7 +30,7 @@ module.exports = {
      recommended: true,
      url,
    },
-    fixable: null, // or "code" or "whitespace"
+    type: 'problem',
    schema: [
      {
        oneOf: [
--- a/packages/eslint-plugin-next/lib/rules/no-img-element.js
+++ b/packages/eslint-plugin-next/lib/rules/no-img-element.js
@ -8,7 +8,8 @@ module.exports = {
      recommended: true,
      url,
    },
-    fixable: 'code',
+    type: 'problem',
+    schema: [],
  },

  create: function (context) {
--- a/packages/eslint-plugin-next/lib/rules/no-page-custom-font.js
+++ b/packages/eslint-plugin-next/lib/rules/no-page-custom-font.js
@ -10,6 +10,8 @@ module.exports = {
      recommended: true,
      url,
    },
+    type: 'problem',
+    schema: [],
  },
  create: function (context) {
    const paths = context.getFilename().split('pages')
--- a/packages/eslint-plugin-next/lib/rules/no-script-component-in-head.js
+++ b/packages/eslint-plugin-next/lib/rules/no-script-component-in-head.js
@ -8,6 +8,8 @@ module.exports = {
      recommended: true,
      url,
    },
+    type: 'problem',
+    schema: [],
  },
  create: function (context) {
    let isNextHead = null
--- a/packages/eslint-plugin-next/lib/rules/no-styled-jsx-in-document.js
+++ b/packages/eslint-plugin-next/lib/rules/no-styled-jsx-in-document.js
@ -9,7 +9,8 @@ module.exports = {
      recommended: true,
      url,
    },
-    fixable: 'code',
+    type: 'problem',
+    schema: [],
  },
  create: function (context) {
    return {
@ -44,5 +45,3 @@ module.exports = {
    }
  },
 }
-
-module.exports.schema = []
--- a/packages/eslint-plugin-next/lib/rules/no-sync-scripts.js
+++ b/packages/eslint-plugin-next/lib/rules/no-sync-scripts.js
@ -7,8 +7,9 @@ module.exports = {
      recommended: true,
      url,
    },
+    type: 'problem',
+    schema: [],
  },
-  schema: [],
  create: function (context) {
    return {
      JSXOpeningElement(node) {
--- a/packages/eslint-plugin-next/lib/rules/no-title-in-document-head.js
+++ b/packages/eslint-plugin-next/lib/rules/no-title-in-document-head.js
@ -8,6 +8,8 @@ module.exports = {
      recommended: true,
      url,
    },
+    type: 'problem',
+    schema: [],
  },
  create: function (context) {
    let headFromNextDocument = false
--- a/packages/eslint-plugin-next/lib/rules/no-typos.js
+++ b/packages/eslint-plugin-next/lib/rules/no-typos.js
@ -39,14 +39,15 @@ function minDistance(a, b) {
  return previousRow[previousRow.length - 1]
 }

+/* eslint-disable eslint-plugin/require-meta-docs-url */
 module.exports = {
  meta: {
    docs: {
      description: 'Prevent common typos in Next.js data fetching functions.',
-      category: 'Stylistic Issues',
      recommended: true,
    },
-    fixable: null,
+    type: 'problem',
+    schema: [],
  },

  create: function (context) {
--- a/packages/eslint-plugin-next/lib/rules/no-unwanted-polyfillio.js
+++ b/packages/eslint-plugin-next/lib/rules/no-unwanted-polyfillio.js
@ -72,7 +72,8 @@ module.exports = {
      recommended: true,
      url,
    },
-    fixable: null,
+    type: 'problem',
+    schema: [],
  },

  create: function (context) {
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@ -89,6 +89,7 @@ importers:
      escape-string-regexp: 2.0.0
      eslint: 7.24.0
      eslint-config-next: workspace:*
+      eslint-plugin-eslint-plugin: 4.3.0
      eslint-plugin-import: 2.22.1
      eslint-plugin-jest: 24.3.5
      eslint-plugin-react: 7.23.2
@ -243,6 +244,7 @@ importers:
      escape-string-regexp: 2.0.0
      eslint: 7.24.0
      eslint-config-next: link:packages/eslint-config-next
+      eslint-plugin-eslint-plugin: 4.3.0_eslint@7.24.0
      eslint-plugin-import: 2.22.1_23iivq3ybsthf4qrv3kgatrvhe
      eslint-plugin-jest: 24.3.5_lqson4bxnnkvr5juyhnlzmz4rq
      eslint-plugin-react: 7.23.2_eslint@7.24.0
@ -10326,6 +10328,17 @@ packages:
      - supports-color
    dev: true

+  /eslint-plugin-eslint-plugin/4.3.0_eslint@7.24.0:
+    resolution: {integrity: sha512-0xZ++ilIpGY+gBwsaW/uIhG/Rrl/sltPCai3UUPzWbaOPud2tel9UCWj8sLTADNmVqBD+vcqLHzHY86q/b71yg==}
+    engines: {node: ^12.22.0 || ^14.17.0 || >=16.0.0}
+    peerDependencies:
+      eslint: '>=6.0.0'
+    dependencies:
+      eslint: 7.24.0
+      eslint-utils: 3.0.0_eslint@7.24.0
+      estraverse: 5.3.0
+    dev: true
+
  /eslint-plugin-import/2.22.1_23iivq3ybsthf4qrv3kgatrvhe:
    resolution: {integrity: sha512-8K7JjINHOpH64ozkAhpT3sd+FswIZTfMZTjdx052pnWrgRCVfp8op9tbjpAk3DdUeI/Ba4C8OjdC0r90erHEOw==}
    engines: {node: '>=4'}