fix: document differences from eslint

gajus · Oct 12, 2023 · c92ebd1 · c92ebd1
1 parent b2864a9
commit c92ebd1
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/.README/rules/no-restricted-imports.md b/.README/rules/no-restricted-imports.md
@@ -4,4 +4,6 @@ Disallow specified modules when loaded by `import`
 
 This rule is similar to [`no-restricted-imports`](https://eslint.org/docs/latest/rules/no-restricted-imports) except that it allows you to specify unique messages for each restricted import (a workaround for issue [issues#15261](https://github.com/eslint/eslint/issues/15261)).
 
+> **Note:** Unlike the ESLint rule, this rule does not support the `patterns` option and it does not handle exports.
+
 <!-- assertions noRestrictedImports -->
diff --git a/README.md b/README.md
@@ -370,6 +370,8 @@ Disallow specified modules when loaded by `import`
 
 This rule is similar to [`no-restricted-imports`](https://eslint.org/docs/latest/rules/no-restricted-imports) except that it allows you to specify unique messages for each restricted import (a workaround for issue [issues#15261](https://github.com/eslint/eslint/issues/15261)).
 
+> **Note:** Unlike the ESLint rule, this rule does not support the `patterns` option and it does not handle exports.
+
 
 <a name="user-content-eslint-plugin-canonical-rules-no-restricted-strings"></a>
 <a name="eslint-plugin-canonical-rules-no-restricted-strings"></a>