@lucasacoutinho/archer 0.2.1 → 0.3.0

package/dist/node.d.cts

@@ -1,13 +0,0 @@
-import { TestOptions } from 'node:test';
-import { A as ArcherOptions, a as ArchitectureSuite } from './suite-BwnPDCvU.cjs';
-export { S as Selector } from './suite-BwnPDCvU.cjs';
-
-interface NodeArchTestOptions extends ArcherOptions {
-    readonly test?: TestOptions;
-}
-/**
- * Registers an architecture test in node:test and returns its rule builder.
- */
-declare function arch(name: string, options?: NodeArchTestOptions): ArchitectureSuite;
-
-export { ArcherOptions, type NodeArchTestOptions, arch };

package/dist/node.d.ts

@@ -1,13 +0,0 @@
-import { TestOptions } from 'node:test';
-import { A as ArcherOptions, a as ArchitectureSuite } from './suite-BwnPDCvU.js';
-export { S as Selector } from './suite-BwnPDCvU.js';
-
-interface NodeArchTestOptions extends ArcherOptions {
-    readonly test?: TestOptions;
-}
-/**
- * Registers an architecture test in node:test and returns its rule builder.
- */
-declare function arch(name: string, options?: NodeArchTestOptions): ArchitectureSuite;
-
-export { ArcherOptions, type NodeArchTestOptions, arch };

package/dist/node.js

@@ -1,27 +0,0 @@
-import {
-  ArchitectureSuite
-} from "./chunk-2AKMBLHG.js";
-import {
-  ArchitectureError
-} from "./chunk-IDVLHNL2.js";
-
-// src/adapters/node/index.ts
-import { createRequire } from "module";
-import path from "path";
-var { test } = createRequire(path.join(process.cwd(), "__archer.cjs"))(
-  "node:test"
-);
-function arch(name, options = {}) {
-  const { test: testOptions, ...archerOptions } = options;
-  const suite = new ArchitectureSuite(archerOptions);
-  test(name, testOptions ?? {}, async () => {
-    const result = await suite.check();
-    if (!result.ok) {
-      throw new ArchitectureError(result);
-    }
-  });
-  return suite;
-}
-export {
-  arch
-};

package/dist/reporters-BbAXMpuW.d.cts

@@ -1,6 +0,0 @@
-import { c as ArchitectureResult, b as ArchitectureGraph } from './suite-BwnPDCvU.cjs';
-
-type ReporterName = 'agent' | 'dot' | 'github' | 'json' | 'llm' | 'pretty' | 'sarif';
-declare function report(name: ReporterName, result: ArchitectureResult, graph?: ArchitectureGraph): string;
-
-export { type ReporterName as R, report as r };

package/dist/reporters-xh-HQneS.d.ts

@@ -1,6 +0,0 @@
-import { c as ArchitectureResult, b as ArchitectureGraph } from './suite-BwnPDCvU.js';
-
-type ReporterName = 'agent' | 'dot' | 'github' | 'json' | 'llm' | 'pretty' | 'sarif';
-declare function report(name: ReporterName, result: ArchitectureResult, graph?: ArchitectureGraph): string;
-
-export { type ReporterName as R, report as r };

package/dist/suite-BwnPDCvU.d.cts

