From 5105b9848a6ed57512697f3c80d198dcdabfdbae Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Fri, 3 Feb 2023 17:10:51 +0100
Subject: [PATCH] eslint-plugin: add docs for no-relative-monorepo-imports

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
---
 .../rules/no-relative-monorepo-imports.md     | 43 +++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 packages/eslint-plugin/docs/rules/no-relative-monorepo-imports.md

diff --git a/packages/eslint-plugin/docs/rules/no-relative-monorepo-imports.md b/packages/eslint-plugin/docs/rules/no-relative-monorepo-imports.md
new file mode 100644
index 0000000000..6a41a73fb6
--- /dev/null
+++ b/packages/eslint-plugin/docs/rules/no-relative-monorepo-imports.md
@@ -0,0 +1,43 @@
+# @backstage/no-relative-monorepo-imports
+
+Forbid relative imports that reach outside of the package in a monorepo.
+
+## Usage
+
+Add the rules as follows, it has no options:
+
+```js
+"@backstage/no-relative-monorepo-imports": ["error"]
+```
+
+The following patterns are considered files used during development, and only need dependencies to be declared in devDependencies:
+
+```python
+!src/**  # Any files outside of src are considered dev files
+src/**/*.test.*
+src/**/*.stories.*
+src/**/__testUtils__/**
+src/**/__mocks__/**
+src/setupTests.*
+```
+
+## Rule Details
+
+Assuming an import from for example `plugins/bar/src/index.ts`:
+
+### Fail
+
+```ts
+import { FooCard } from '../../foo';
+
+import { FooCard } from '../../foo/src/components/FooCard';
+```
+
+### Pass
+
+```ts
+import { FooCard } from '@internal/plugin-foo';
+
+// This is allowed by this rule, but not by no-forbidden-package-imports
+import { FooCard } from '@internal/plugin-foo/src/components/FooCard';
+```