Adds tests to ensure eslint-plugin-next's available rules are properly exported and recommended rules are correctly defined. (vercel#38183)

* Adds tests to ensure `eslint-plugin-next`'s available rules are properly exported and recommended rules are defined correctly.

* Condenses imports.

* Sets default recommended value.

* replace Object.hasOwn for node 14

Co-authored-by: JJ Kasper <[email protected]>

Author: manovotny

package.json

@@ -144,6 +144,7 @@
     "is-animated": "2.0.2",
     "isomorphic-unfetch": "3.0.0",
     "jest": "27.0.6",
+    "jest-extended": "1.2.1",
     "ky": "0.19.1",
     "ky-universal": "0.6.0",
     "lerna": "4.0.0",

packages/eslint-plugin-next/lib/rules/no-title-in-document-head.js

@@ -5,6 +5,7 @@ module.exports = {
     docs: {
       description:
         'Prevent usage of `<title>` with `Head` component from `next/document`.',
+      recommended: true,
       url,
     },
   },

pnpm-lock.yaml

@@ -1,3 +1,6 @@
+import * as matchers from 'jest-extended'
+expect.extend(matchers)
+
 // A default max-timeout of 90 seconds is allowed
 // per test we should aim to bring this down though
 jest.setTimeout((process.platform === 'win32' ? 180 : 90) * 1000)

test/jest-setup-after-env.ts

@@ -0,0 +1 @@
+import 'jest-extended'

test/jest.d.ts

@@ -0,0 +1,28 @@
+import { basename } from 'path'
+import glob from 'glob'
+import index from '@next/eslint-plugin-next'
+
+const getRuleNameFromRulePath = (path) => basename(path, '.js')
+const rulePaths = glob.sync('packages/eslint-plugin-next/lib/rules/*js', {
+  absolute: true,
+})
+
+describe('@next/eslint-plugin-next index', () => {
+  it('should include all defined rules and no extra / undefined rules', () => {
+    const rules = rulePaths.map((rulePath) => getRuleNameFromRulePath(rulePath))
+
+    expect(index.rules).toContainAllKeys(rules)
+  })
+
+  rulePaths.forEach((rulePath) => {
+    const rule = require(rulePath)
+    const ruleName = getRuleNameFromRulePath(rulePath)
+    const { recommended = false } = rule.meta.docs
+
+    it(`${ruleName}: recommend should be \`${recommended}\``, () => {
+      expect(`@next/next/${ruleName}` in index.configs.recommended.rules).toBe(
+        recommended
+      )
+    })
+  })
+})

test/unit/eslint-plugin-next/index.test.ts

@@ -18,6 +18,7 @@
     }
   },
   "include": [
+    "test/jest.d.ts",
     "test/**/*.test.ts",
     "test/**/*.test.tsx",
     "test/**/test/*",