@@ -1,337 +0,0 @@
-type Selector = string | readonly string[];
-type DependencyKind = 'dynamic' | 'require' | 'static' | 'type';
-type DependencyResolution = 'bun' | 'dynamic' | 'file' | 'local' | 'node' | 'npm' | 'unresolved';
-type RuleSeverity = 'error' | 'info' | 'warning';
-interface SourceLocation {
-    readonly column: number;
-    readonly line: number;
-}
-interface Dependency extends SourceLocation {
-    readonly external: boolean;
-    readonly from: string;
-    readonly kind: DependencyKind;
-    readonly packageName?: string;
-    readonly resolution: DependencyResolution;
-    readonly resolved: boolean;
-    readonly specifier: string;
-    readonly target: string;
-}
-type DeclarationKind = 'class' | 'enum' | 'function' | 'interface' | 'type' | 'variable';
-interface MethodInfo {
-    readonly name: string;
-    readonly static: boolean;
-    readonly visibility: 'private' | 'protected' | 'public';
-}
-interface DeclarationInfo extends SourceLocation {
-    readonly abstract: boolean;
-    readonly decorators: readonly string[];
-    readonly defaultExport: boolean;
-    readonly exported: boolean;
-    readonly extends: readonly string[];
-    readonly implements: readonly string[];
-    readonly kind: DeclarationKind;
-    readonly methods: readonly MethodInfo[];
-    readonly name: string;
-    readonly readonlyProperties: boolean;
-}
-interface SourceUse extends SourceLocation {
-    readonly kind: 'call' | 'loose-equality';
-    readonly importedFrom?: string;
-    readonly importedName?: string;
-    readonly name: string;
-}
-interface SourceModule {
-    readonly absolutePath: string;
-    readonly declarations: readonly DeclarationInfo[];
-    readonly dependencies: readonly Dependency[];
-    readonly exports: readonly string[];
-    readonly lines: number;
-    readonly path: string;
-    readonly project?: string;
-    readonly sourceLines: readonly string[];
-    readonly uses: readonly SourceUse[];
-}
-interface ProjectInfo {
-    readonly name: string;
-    readonly root: string;
-    readonly tsconfig: string;
-}
-interface ArchitectureGraph {
-    readonly dependencies: readonly Dependency[];
-    readonly modules: readonly SourceModule[];
-    readonly projects: readonly ProjectInfo[];
-    readonly root: string;
-}
-interface ArcherProjectOptions {
-    /** Globs, relative to the project directory, that replace the global include list. */
-    readonly include?: readonly string[];
-    /** Path to a tsconfig file, relative to Archer's root. */
-    readonly tsconfig: string;
-}
-interface ArcherOptions {
-    /** Reuse graphs while source and project-configuration signatures remain unchanged. Defaults to true. */
-    readonly cache?: boolean;
-    /** Globs, relative to root, for source files to analyze. */
-    readonly include?: readonly string[];
-    /** Include .d.ts files as selectable source modules. Defaults to false. */
-    readonly includeTypeDeclarations?: boolean;
-    /** Globs, relative to root, that should not be analyzed. */
-    readonly exclude?: readonly string[];
-    /** Follow symlinks when identifying workspace files. Defaults to true. */
-    readonly followSymlinks?: boolean;
-    /** Additional tsconfig projects or project-specific settings. */
-    readonly projects?: readonly (ArcherProjectOptions | string)[];
-    /** Project root. Defaults to process.cwd(). */
-    readonly root?: string;
-    /** tsconfig used for module resolution. Set false to use TypeScript defaults. */
-    readonly tsconfig?: string | false;
-    /** Discover package-workspace tsconfigs. Defaults to true. */
-    readonly workspaces?: boolean;
-}
-interface ArchitectureViolation {
-    readonly column?: number;
-    readonly dependency?: string;
-    readonly file?: string;
-    readonly importChain?: readonly string[];
-    readonly line?: number;
-    readonly message: string;
-    readonly reason?: string;
-    readonly rule: string;
-    readonly ruleId?: string;
-    readonly severity: RuleSeverity;
-    readonly sourceLine?: string;
-}
-interface ArchitectureResult {
-    readonly dependenciesAnalyzed: number;
-    readonly errors: number;
-    readonly filesAnalyzed: number;
-    readonly infos: number;
-    readonly ok: boolean;
-    readonly violations: readonly ArchitectureViolation[];
-    readonly warnings: number;
-}
-interface CustomRuleContext {
-    readonly graph: ArchitectureGraph;
-    readonly modules: readonly SourceModule[];
-}
-type CustomRuleResult = ArchitectureViolation | readonly ArchitectureViolation[] | undefined | void;
-type CustomRule = (context: CustomRuleContext) => CustomRuleResult | Promise<CustomRuleResult>;
-interface RuleMetadata {
-    readonly id?: string;
-    readonly reason?: string;
-    readonly severity?: RuleSeverity;
-}
-
-interface LayerArchExpectation {
-    readonly not: LayerArchExpectation;
-    localDependencies(): LayerArchExpectation;
-    toDependOn(target: Selector): LayerArchExpectation;
-    toOnlyBeDependedOnBy(target: Selector): LayerArchExpectation;
-    toOnlyDependOn(target: Selector): LayerArchExpectation;
-    toSatisfy(id: string, evaluator: CustomRule, metadata?: Omit<RuleMetadata, 'id'>): LayerArchExpectation;
-}
-interface LayerSuite {
-    expect(selector: Selector): LayerArchExpectation;
-    rule(id: string, evaluator: CustomRule, metadata?: Omit<RuleMetadata, 'id'>): LayerSuite;
-}
-declare class ArchitectureLayers {
-    #private;
-    constructor(suite: LayerSuite, definitions: Readonly<Record<string, Selector>>);
-    where(name: string): LayerExpectation;
-    toBeFreeOfCycles(): this;
-}
-declare class LayerExpectation {
-    #private;
-    constructor(suite: LayerSuite, definitions: Readonly<Record<string, Selector>>, name: string);
-    mayDependOn(...names: readonly string[]): this;
-    mayOnlyDependOn(...names: readonly string[]): this;
-    mayNotDependOn(...names: readonly string[]): this;
-    mayOnlyBeUsedBy(...names: readonly string[]): this;
-    exposeThrough(...barrels: readonly string[]): this;
-    private selectors;
-}
-
-interface Selection {
-    readonly ignored: string[];
-    readonly selector: Selector;
-}
-interface RuleBase {
-    id?: string;
-    readonly kind: string;
-    reason?: string;
-    readonly selection: Selection;
-    severity: RuleSeverity;
-}
-interface DependencyRule extends RuleBase {
-    readonly dependencyKinds?: readonly DependencyKind[];
-    readonly kind: 'depend-on' | 'only-depend-on' | 'depended-on-by' | 'only-depended-on-by';
-    readonly localOnly: boolean;
-    readonly negated: boolean;
-    readonly target: Selector;
-    readonly transitive: boolean;
-}
-interface CycleRule extends RuleBase {
-    readonly collapseToFolderDepth?: number;
-    readonly dependencyKinds?: readonly DependencyKind[];
-    readonly kind: 'free-of-cycles';
-}
-interface NameRule extends RuleBase {
-    readonly kind: 'prefix' | 'suffix';
-    readonly negated: boolean;
-    readonly value: string;
-}
-interface LineCountRule extends RuleBase {
-    readonly kind: 'line-count-less-than';
-    readonly negated: boolean;
-    readonly value: number;
-}
-interface DeclarationKindRule extends RuleBase {
-    readonly declarationKind: DeclarationKind;
-    readonly kind: 'declaration-kind';
-    readonly negated: boolean;
-}
-interface DeclarationModifierRule extends RuleBase {
-    readonly kind: 'abstract' | 'exported';
-    readonly negated: boolean;
-}
-interface HeritageRule extends RuleBase {
-    readonly kind: 'extend' | 'implement';
-    readonly negated: boolean;
-    readonly value: string;
-}
-interface DecoratorRule extends RuleBase {
-    readonly kind: 'decorator';
-    readonly negated: boolean;
-    readonly value: string;
-}
-interface ExportRule extends RuleBase {
-    readonly kind: 'only-export';
-    readonly names: readonly string[];
-    readonly negated: boolean;
-}
-interface ReadonlyRule extends RuleBase {
-    readonly kind: 'readonly-properties';
-    readonly negated: boolean;
-}
-interface StrictEqualityRule extends RuleBase {
-    readonly kind: 'strict-equality';
-}
-interface GlobalUseRule extends RuleBase {
-    readonly globals: readonly string[];
-    readonly kind: 'use-globals';
-    readonly negated: boolean;
-}
-interface ImportedSymbolUseRule extends RuleBase {
-    readonly importedFrom: string;
-    readonly kind: 'use-imported-symbols';
-    readonly negated: boolean;
-    readonly symbols: readonly string[];
-}
-interface MethodRule extends RuleBase {
-    readonly kind: 'have-methods' | 'have-visible-methods' | 'only-public-methods';
-    readonly names: readonly string[];
-    readonly negated: boolean;
-    readonly visibility?: 'private' | 'protected' | 'public';
-}
-interface ResolutionRule extends RuleBase {
-    readonly allowDynamic: boolean;
-    readonly kind: 'resolvable-dependencies';
-}
-interface PublicApiRule extends RuleBase {
-    readonly kind: 'public-api';
-    readonly negated: boolean;
-}
-interface CustomRuleDefinition extends RuleBase {
-    readonly evaluator: CustomRule;
-    readonly kind: 'custom';
-}
-type ArchitectureRule = CustomRuleDefinition | CycleRule | DeclarationKindRule | DeclarationModifierRule | DecoratorRule | DependencyRule | ExportRule | GlobalUseRule | HeritageRule | ImportedSymbolUseRule | LineCountRule | MethodRule | NameRule | PublicApiRule | ReadonlyRule | ResolutionRule | StrictEqualityRule;
-
-interface CycleOptions {
-    readonly collapseToFolderDepth?: number;
-    readonly dependencyKinds?: readonly DependencyKind[];
-}
-interface ResolutionOptions {
-    readonly allowDynamic?: boolean;
-}
-type ArcherPreset = (suite: ArchitectureSuite, options?: unknown) => void;
-declare class ArchitectureSuite {
-    #private;
-    readonly options: ArcherOptions;
-    constructor(options?: ArcherOptions);
-    expect(selector: Selector): ArchExpectation;
-    layers(definitions: Readonly<Record<string, Selector>>): ArchitectureLayers;
-    preset(name: string, options?: unknown): this;
-    rule(id: string, evaluator: CustomRule, ruleMetadata?: Omit<RuleMetadata, 'id'>): this;
-    add(rule: ArchitectureRule): void;
-    decorateLast(values: RuleMetadata): void;
-    check(graph?: ArchitectureGraph): Promise<ArchitectureResult>;
-}
-declare class ArchExpectation {
-    #private;
-    constructor(suite: ArchitectureSuite, selection: Selection);
-    get and(): this;
-    get not(): this;
-    expect(selector: Selector): ArchExpectation;
-    ignoring(...selectors: readonly string[]): this;
-    includingDependencyKinds(...kinds: readonly DependencyKind[]): this;
-    runtimeDependencies(): this;
-    typeDependencies(): this;
-    dynamicDependencies(): this;
-    localDependencies(): this;
-    transitively(): this;
-    toDependOn(target: Selector): this;
-    toTransitivelyDependOn(target: Selector): this;
-    toUse(target: Selector): this;
-    toOnlyDependOn(target: Selector): this;
-    toOnlyUse(target: Selector): this;
-    toUseNothing(): this;
-    toBeDependedOnBy(target: Selector): this;
-    toTransitivelyBeDependedOnBy(target: Selector): this;
-    toBeUsedIn(target: Selector): this;
-    toBeUsed(): this;
-    toOnlyBeDependedOnBy(target: Selector): this;
-    toOnlyBeUsedIn(target: Selector): this;
-    toBeFreeOfCycles(options?: CycleOptions): this;
-    toBeFreeOfFolderCycles(depth?: number): this;
-    toHavePrefix(value: string): this;
-    toHaveSuffix(value: string): this;
-    toHaveLineCountLessThan(value: number): this;
-    toBeClasses(): this;
-    toBeEnums(): this;
-    toBeFunctions(): this;
-    toBeInterfaces(): this;
-    toBeTypes(): this;
-    toBeAbstract(): this;
-    toBeExported(): this;
-    toExtend(value: string): this;
-    toImplement(value: string): this;
-    toHaveDecorator(value: string): this;
-    toOnlyExport(...names: readonly string[]): this;
-    toHaveReadonlyProperties(): this;
-    toUseStrictEquality(): this;
-    toUseGlobals(...globals: readonly string[]): this;
-    toUseImportedSymbols(importedFrom: string, ...symbols: readonly string[]): this;
-    toHaveMethods(...names: readonly string[]): this;
-    toHavePublicMethods(...names: readonly string[]): this;
-    toHaveProtectedMethods(...names: readonly string[]): this;
-    toHavePrivateMethods(...names: readonly string[]): this;
-    toOnlyHavePublicMethods(...names: readonly string[]): this;
-    toHaveResolvableDependencies(options?: ResolutionOptions): this;
-    toBePublicApi(): this;
-    toSatisfy(id: string, evaluator: CustomRule, ruleMetadata?: Omit<RuleMetadata, 'id'>): this;
-    because(reason: string): this;
-    as(id: string): this;
-    withSeverity(severity: RuleSeverity): this;
-    private addDeclarationKind;
-    private addVisibleMethods;
-    private addSimple;
-    private consumeNegation;
-    private addDependencyRule;
-}
-declare function createArcher(options?: ArcherOptions): ArchitectureSuite;
-declare function registerPreset(name: string, preset: ArcherPreset): void;
-declare function applyPreset(name: string, suite: ArchitectureSuite, options?: unknown): void;
-declare function availablePresets(): readonly string[];
-
-export { type ArcherOptions as A, type CustomRule as C, type DeclarationInfo as D, LayerExpectation as L, type MethodInfo as M, type ProjectInfo as P, type ResolutionOptions as R, type Selector as S, ArchitectureSuite as a, type ArchitectureGraph as b, type ArchitectureResult as c, type ArchitectureViolation as d, ArchExpectation as e, type ArcherPreset as f, type ArcherProjectOptions as g, ArchitectureLayers as h, type CustomRuleContext as i, type CustomRuleResult as j, type CycleOptions as k, type DeclarationKind as l, type Dependency as m, type DependencyKind as n, type DependencyResolution as o, type RuleMetadata as p, type RuleSeverity as q, type SourceLocation as r, type SourceModule as s, type SourceUse as t, applyPreset as u, availablePresets as v, createArcher as w, registerPreset as x };