apply no-html-link-for-pages rule to app directory

vercel · Jul 24, 2024 · 40bc839 · 40bc839
1 parent 91dc0a0
commit 40bc839
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 1 deletion.
diff --git a/packages/eslint-plugin-next/src/rules/no-html-link-for-pages.ts b/packages/eslint-plugin-next/src/rules/no-html-link-for-pages.ts
@@ -93,6 +93,8 @@ export = defineRule({
     }
 
     const pageUrls = getUrlFromPagesDirectories('/', foundPagesDirs)
+    const appUrls = getUrlFromPagesDirectories('/', foundAppDirs)
+
     return {
       JSXOpeningElement(node) {
         if (node.name.name !== 'a') {
@@ -134,7 +136,7 @@ export = defineRule({
           return
         }
 
-        pageUrls.forEach((pageUrl) => {
+        ;[...pageUrls, ...appUrls].forEach((pageUrl) => {
           if (pageUrl.test(normalizeURL(hrefPath))) {
             context.report({
               node,

diff --git a/test/unit/eslint-plugin-next/no-html-link-for-pages.test.ts b/test/unit/eslint-plugin-next/no-html-link-for-pages.test.ts
@@ -251,6 +251,13 @@ describe('no-html-link-for-pages', function () {
     assert.deepEqual(report, [])
   })
 
+  it('valid link element with app linter', function () {
+    const report = withAppLinter.verify(validCode, linterConfig, {
+      filename: 'foo.js',
+    })
+    assert.deepEqual(report, [])
+  })
+
   it('valid link element with multiple directories', function () {
     const report = withCustomPagesLinter.verify(
       validCode,
@@ -332,6 +339,21 @@ describe('no-html-link-for-pages', function () {
     )
   })
 
+  it('invalid static route with app directory linter', function () {
+    const [report] = withAppLinter.verify(
+      invalidStaticCode,
+      linterConfigWithCustomDirectory,
+      {
+        filename: 'foo.js',
+      }
+    )
+    assert.notEqual(report, undefined, 'No lint errors found.')
+    assert.equal(
+      report.message,
+      'Do not use an `<a>` element to navigate to `/`. Use `<Link />` from `next/link` instead. See: https://nextjs.org/docs/messages/no-html-link-for-pages'
+    )
+  })
+
   it('invalid dynamic route', function () {
     const [report] = withCustomPagesLinter.verify(
       invalidDynamicCode,