Eslint config: re-enable @next/next/no-html-link-for-pages rule

Closes: adeira/universe#3024

adeira-source-id: 4252a6329a11cf25030834dad4d19d6307a567a1

Author: mrtnzlml

CHANGELOG.md

@@ -1,7 +1,24 @@
 # Unreleased
 
 - New rules `@next/next/inline-script-id`, `@next/next/no-script-in-document` and `@next/next/no-script-in-head` enabled (as warnings). For more information visit: https://nextjs.org/docs/basic-features/eslint#eslint-plugin
-- Rule `@next/next/no-html-link-for-pages` has been temporarily disabled because of [internal issues](https://github.com/adeira/universe/issues/3024).
+- We clarified what to do when you are using `@adeira/eslint-config/next` preset inside monorepo (check our readme). Basically, you might encounter the following warning:
+
+  ```text
+  Pages directory cannot be found at /X/Y/Z/pages or /X/Y/Z/src/pages. If using a custom path, please configure with the no-html-link-for-pages rule in your eslint config file
+  ```
+
+  In this case it's necessary to configure the Next.js eslint preset explicitly, for example:
+
+  ```js
+  module.exports = {
+    extends: ['@adeira/eslint-config', '@adeira/eslint-config/next'],
+    settings: {
+      next: { rootDir: __dirname },
+    },
+  };
+  ```
+
+  For more info visit: https://nextjs.org/docs/messages/no-html-link-for-pages
 
 # 6.4.0
 
@@ -13,14 +30,14 @@
 
 - Added new optional config preset `@adeira/eslint-config/next` (for [Next.js](https://nextjs.org/) applications). This preset is not included in the default config and should be enabled explicitly for Next.js applications. For example:
 
-```js
-module.exports = {
-  extends: [
-    '@adeira/eslint-config', // this preset includes almost everything but not Next.js rules
-    '@adeira/eslint-config/next', // adds extra Next.js rules for your application
-  ],
-};
-```
+  ```js
+  module.exports = {
+    extends: [
+      '@adeira/eslint-config', // this preset includes almost everything but not Next.js rules
+      '@adeira/eslint-config/next', // adds extra Next.js rules for your application
+    ],
+  };
+  ```
 
 # 6.2.0
 

README.md

@@ -95,6 +95,12 @@ module.exports = {
     '@adeira/eslint-config',
     '@adeira/eslint-config/next', // optional Next.js rules not included by default
   ],
+
+  // The following settings might be needed in case you are trying to apply Next.js preset inside
+  // monorepo subdirectory, see: https://nextjs.org/docs/basic-features/eslint#rootdir
+  settings: {
+    next: { rootDir: __dirname },
+  },
 };
 ```
 

__tests__/__snapshots__/presets.test.js.snap

@@ -750,7 +750,7 @@ Object {
     "@next/next/no-document-import-in-page": 1,
     "@next/next/no-duplicate-head": 1,
     "@next/next/no-head-import-in-document": 1,
-    "@next/next/no-html-link-for-pages": 0,
+    "@next/next/no-html-link-for-pages": 1,
     "@next/next/no-img-element": 1,
     "@next/next/no-page-custom-font": 1,
     "@next/next/no-script-in-document": 1,

src/presets/next.js

@@ -21,7 +21,7 @@ module.exports = ({
     '@next/next/no-document-import-in-page': NEXT_VERSION_ERROR,
     '@next/next/no-duplicate-head': NEXT_VERSION_ERROR,
     '@next/next/no-head-import-in-document': NEXT_VERSION_ERROR,
-    '@next/next/no-html-link-for-pages': OFF, // TODO: https://github.com/adeira/universe/issues/3024
+    '@next/next/no-html-link-for-pages': NEXT_VERSION_ERROR,
     '@next/next/no-img-element': NEXT_VERSION_ERROR,
     '@next/next/no-page-custom-font': NEXT_VERSION_ERROR,
     '@next/next/no-script-in-document': NEXT_VERSION_ERROR,