From 71bf2eb0ed63c7fc3482d3d043e055ac865cb418 Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Fri, 3 Feb 2023 17:20:24 +0100
Subject: [PATCH] eslint-plugin: add doc rule links and update README

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
---
 packages/eslint-plugin/README.md                          | 8 +++++---
 .../eslint-plugin/rules/no-forbidden-package-imports.js   | 5 +++++
 .../eslint-plugin/rules/no-relative-monorepo-imports.js   | 5 +++++
 packages/eslint-plugin/rules/no-undeclared-imports.js     | 5 +++++
 4 files changed, 20 insertions(+), 3 deletions(-)

diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md
index a063d801d3..c311670603 100644
--- a/packages/eslint-plugin/README.md
+++ b/packages/eslint-plugin/README.md
@@ -35,6 +35,8 @@ rules: {
 
 The following rules are provided by this plugin:
 
-| Rule                                      | Description                                                                     |
-| ----------------------------------------- | ------------------------------------------------------------------------------- |
-| `@backstage/no-forbidden-package-imports` | Disallow internal monorepo imports from package subpaths that are not exported. |
+| Rule                                                                                    | Description                                                                                                              |
+| --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
+| [@backstage/no-forbidden-package-imports](./docs/rules/no-forbidden-package-imports.md) | Disallow internal monorepo imports from package subpaths that are not exported.                                          |
+| [@backstage/no-relative-monorepo-imports](./docs/rules/no-relative-monorepo-imports.md) | Forbid relative imports that reach outside of the package in a monorepo.                                                 |
+| [@backstage/no-undeclared-imports](./docs/rules/no-undeclared-imports.md)               | Forbid imports of external packages that have not been declared in the appropriate dependencies field in `package.json`. |
diff --git a/packages/eslint-plugin/rules/no-forbidden-package-imports.js b/packages/eslint-plugin/rules/no-forbidden-package-imports.js
index 6c861e17f5..e7c1acca27 100644
--- a/packages/eslint-plugin/rules/no-forbidden-package-imports.js
+++ b/packages/eslint-plugin/rules/no-forbidden-package-imports.js
@@ -25,6 +25,11 @@ module.exports = {
     messages: {
       forbidden: '{{packageName}} does not export {{subPath}}',
     },
+    docs: {
+      description:
+        'Disallow internal monorepo imports from package subpaths that are not exported.',
+      url: 'https://github.com/backstage/backstage/blob/master/packages/eslint-plugin/docs/rules/no-forbidden-package-imports.md',
+    },
   },
   create(context) {
     return visitImports(context, (node, imp) => {
diff --git a/packages/eslint-plugin/rules/no-relative-monorepo-imports.js b/packages/eslint-plugin/rules/no-relative-monorepo-imports.js
index cb18eb506c..df30d35f67 100644
--- a/packages/eslint-plugin/rules/no-relative-monorepo-imports.js
+++ b/packages/eslint-plugin/rules/no-relative-monorepo-imports.js
@@ -29,6 +29,11 @@ module.exports = {
       forbidden:
         "Relative imports of monorepo packages are forbidden, use '{{newImport}}' instead",
     },
+    docs: {
+      description:
+        'Forbid relative imports that reach outside of the package in a monorepo.',
+      url: 'https://github.com/backstage/backstage/blob/master/packages/eslint-plugin/docs/rules/no-relative-monorepo-imports.md',
+    },
   },
   create(context) {
     const packages = getPackageMap(context.getCwd());
diff --git a/packages/eslint-plugin/rules/no-undeclared-imports.js b/packages/eslint-plugin/rules/no-undeclared-imports.js
index 4a8756b71e..4f60b712d9 100644
--- a/packages/eslint-plugin/rules/no-undeclared-imports.js
+++ b/packages/eslint-plugin/rules/no-undeclared-imports.js
@@ -125,6 +125,11 @@ module.exports = {
       switch:
         '{{ packageName }} is declared in {{ oldDepsField }}, but should be moved to {{ depsField }} in {{ packageJsonPath }}.',
     },
+    docs: {
+      description:
+        'Forbid imports of external packages that have not been declared in the appropriate dependencies field in `package.json`.',
+      url: 'https://github.com/backstage/backstage/blob/master/packages/eslint-plugin/docs/rules/no-undeclared-imports.md',
+    },
   },
   create(context) {
     const packages = getPackageMap(context.getCwd());