@lucasacoutinho/archer 0.0.0-stage → 0.2.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,5 @@
+archer
+Copyright 2026 Lucas Coutinho
+
+This product is licensed under the Apache License, Version 2.0.
+See the LICENSE file for details.

package/README.md

@@ -1,3 +1,460 @@
-# Temporary Holding Version
+# Archer
 
-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.
+Architecture tests for TypeScript and JavaScript. Archer builds a resolved
+module graph, lets you describe boundaries with a fluent API, and reports a
+normal test failure when the code stops matching the design.
+
+It takes its readable rule style from [Pest architecture testing](https://pestphp.com/docs/arch-testing),
+but models files, packages, imports, exports, and TypeScript declarations.
+
+## Install
+
+```sh
+npm install --save-dev @lucasacoutinho/archer
+```
+
+Archer supports Node.js 20 and newer. It parses sources with its own bundled
+TypeScript, so the project's TypeScript version does not matter. The core
+package has no test-runner dependency.
+
+## Start with the CLI
+
+Create `archer.config.ts`:
+
+```ts
+import { defineConfig } from '@lucasacoutinho/archer'
+
+export default defineConfig({
+  include: ['src/**/*.ts', 'packages/*/src/**/*.ts'],
+  exclude: ['**/*.generated.ts'],
+
+  rules(archer) {
+    archer
+      .expect('src/domain/**')
+      .not.toDependOn('src/infrastructure/**')
+      .because('The domain must remain portable.')
+      .as('boundaries/domain-isolation')
+
+    archer.expect('src/**').toBeFreeOfCycles()
+  },
+})
+```
+
+Then run:
+
+```sh
+npx archer check
+npx archer check --watch
+```
+
+`archer init` creates a starter config. Config paths, output paths, and the
+project root are resolved relative to the config file.
+
+## Test-runner adapters
+
+Each adapter registers a test immediately and returns the same rule builder.
+
+```ts
+// test/architecture.test.ts
+import { arch } from '@lucasacoutinho/archer/vitest'
+
+arch('the domain stays independent')
+  .expect('src/domain/**')
+  .not.toDependOn('src/infrastructure/**')
+  .and.toOnlyDependOn(['src/domain/**', 'src/shared/**'])
+```
+
+The other entry points are:
+
+```ts
+import { arch } from '@lucasacoutinho/archer/jest'
+import { arch } from '@lucasacoutinho/archer/bun'
+import { arch } from '@lucasacoutinho/archer/node'
+```
+
+Jest and Bun accept `timeout` as an Archer adapter option. The Node adapter
+accepts built-in `node:test` options under `test`.
+
+## Vitest config plugin
+
+Vitest can run Archer once, before it starts collecting tests. The plugin loads
+`archer.config.*` from the Vitest project root by default:
+
+```ts
+// vitest.config.ts
+import { archer } from '@lucasacoutinho/archer/vitest'
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  plugins: [archer()],
+})
+```
+
+Pass `config`, `reporter`, `baseline`, `output`, or `failOnWarnings` to
+`archer()` when the defaults are not enough. This is a configuration plugin,
+so it performs one architecture check for the Vitest project instead of
+registering a test in every worker.
+
+## Matcher setup modules
+
+Vitest, Jest, and Bun can also install Archer as an `expect` plugin. This keeps
+the runner integration in its normal setup hook and lets architecture tests use
+the same assertion in every runner.
+
+For Vitest, add the plugin to `setupFiles`:
+
+```ts
+// vitest.config.ts
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    setupFiles: ['@lucasacoutinho/archer/vitest/plugin'],
+  },
+})
+```
+
+For Jest, add it to `setupFilesAfterEnv`:
+
+```ts
+// jest.config.ts
+export default {
+  setupFilesAfterEnv: ['@lucasacoutinho/archer/jest/plugin'],
+}
+```
+
+For Bun, preload it from `bunfig.toml`:
+
+```toml
+[test]
+preload = ["@lucasacoutinho/archer/bun/plugin"]
+```
+
+Then create a normal test and await the asynchronous matcher:
+
+```ts
+import { createArcher } from '@lucasacoutinho/archer'
+
+test('the architecture is respected', async () => {
+  const archer = createArcher()
+  archer.expect('src/domain/**').not.toDependOn('src/infrastructure/**')
+
+  await expect(archer).toRespectArchitecture()
+})
+```
+
+The plugin installs the matcher; it does not silently inject a test into every
+worker. Use the `arch()` adapter when the fluent one-call form is preferable.
+
+## Dependency rules
+
+```ts
+archer
+  .expect('src/application/**')
+  .toDependOn('src/domain/**')
+  .not.toDependOn('src/web/**')
+  .toOnlyDependOn(['src/application/**', 'src/domain/**', 'npm:zod'])
+  .toBeDependedOnBy('src/http/**')
+  .toOnlyBeDependedOnBy(['src/http/**', 'src/jobs/**'])
+```
+
+Aliases are available for Pest-style wording: `toUse`, `toOnlyUse`,
+`toBeUsedIn`, `toOnlyBeUsedIn`, `toUseNothing`, and `toBeUsed`.
+
+Modifiers apply to the next dependency rule and then reset:
+
+```ts
+archer
+  .expect('src/application/**')
+  .typeDependencies()
+  .toOnlyDependOn('src/contracts/**')
+  .runtimeDependencies()
+  .not.toDependOn('src/testing/**')
+  .dynamicDependencies()
+  .not.toDependOn('src/admin/**')
+  .localDependencies()
+  .toOnlyDependOn(['src/application/**', 'src/domain/**'])
+  .toTransitivelyDependOn('src/domain/events.ts')
+```
+
+Use `includingDependencyKinds('static', 'require')` for an exact combination,
+or `.transitively().toDependOn(...)` for explicit reachability. Transitive
+violations include the shortest discovered import chain.
+
+### Selectors and resolution
+
+| Selector        | Meaning                                          |
+| --------------- | ------------------------------------------------ |
+| `src/domain/**` | Files resolved inside the configured root        |
+| `npm:react`     | An installed package and its subpaths            |
+| `node:fs`       | A Node built-in                                  |
+| `bun:test`      | A Bun built-in                                   |
+| `unresolved:*`  | Imports TypeScript could not resolve             |
+| `dynamic:*`     | Computed dynamic imports without a static target |
+
+Archer resolves path aliases, package exports, project references, workspace
+packages, symlinks, `.js` imports of TypeScript sources, re-exports,
+`import type`, import types, CommonJS `require`, and lazy imports.
+
+Literal lazy imports such as `import('./admin.js')` are normal resolved edges.
+A computed import such as `import(moduleName)` becomes `dynamic:unknown`.
+Negative boundary rules fail closed on that edge because the target cannot be
+proven safe; an allow-list can explicitly include `dynamic:*`.
+
+## Named layers and public APIs
+
+```ts
+const layers = archer.layers({
+  domain: 'src/domain/**',
+  application: 'src/application/**',
+  infrastructure: 'src/infrastructure/**',
+})
+
+layers.where('domain').mayNotDependOn('infrastructure')
+layers.where('application').mayOnlyDependOn('domain')
+layers.where('domain').mayOnlyBeUsedBy('application')
+layers.where('domain').exposeThrough('src/domain/index.ts')
+layers.toBeFreeOfCycles()
+```
+
+Layer rules only constrain local project dependencies. External packages do
+not need to be repeated in every layer allow-list. `exposeThrough` rejects
+deep imports into a layer from outside it.
+
+For directory-level cycles, collapse file nodes to a fixed depth:
+
+```ts
+archer.expect('src/**').toBeFreeOfFolderCycles(2)
+```
+
+## TypeScript-aware rules
+
+Archer uses the configured TypeScript programs for declarations, resolved
+heritage, exports, decorators, method visibility, and global-call detection.
+
+```ts
+archer
+  .expect('src/controllers/**')
+  .toBeClasses()
+  .toExtend('BaseController')
+  .toImplement('Runnable')
+  .toHaveDecorator('Controller')
+  .toHaveReadonlyProperties()
+  .toHaveMethods('execute')
+  .toHavePublicMethods('execute')
+  .toHaveProtectedMethods('reset')
+  .toOnlyHavePublicMethods()
+  .toBeExported()
+
+archer.expect('src/contracts/**').toBeInterfaces()
+archer.expect('src/base-controller.ts').toBeAbstract()
+archer.expect('src/status.ts').toBeEnums()
+archer.expect('src/factories/**').toBeFunctions()
+archer.expect('src/models/**').toBeTypes()
+archer.expect('src/index.ts').toOnlyExport('Client', 'ClientOptions')
+archer.expect('src/**').toUseStrictEquality()
+archer.expect('src/**').not.toUseGlobals('eval', 'Function')
+archer.expect('src/**').not.toUseImportedSymbols('react', 'useEffect')
+archer.expect('src/**').toHaveResolvableDependencies()
+archer.expect('src/index.ts').toBePublicApi()
+```
+
+Naming and size rules remain available through `toHavePrefix`,
+`toHaveSuffix`, and `toHaveLineCountLessThan`.
+
+These are static checks. Runtime dependency injection, reflection-generated
+exports, and targets hidden behind computed imports cannot be inferred.
+
+### Imported API policies
+
+`toUseImportedSymbols()` matches calls by their original module and export. It
+recognizes named-import aliases, namespace calls, default-import property
+calls, element access with a literal name, and CommonJS destructuring.
+
+That keeps framework names out of Archer's rule engine. A React policy can be
+written from generic rules:
+
+```ts
+archer
+  .expect('src/frontend/components/**/*.{ts,tsx}')
+  .not.toBeClasses()
+  .and.not.toUseImportedSymbols('react', 'useEffect', 'useContext')
+
+archer.expect('src/frontend/state/**').toDependOn('npm:zustand')
+```
+
+The same call rule can reject Vue `provide` and `inject`, or Svelte
+`setContext` and `getContext`, in JavaScript and TypeScript modules:
+
+```ts
+archer.expect('src/vue/**').not.toUseImportedSymbols('vue', 'provide', 'inject')
+archer.expect('src/svelte/**').not.toUseImportedSymbols('svelte', 'setContext', 'getContext')
+```
+
+Vue and Svelte single-file components need their compiler parsers because a
+`.vue` or `.svelte` file is not a TypeScript source file. Archer does not parse
+those formats as TypeScript or claim that their template dependencies were
+checked. They belong in source-analyzer integrations, while the core rules
+remain framework-neutral.
+
+## Rule metadata, custom rules, and presets
+
+Rules default to error severity. Stable IDs make baselines and CI annotations
+less sensitive to wording changes.
+
+```ts
+archer
+  .expect('src/legacy/**')
+  .not.toDependOn('src/new-core/**')
+  .as('migration/no-new-core')
+  .because('Legacy code is being removed, not expanded.')
+  .withSeverity('warning')
+```
+
+Custom rules may be synchronous or asynchronous:
+
+```ts
+archer.expect('src/features/**').toSatisfy('features/one-entrypoint', ({ modules }) =>
+  modules.flatMap((module) =>
+    module.exports.length > 1
+      ? [
+          {
+            file: module.path,
+            message: 'Feature exports more than one symbol.',
+            rule: 'features expose one entrypoint',
+            severity: 'error',
+          },
+        ]
+      : [],
+  ),
+)
+```
+
+Built-in presets are `strict`, `node`, and `security`:
+
+```ts
+archer.preset('strict')
+archer.preset('node')
+
+registerPreset('company', (suite) => {
+  suite.expect('src/**').not.toDependOn('npm:deprecated-sdk')
+})
+```
+
+## Monorepos and project references
+
+Archer discovers npm/Yarn and pnpm workspaces plus referenced tsconfigs. You
+can also declare projects and override their source selection:
+
+```ts
+export default defineConfig({
+  projects: [
+    'packages/core/tsconfig.json',
+    {
+      tsconfig: 'apps/*/tsconfig.json',
+      include: ['src/**/*.ts', 'scripts/**/*.ts'],
+    },
+  ],
+  rules(archer) {
+    archer.expect('packages/**').toBeFreeOfCycles()
+  },
+})
+```
+
+Set `workspaces: false`, `followSymlinks: false`, `cache: false`, or
+`tsconfig: false` to override the corresponding defaults.
+
+## Reports and baselines
+
+The CLI supports `pretty`, `agent`, `llm`, `json`, `sarif`, `github`, and `dot` reporters.
+`agent` and its `llm` alias emit one stable, single-line record per finding without ANSI output:
+
+```sh
+npx archer check --reporter agent
+npx archer check --reporter sarif --output reports/archer.sarif
+npx archer check --reporter github
+npx archer check --reporter dot --output reports/dependencies.dot
+```
+
+Adopt Archer in an existing codebase without accepting new violations:
+
+```sh
+npx archer check --update-baseline
+npx archer check
+```
+
+The default baseline is `.archer-baseline.json`. Use `--baseline <file>` or
+the config `baseline` field to choose another path. `--fail-on-warnings` makes
+warning-level rules affect the CLI exit code.
+
+The core API exposes the same data for integrations:
+
+```ts
+import { ArchitectureError, createArcher } from '@lucasacoutinho/archer'
+
+const archer = createArcher({ root: process.cwd() })
+archer.expect('src/**').toBeFreeOfCycles()
+
+const result = await archer.check()
+if (!result.ok) throw new ArchitectureError(result)
+```
+
+## Agent skill
+
+Archer ships a portable [Agent Skill](https://openagentskills.dev/) in
+`skills/archer`. Its source is versioned with the engine and included in the npm
+package, so it is not tied to one developer's local agent configuration.
+
+Install it into any supported coding agent with the Skills CLI:
+
+```sh
+npx skills add lucasacoutinho/archer --skill archer
+```
+
+Agents can then use `$archer` to set up rules, diagnose findings, and fix source
+violations without weakening architecture policy.
+
+## Development
+
+Archer dogfoods its rules in both `test/architecture.test.ts` and
+`archer.config.ts`. The repository checks Node 20, 22, and 24 on Linux and
+Windows, plus Jest, Bun, `node:test`, the CLI, package exports, and type
+definitions.
+
+```sh
+npm install
+npm run fmt
+npm run lint
+npm run check
+npm run check:package
+npm run release:check
+```
+
+To cross-test the adjacent tiacore checkout, build tiacore once and run:
+
+```sh
+npm run test:tia
+npm run test:tia:verify
+```
+
+The scripts prefer an installed `@lucasacoutinho/tiacore` package and otherwise
+use `../tiacore`. Set `TIACORE_VITEST_ENTRY` or `TIACORE_CLI` for a checkout in
+another location.
+
+## Releasing
+
+Releases publish to the public npm registry from the `Publish package` workflow
+(`.github/workflows/publish.yml`) with npm trusted publishing, so no npm token is
+stored in the repository and npm attaches provenance automatically. npm can only
+attach a trusted publisher to a package that already exists, so the first
+version is published manually by a maintainer with two-factor authentication.
+After that, link the workflow once:
+
+```sh
+npm trust github @lucasacoutinho/archer --file publish.yml --repo lucasacoutinho/archer --allow-publish
+```
+
+## License
+
+Archer is licensed under the [Apache License, Version 2.0](LICENSE). See
+[NOTICE](NOTICE) for attribution.