@lanelint/plugin-boundaries 0.0.0-stage → 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Anton Ödman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,57 @@
-# Temporary Holding Version
+# @lanelint/plugin-boundaries
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[![npm](https://img.shields.io/npm/v/@lanelint/plugin-boundaries)](https://www.npmjs.com/package/@lanelint/plugin-boundaries)
+
+[lanelint](https://github.com/banjo/lanelint) rules for imports: which parts of your
+architecture may import which, and which packages and globals code may use.
+
+## Install
+
+```bash
+npm install -D lanelint @lanelint/plugin-boundaries
+```
+
+## Use
+
+```ts
+// lanelint.config.ts
+import boundaries from '@lanelint/plugin-boundaries';
+import { defineConfig } from 'lanelint';
+
+export default defineConfig({
+  elements: [
+    { type: 'feature', pattern: 'src/features/:name' },
+    { type: 'domain', pattern: 'src/common/:name' },
+  ],
+  extends: [boundaries.configs.recommended],
+  rules: {
+    'boundaries/entry-only': ['error', { elements: 'feature' }],
+    'boundaries/allowed-imports': ['error', { rules: [{ from: 'domain', disallow: 'feature' }] }],
+  },
+});
+```
+
+`recommended` turns on `no-cycles`, `no-unresolved`, and `no-undeclared-dependency`.
+
+## Rules
+
+| Rule                                                                                                                        | Checks                                                                   |
+| --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
+| [`allowed-imports`](https://github.com/banjo/lanelint/blob/main/docs/rules/boundaries.md#allowed-imports)                   | Which elements may import which                                          |
+| [`entry-only`](https://github.com/banjo/lanelint/blob/main/docs/rules/boundaries.md#entry-only)                             | Imports from outside an element target its entry files                   |
+| [`no-cycles`](https://github.com/banjo/lanelint/blob/main/docs/rules/boundaries.md#no-cycles)                               | Elements do not depend on each other in a cycle                          |
+| [`no-entry-import`](https://github.com/banjo/lanelint/blob/main/docs/rules/boundaries.md#no-entry-import)                   | Imports target the files they need, not entry files                      |
+| [`no-orphans`](https://github.com/banjo/lanelint/blob/main/docs/rules/boundaries.md#no-orphans)                             | Source files are imported by non-test code, or are an entry point        |
+| [`no-undeclared-dependency`](https://github.com/banjo/lanelint/blob/main/docs/rules/boundaries.md#no-undeclared-dependency) | Imported packages are declared in the nearest package.json               |
+| [`no-unresolved`](https://github.com/banjo/lanelint/blob/main/docs/rules/boundaries.md#no-unresolved)                       | Imports resolve to a file or an installed package                        |
+| [`public-api`](https://github.com/banjo/lanelint/blob/main/docs/rules/boundaries.md#public-api)                             | Imported files of an element are reachable from its entry files          |
+| [`restricted-globals`](https://github.com/banjo/lanelint/blob/main/docs/rules/boundaries.md#restricted-globals)             | Globals such as `fetch` or `Date.now` are not used where they are banned |
+| [`restricted-packages`](https://github.com/banjo/lanelint/blob/main/docs/rules/boundaries.md#restricted-packages)           | Packages, or names from them, are not imported where they are banned     |
+| [`workspace-imports`](https://github.com/banjo/lanelint/blob/main/docs/rules/boundaries.md#workspace-imports)               | Other workspace packages are imported by name, through what they export  |
+
+See [all options](https://github.com/banjo/lanelint/blob/main/docs/rules/boundaries.md), or
+run `lanelint rules explain boundaries/<rule>`.
+
+## License
+
+MIT