repopo 0.12.0 → 0.13.0

package/esm/policy.d.ts

@@ -1,313 +1,85 @@
 import type { Operation } from "effection";
-/**
- * A type representing a policy name.
- *
- * @alpha
- */
+/** Display name of a policy. @public */
 export type PolicyName = string;
-/**
- * A stable identifier for a configured policy instance.
- *
- * @alpha
- */
+/** Stable configured-instance identity. @public */
 export type PolicyInstanceId = string;
-/**
- * Arguments passed to policy handler functions.
- *
- * @alpha
- */
+/** Arguments supplied to a file handler. @public */
 export interface PolicyArgs<C = void> {
-    /**
-     * Path to the file, relative to the repo root.
-     */
     file: string;
-    /**
-     * Absolute path to the root of the repo.
-     */
     root: string;
-    /**
-     * If true, the handler should resolve any violations automatically if possible.
-     */
     resolve: boolean;
-    /**
-     * Optional configuration for the policy.
-     */
     config?: C | undefined;
 }
-/**
- * @deprecated Use {@link PolicyArgs} instead.
- * @alpha
- */
-export type PolicyFunctionArguments<C> = PolicyArgs<C>;
-/**
- * A policy error returned when a file fails a policy check.
- *
- * @alpha
- */
-export interface PolicyError {
-    /**
-     * The error message describing what failed.
-     */
-    error: string;
-    /**
-     * Set to `true` if the policy violation can be fixed automatically.
-     */
-    fixable?: boolean | undefined;
-    /**
-     * Set to `true` if the violation was successfully fixed (only set when resolve=true).
-     */
-    fixed?: boolean | undefined;
-    /**
-     * An optional string that tells the user how to manually fix the failure.
-     */
-    manualFix?: string | undefined;
+/** Arguments supplied to a repository handler; selection never limits files. @public */
+export interface RepositoryPolicyArgs<C = void> extends Omit<PolicyArgs<C>, "file"> {
+    files: readonly string[];
 }
-/**
- * The result of a policy handler.
- * Returns `true` if the file passes the policy, or a {@link PolicyError} if it fails.
- *
- * @alpha
- */
-export type PolicyResult = true | PolicyError;
-/**
- * A policy failure (legacy format).
- *
- * @deprecated Use {@link PolicyError} instead, which has a simpler API.
- *
- * @alpha
- */
-export interface PolicyFailure {
-    /**
-     * Name of the policy that failed.
-     */
-    name: PolicyName;
-    /**
-     * Path to the file that failed the policy.
-     */
-    file: string;
-    /**
-     * Set to `true` if the policy can be fixed automatically.
-     */
-    autoFixable?: boolean | undefined;
-    /**
-     * An optional error message accompanying the failure.
-     */
-    errorMessages: string[];
-    /**
-     * An optional string that tells the user how to fix the failure(s).
-     */
+/** A single independently actionable violation or recorded fix. @public */
+export interface PolicyFinding {
+    message: string;
     manualFix?: string | undefined;
+    fixStatus?: "available" | "fixed" | "failed" | undefined;
+    /** Repo-relative affected files. Only repository handlers may supply this. */
+    files?: readonly string[] | undefined;
 }
-/**
- * The result of an automatic fix for a failing policy (legacy format).
- *
- * @deprecated Use {@link PolicyError} with `fixed: boolean` instead.
- *
- * @alpha
- */
-export interface PolicyFixResult extends PolicyFailure {
-    /**
-     * Set to true if the failure was resolved by the automated fixer.
-     */
-    resolved: boolean;
-}
-/**
- * Result type that accepts both legacy and new formats.
- *
- * @alpha
- */
-export type PolicyHandlerResult = true | PolicyFailure | PolicyFixResult | PolicyError;
-/**
- * A policy handler function that checks a file against a policy.
- *
- * @remarks
- * Policy handlers can be implemented in two ways:
- * - As an async function returning a Promise
- * - As an Effection generator function returning an Operation
- *
- * Both styles are supported. Async handlers are automatically wrapped for Effection.
- *
- * Handlers can return either the legacy format ({@link PolicyFailure}) or
- * the new format ({@link PolicyError}). The new format is simpler and recommended
- * for new policies.
- *
- * @alpha
- */
-export type PolicyHandler<C = unknown | undefined> = ((args: PolicyArgs<C>) => Promise<PolicyHandlerResult>) | ((args: PolicyArgs<C>) => Operation<PolicyHandlerResult>);
-/**
- * A standalone resolver function that can fix policy violations (legacy format).
- *
- * @deprecated Use {@link PolicyResolver} instead, which uses {@link PolicyError}.
- *
- * @alpha
- */
-export type PolicyStandaloneResolver<C = undefined> = (args: Omit<PolicyArgs<C>, "resolve">) => Promise<PolicyFixResult> | Operation<PolicyFixResult>;
-/**
- * A standalone resolver function using the new format.
- *
- * @alpha
- */
-export type PolicyResolver<C = void> = (args: Omit<PolicyArgs<C>, "resolve">) => Promise<PolicyError> | Operation<PolicyError>;
-/**
- * Interface describing the shape of a policy definition.
- *
- * @typeParam C - Type of configuration object used by the policy
- *
- * @alpha
- */
-export interface PolicyShape<C = void> {
-    /**
-     * The name of the policy; displayed in UI and used in settings.
-     */
+/** Empty means pass. Fixed findings remain visible. @public */
+export type PolicyResult = readonly PolicyFinding[];
+/** Standalone file fixers receive and return the complete findings list. @public */
+export type PolicyResolver<C = void> = {
+    resolve(args: Omit<PolicyArgs<C>, "resolve"> & {
+        findings: PolicyResult;
+    }): Promise<PolicyResult> | Operation<PolicyResult>;
+}["resolve"];
+/** File scope is the default. @public */
+export interface FilePolicyDefinition<C = void> {
     name: PolicyName;
-    /**
-     * A detailed description of the policy and its purpose.
-     */
     description: string;
-    /**
-     * A regular expression that matches files this policy applies to.
-     */
+    scope?: "file";
     match: RegExp;
-    /**
-     * The handler function that checks if a file complies with the policy.
-     */
-    handler: PolicyHandler<C>;
-    /**
-     * An optional resolver function that can automatically fix violations.
-     */
-    resolver?: PolicyStandaloneResolver<C> | undefined;
-    /**
-     * A default configuration that will be used if none is provided.
-     */
+    handler(args: PolicyArgs<C>): Promise<PolicyResult> | Operation<PolicyResult>;
+    resolver?: PolicyResolver<C> | undefined;
     defaultConfig?: C | undefined;
+    requiresConfig?: boolean | undefined;
 }
-/**
- * Abstract base class for creating policies with object-based construction.
- *
- * @remarks
- * This class accepts a {@link PolicyShape} object in its constructor,
- * making it easier to add new optional properties in the future without breaking changes.
- *
- * @alpha
- */
-export declare abstract class Policy<C = void> implements PolicyShape<C> {
-    readonly name: string;
-    readonly description: string;
-    readonly match: RegExp;
-    readonly handler: PolicyHandler<C>;
-    readonly defaultConfig?: C | undefined;
-    readonly resolver?: PolicyStandaloneResolver<C> | undefined;
-    constructor(definition: PolicyShape<C>);
+/** Repository scope is explicit; repository fixers are inline only. @public */
+export interface RepositoryPolicyDefinition<C = void> {
+    name: PolicyName;
+    description: string;
+    scope: "repository";
+    handler(args: RepositoryPolicyArgs<C>): Promise<PolicyResult> | Operation<PolicyResult>;
+    resolver?: never;
+    defaultConfig?: C | undefined;
+    requiresConfig?: boolean | undefined;
 }
-/**
- * @deprecated Use {@link PolicyShape} instead.
- * @alpha
- */
-export type PolicyDefinition<C = undefined> = PolicyShape<C>;
-/**
- * A policy instance with configuration and exclusion settings applied.
- *
- * @typeParam C - Type of configuration object used by the policy
- *
- * @alpha
- */
-export interface ConfiguredPolicy<C = void> extends PolicyShape<C> {
-    /**
-     * An optional stable identifier for this configured policy instance.
-     *
-     * This is required when the same policy definition is configured more than once.
-     */
-    instanceId?: PolicyInstanceId | undefined;
-    /**
-     * The configuration applied to this policy instance.
-     */
+/** A canonical policy definition. @public */
+export type PolicyDefinition<C = void> = FilePolicyDefinition<C> | RepositoryPolicyDefinition<C>;
+/** Async and Effection file handlers are supported. @public */
+export type PolicyHandler<C = void> = FilePolicyDefinition<C>["handler"];
+/** Async and Effection repository handlers are supported. @public */
+export type RepositoryPolicyHandler<C = void> = RepositoryPolicyDefinition<C>["handler"];
+/** Exclude undefined (including void) while preserving allowed null values. @internal */
+export type DefinedConfig<C> = NonNullable<C> | (C & null);
+/** Instance configuration and repo-relative regex exclusions. @public */
+export interface PolicyOptions<C = void> {
     config?: C | undefined;
-    /**
-     * File paths matching these patterns will be excluded from this policy.
-     * @deprecated Use `excludeFiles` instead for backward compatibility.
-     */
-    exclude?: (string | RegExp)[] | undefined;
-    /**
-     * File paths matching these patterns will be excluded from this policy.
-     */
-    excludeFiles?: (string | RegExp)[] | undefined;
-    /**
-     * Internal normalized handler (always an Effection Operation).
-     * This is set by the policy() function and used by the execution engine.
-     * @internal
-     */
-    _internalHandler?: (args: PolicyArgs<C>) => Operation<PolicyHandlerResult>;
-}
-/**
- * Settings for configuring a policy instance.
- * @alpha
- */
-export interface PolicyInstanceSettings<C> {
-    /**
-     * A stable identifier for this configured policy instance.
-     */
+    exclude?: readonly (string | RegExp)[] | undefined;
     instanceId?: PolicyInstanceId | undefined;
-    /**
-     * An array of strings/regular expressions. File paths that match any of these expressions will be completely excluded
-     * from policy.
-     *
-     * Paths will be matched relative to the root of the repo.
-     */
-    excludeFiles?: (string | RegExp)[];
-    /**
-     * The config that is applied to the policy instance.
-     */
-    config?: C | undefined;
 }
-/**
- * @deprecated Use {@link ConfiguredPolicy} instead.
- * @alpha
- */
-export type PolicyInstance<C = undefined> = ConfiguredPolicy<C>;
-/**
- * A configured policy instance with its runtime identity assigned.
- *
- * @alpha
- */
-export type IdentifiedPolicy<C = undefined> = ConfiguredPolicy<C> & {
+/** A configured file policy. @public */
+export type ConfiguredFilePolicy<C = void> = FilePolicyDefinition<C> & PolicyOptions<C>;
+/** A configured repository policy. @public */
+export type ConfiguredRepositoryPolicy<C = void> = RepositoryPolicyDefinition<C> & PolicyOptions<C>;
+/** A configured policy, retaining scope discrimination. @public */
+export type ConfiguredPolicy<C = unknown> = ConfiguredFilePolicy<C> | ConfiguredRepositoryPolicy<C>;
+/** A configured policy with a validated stable identity. @public */
+export type IdentifiedPolicy<C = unknown> = ConfiguredPolicy<C> & {
     instanceId: PolicyInstanceId;
 };
-/**
- * Type guard to check if a result is a {@link PolicyFixResult} (legacy).
- *
- * @deprecated Use {@link isPolicyError} instead when working with the new {@link PolicyError} format.
- *
- * @alpha
- */
-export declare function isPolicyFixResult(toCheck: any): toCheck is PolicyFixResult;
-/**
- * Type guard to check if a result is a PolicyError (new format).
- *
- * @alpha
- */
-export declare function isPolicyError(toCheck: any): toCheck is PolicyError;
-/**
- * Type guard to check if a result is a {@link PolicyFailure} (legacy format).
- *
- * @deprecated Use {@link isPolicyError} instead when working with the new {@link PolicyError} format.
- *
- * @alpha
- */
-export declare function isPolicyFailure(toCheck: any): toCheck is PolicyFailure;
-/**
- * Converts a legacy PolicyFailure/PolicyFixResult to the new PolicyError format.
- * @internal
- */
-export declare function convertLegacyResult(result: PolicyHandlerResult, _file: string): PolicyResult;
-/**
- * Converts a new PolicyError to the legacy PolicyFailure format.
- * @internal
- */
-export declare function convertToLegacyResult(result: PolicyError, policyName: string, file: string): PolicyFailure | PolicyFixResult;
-/**
- * Default policies included with repopo.
- *
- * @alpha
- */
-export declare const DefaultPolicies: Policy<any>[];
+/** The default definitions, configured when no policies are supplied. @public */
+export declare const DefaultPolicies: readonly [{
+    name: string;
+    description: string;
+    match: RegExp;
+    handler: () => Operation<PolicyFinding[]>;
+}, FilePolicyDefinition<void>, FilePolicyDefinition<void>];
 //# sourceMappingURL=policy.d.ts.map

package/esm/policy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"policy.d.ts","sourceRoot":"","sources":["../src/policy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAK3C;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAEhC;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEtC;;;;GAIG;AACH,MAAM,WAAW,UAAU,CAAC,CAAC,GAAG,IAAI;IACnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,MAAM,uBAAuB,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;AAMvD;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAE9B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,IAAI,GAAG,WAAW,CAAC;AAM9C;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAElC;;OAEG;IACH,aAAa,EAAE,MAAM,EAAE,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAgB,SAAQ,aAAa;IACrD;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAC5B,IAAI,GACJ,aAAa,GACb,eAAe,GACf,WAAW,CAAC;AAMf;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,GAAG,OAAO,GAAG,SAAS,IAC9C,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC,GACvD,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC;AAE7D;;;;;;GAMG;AACH,MAAM,MAAM,wBAAwB,CAAC,CAAC,GAAG,SAAS,IAAI,CACrD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,KAChC,OAAO,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC,eAAe,CAAC,CAAC;AAE3D;;;;GAIG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,GAAG,IAAI,IAAI,CACtC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,KAChC,OAAO,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC;AAMnD;;;;;;GAMG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,IAAI;IACpC;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,wBAAwB,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IAEnD;;OAEG;IACH,aAAa,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;CAC9B;AAED;;;;;;;;GAQG;AACH,8BAAsB,MAAM,CAAC,CAAC,GAAG,IAAI,CAAE,YAAW,WAAW,CAAC,CAAC,CAAC;IAC/D,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC,SAAgB,KAAK,EAAE,MAAM,CAAC;IAC9B,SAAgB,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAC1C,SAAgB,aAAa,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;IAC9C,SAAgB,QAAQ,CAAC,EAAE,wBAAwB,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;gBAEhD,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;CAQ7C;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,GAAG,SAAS,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;AAE7D;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,GAAG,IAAI,CAAE,SAAQ,WAAW,CAAC,CAAC,CAAC;IACjE;;;;OAIG;IACH,UAAU,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAE1C;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;IAEvB;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,SAAS,CAAC;IAE1C;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,SAAS,CAAC;IAE/C;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,mBAAmB,CAAC,CAAC;CAC3E;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB,CAAC,CAAC;IACxC;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAE1C;;;;;OAKG;IACH,YAAY,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAEnC;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,GAAG,SAAS,IAAI,gBAAgB,CAAC,CAAC,CAAC,CAAC;AAEhE;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,GAAG,SAAS,IAAI,gBAAgB,CAAC,CAAC,CAAC,GAAG;IACnE,UAAU,EAAE,gBAAgB,CAAC;CAC7B,CAAC;AAMF;;;;;;GAMG;AAEH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,IAAI,eAAe,CAK1E;AAED;;;;GAIG;AAEH,wBAAgB,aAAa,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,IAAI,WAAW,CAKlE;AAED;;;;;;GAMG;AAEH,wBAAgB,eAAe,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,IAAI,aAAa,CAKtE;AAMD;;;GAGG;AACH,wBAAgB,mBAAmB,CAClC,MAAM,EAAE,mBAAmB,EAC3B,KAAK,EAAE,MAAM,GACX,YAAY,CAoBd;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACpC,MAAM,EAAE,WAAW,EACnB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,GACV,aAAa,GAAG,eAAe,CAiBjC;AAMD;;;;GAIG;AAEH,eAAO,MAAM,eAAe,EAAE,MAAM,CAAC,GAAG,CAAC,EAI/B,CAAC"}
+{"version":3,"file":"policy.d.ts","sourceRoot":"","sources":["../src/policy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAK3C,wCAAwC;AACxC,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAChC,mDAAmD;AACnD,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEtC,oDAAoD;AACpD,MAAM,WAAW,UAAU,CAAC,CAAC,GAAG,IAAI;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;CACvB;AAED,wFAAwF;AACxF,MAAM,WAAW,oBAAoB,CAAC,CAAC,GAAG,IAAI,CAC7C,SAAQ,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC;IACnC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;CACzB;AAED,2EAA2E;AAC3E,MAAM,WAAW,aAAa;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,SAAS,CAAC,EAAE,WAAW,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAC;IACzD,8EAA8E;IAC9E,KAAK,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC;CACtC;AAED,+DAA+D;AAC/D,MAAM,MAAM,YAAY,GAAG,SAAS,aAAa,EAAE,CAAC;AAEpD,oFAAoF;AACpF,MAAM,MAAM,cAAc,CAAC,CAAC,GAAG,IAAI,IAAI;IACtC,OAAO,CACN,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,GAAG;QAAE,QAAQ,EAAE,YAAY,CAAA;KAAE,GAC/D,OAAO,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,YAAY,CAAC,CAAC;CACnD,CAAC,SAAS,CAAC,CAAC;AAEb,yCAAyC;AACzC,MAAM,WAAW,oBAAoB,CAAC,CAAC,GAAG,IAAI;IAC7C,IAAI,EAAE,UAAU,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,YAAY,CAAC,CAAC;IAC9E,QAAQ,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IACzC,aAAa,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;IAC9B,cAAc,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACrC;AAED,+EAA+E;AAC/E,MAAM,WAAW,0BAA0B,CAAC,CAAC,GAAG,IAAI;IACnD,IAAI,EAAE,UAAU,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,YAAY,CAAC;IACpB,OAAO,CACN,IAAI,EAAE,oBAAoB,CAAC,CAAC,CAAC,GAC3B,OAAO,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,YAAY,CAAC,CAAC;IACnD,QAAQ,CAAC,EAAE,KAAK,CAAC;IACjB,aAAa,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;IAC9B,cAAc,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACrC;AAED,6CAA6C;AAC7C,MAAM,MAAM,gBAAgB,CAAC,CAAC,GAAG,IAAI,IAClC,oBAAoB,CAAC,CAAC,CAAC,GACvB,0BAA0B,CAAC,CAAC,CAAC,CAAC;AAEjC,+DAA+D;AAC/D,MAAM,MAAM,aAAa,CAAC,CAAC,GAAG,IAAI,IAAI,oBAAoB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AACzE,qEAAqE;AACrE,MAAM,MAAM,uBAAuB,CAAC,CAAC,GAAG,IAAI,IAC3C,0BAA0B,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AAE1C,yFAAyF;AACzF,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;AAE3D,yEAAyE;AACzE,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,IAAI;IACtC,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;IACvB,OAAO,CAAC,EAAE,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,SAAS,CAAC;IACnD,UAAU,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;CAC1C;AAED,wCAAwC;AACxC,MAAM,MAAM,oBAAoB,CAAC,CAAC,GAAG,IAAI,IAAI,oBAAoB,CAAC,CAAC,CAAC,GACnE,aAAa,CAAC,CAAC,CAAC,CAAC;AAClB,8CAA8C;AAC9C,MAAM,MAAM,0BAA0B,CAAC,CAAC,GAAG,IAAI,IAC9C,0BAA0B,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;AAClD,mEAAmE;AACnE,MAAM,MAAM,gBAAgB,CAAC,CAAC,GAAG,OAAO,IACrC,oBAAoB,CAAC,CAAC,CAAC,GACvB,0BAA0B,CAAC,CAAC,CAAC,CAAC;AACjC,oEAAoE;AACpE,MAAM,MAAM,gBAAgB,CAAC,CAAC,GAAG,OAAO,IAAI,gBAAgB,CAAC,CAAC,CAAC,GAAG;IACjE,UAAU,EAAE,gBAAgB,CAAC;CAC7B,CAAC;AAEF,iFAAiF;AACjF,eAAO,MAAM,eAAe;;;;;0DAIlB,CAAC"}

package/esm/policy.js

@@ -1,128 +1,7 @@
 import { NoJsFileExtensions } from "./policies/NoJsFileExtensions.js";
 import { PackageJsonRepoDirectoryProperty } from "./policies/PackageJsonRepoDirectoryProperty.js";
 import { PackageJsonSorted } from "./policies/PackageJsonSorted.js";
-/**
- * Abstract base class for creating policies with object-based construction.
- *
- * @remarks
- * This class accepts a {@link PolicyShape} object in its constructor,
- * making it easier to add new optional properties in the future without breaking changes.
- *
- * @alpha
- */
-export class Policy {
-    name;
-    description;
-    match;
-    handler;
-    defaultConfig;
-    resolver;
-    constructor(definition) {
-        this.name = definition.name;
-        this.description = definition.description;
-        this.match = definition.match;
-        this.handler = definition.handler;
-        this.defaultConfig = definition.defaultConfig;
-        this.resolver = definition.resolver;
-    }
-}
-// ============================================================================
-// Type Guards
-// ============================================================================
-/**
- * Type guard to check if a result is a {@link PolicyFixResult} (legacy).
- *
- * @deprecated Use {@link isPolicyError} instead when working with the new {@link PolicyError} format.
- *
- * @alpha
- */
-// biome-ignore lint/suspicious/noExplicitAny: type guard
-export function isPolicyFixResult(toCheck) {
-    if (typeof toCheck !== "object" || toCheck === null) {
-        return false;
-    }
-    return "resolved" in toCheck;
-}
-/**
- * Type guard to check if a result is a PolicyError (new format).
- *
- * @alpha
- */
-// biome-ignore lint/suspicious/noExplicitAny: type guard
-export function isPolicyError(toCheck) {
-    if (typeof toCheck !== "object" || toCheck === null) {
-        return false;
-    }
-    return "error" in toCheck && typeof toCheck.error === "string";
-}
-/**
- * Type guard to check if a result is a {@link PolicyFailure} (legacy format).
- *
- * @deprecated Use {@link isPolicyError} instead when working with the new {@link PolicyError} format.
- *
- * @alpha
- */
-// biome-ignore lint/suspicious/noExplicitAny: type guard
-export function isPolicyFailure(toCheck) {
-    if (typeof toCheck !== "object" || toCheck === null) {
-        return false;
-    }
-    return "errorMessages" in toCheck && Array.isArray(toCheck.errorMessages);
-}
-// ============================================================================
-// Conversion Functions
-// ============================================================================
-/**
- * Converts a legacy PolicyFailure/PolicyFixResult to the new PolicyError format.
- * @internal
- */
-export function convertLegacyResult(result, _file) {
-    if (result === true) {
-        return true;
-    }
-    // Check if it's already the new format
-    if (isPolicyError(result)) {
-        return result;
-    }
-    // It's a legacy PolicyFailure or PolicyFixResult
-    const error = result.errorMessages?.join("; ") ?? "Policy violation";
-    const isFixResult = isPolicyFixResult(result);
-    return {
-        error,
-        fixable: result.autoFixable ?? false,
-        fixed: isFixResult ? result.resolved : undefined,
-        manualFix: result.manualFix,
-    };
-}
-/**
- * Converts a new PolicyError to the legacy PolicyFailure format.
- * @internal
- */
-export function convertToLegacyResult(result, policyName, file) {
-    const base = {
-        name: policyName,
-        file,
-        autoFixable: result.fixable,
-        errorMessages: [result.error],
-        manualFix: result.manualFix,
-    };
-    if (result.fixed !== undefined) {
-        return {
-            ...base,
-            resolved: result.fixed,
-        };
-    }
-    return base;
-}
-// ============================================================================
-// Default Policies
-// ============================================================================
-/**
- * Default policies included with repopo.
- *
- * @alpha
- */
-// biome-ignore lint/suspicious/noExplicitAny: FIXME
+/** The default definitions, configured when no policies are supplied. @public */
 export const DefaultPolicies = [
     NoJsFileExtensions,
     PackageJsonRepoDirectoryProperty,

package/esm/policy.js.map

@@ -1 +1 @@
-{"version":3,"file":"policy.js","sourceRoot":"","sources":["../src/policy.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,gCAAgC,EAAE,MAAM,gDAAgD,CAAC;AAClG,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AA8OpE;;;;;;;;GAQG;AACH,MAAM,OAAgB,MAAM;IACX,IAAI,CAAS;IACb,WAAW,CAAS;IACpB,KAAK,CAAS;IACd,OAAO,CAAmB;IAC1B,aAAa,CAAiB;IAC9B,QAAQ,CAA2C;IAEnE,YAAmB,UAA0B;QAC5C,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC;QAC1C,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;QAC9B,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;QAClC,IAAI,CAAC,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;IACrC,CAAC;CACD;AAsFD,+EAA+E;AAC/E,cAAc;AACd,+EAA+E;AAE/E;;;;;;GAMG;AACH,yDAAyD;AACzD,MAAM,UAAU,iBAAiB,CAAC,OAAY;IAC7C,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACrD,OAAO,KAAK,CAAC;IACd,CAAC;IACD,OAAO,UAAU,IAAI,OAAO,CAAC;AAC9B,CAAC;AAED;;;;GAIG;AACH,yDAAyD;AACzD,MAAM,UAAU,aAAa,CAAC,OAAY;IACzC,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACrD,OAAO,KAAK,CAAC;IACd,CAAC;IACD,OAAO,OAAO,IAAI,OAAO,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,CAAC;AAChE,CAAC;AAED;;;;;;GAMG;AACH,yDAAyD;AACzD,MAAM,UAAU,eAAe,CAAC,OAAY;IAC3C,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACrD,OAAO,KAAK,CAAC;IACd,CAAC;IACD,OAAO,eAAe,IAAI,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;AAC3E,CAAC;AAED,+EAA+E;AAC/E,uBAAuB;AACvB,+EAA+E;AAE/E;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAClC,MAA2B,EAC3B,KAAa;IAEb,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC;IACb,CAAC;IAED,uCAAuC;IACvC,IAAI,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3B,OAAO,MAAM,CAAC;IACf,CAAC;IAED,iDAAiD;IACjD,MAAM,KAAK,GAAG,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC;IACrE,MAAM,WAAW,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAE9C,OAAO;QACN,KAAK;QACL,OAAO,EAAE,MAAM,CAAC,WAAW,IAAI,KAAK;QACpC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;QAChD,SAAS,EAAE,MAAM,CAAC,SAAS;KAC3B,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CACpC,MAAmB,EACnB,UAAkB,EAClB,IAAY;IAEZ,MAAM,IAAI,GAAkB;QAC3B,IAAI,EAAE,UAAU;QAChB,IAAI;QACJ,WAAW,EAAE,MAAM,CAAC,OAAO;QAC3B,aAAa,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC;QAC7B,SAAS,EAAE,MAAM,CAAC,SAAS;KAC3B,CAAC;IAEF,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAChC,OAAO;YACN,GAAG,IAAI;YACP,QAAQ,EAAE,MAAM,CAAC,KAAK;SACI,CAAC;IAC7B,CAAC;IAED,OAAO,IAAI,CAAC;AACb,CAAC;AAED,+EAA+E;AAC/E,mBAAmB;AACnB,+EAA+E;AAE/E;;;;GAIG;AACH,oDAAoD;AACpD,MAAM,CAAC,MAAM,eAAe,GAAkB;IAC7C,kBAAkB;IAClB,gCAAgC;IAChC,iBAAiB;CACR,CAAC","sourcesContent":["import type { Operation } from \"effection\";\nimport { NoJsFileExtensions } from \"./policies/NoJsFileExtensions.js\";\nimport { PackageJsonRepoDirectoryProperty } from \"./policies/PackageJsonRepoDirectoryProperty.js\";\nimport { PackageJsonSorted } from \"./policies/PackageJsonSorted.js\";\n\n/**\n * A type representing a policy name.\n *\n * @alpha\n */\nexport type PolicyName = string;\n\n/**\n * A stable identifier for a configured policy instance.\n *\n * @alpha\n */\nexport type PolicyInstanceId = string;\n\n/**\n * Arguments passed to policy handler functions.\n *\n * @alpha\n */\nexport interface PolicyArgs<C = void> {\n\t/**\n\t * Path to the file, relative to the repo root.\n\t */\n\tfile: string;\n\n\t/**\n\t * Absolute path to the root of the repo.\n\t */\n\troot: string;\n\n\t/**\n\t * If true, the handler should resolve any violations automatically if possible.\n\t */\n\tresolve: boolean;\n\n\t/**\n\t * Optional configuration for the policy.\n\t */\n\tconfig?: C | undefined;\n}\n\n/**\n * @deprecated Use {@link PolicyArgs} instead.\n * @alpha\n */\nexport type PolicyFunctionArguments<C> = PolicyArgs<C>;\n\n// ============================================================================\n// New Result Types\n// ============================================================================\n\n/**\n * A policy error returned when a file fails a policy check.\n *\n * @alpha\n */\nexport interface PolicyError {\n\t/**\n\t * The error message describing what failed.\n\t */\n\terror: string;\n\n\t/**\n\t * Set to `true` if the policy violation can be fixed automatically.\n\t */\n\tfixable?: boolean | undefined;\n\n\t/**\n\t * Set to `true` if the violation was successfully fixed (only set when resolve=true).\n\t */\n\tfixed?: boolean | undefined;\n\n\t/**\n\t * An optional string that tells the user how to manually fix the failure.\n\t */\n\tmanualFix?: string | undefined;\n}\n\n/**\n * The result of a policy handler.\n * Returns `true` if the file passes the policy, or a {@link PolicyError} if it fails.\n *\n * @alpha\n */\nexport type PolicyResult = true | PolicyError;\n\n// ============================================================================\n// Legacy Result Types (Still supported for backward compatibility)\n// ============================================================================\n\n/**\n * A policy failure (legacy format).\n *\n * @deprecated Use {@link PolicyError} instead, which has a simpler API.\n *\n * @alpha\n */\nexport interface PolicyFailure {\n\t/**\n\t * Name of the policy that failed.\n\t */\n\tname: PolicyName;\n\n\t/**\n\t * Path to the file that failed the policy.\n\t */\n\tfile: string;\n\n\t/**\n\t * Set to `true` if the policy can be fixed automatically.\n\t */\n\tautoFixable?: boolean | undefined;\n\n\t/**\n\t * An optional error message accompanying the failure.\n\t */\n\terrorMessages: string[];\n\n\t/**\n\t * An optional string that tells the user how to fix the failure(s).\n\t */\n\tmanualFix?: string | undefined;\n}\n\n/**\n * The result of an automatic fix for a failing policy (legacy format).\n *\n * @deprecated Use {@link PolicyError} with `fixed: boolean` instead.\n *\n * @alpha\n */\nexport interface PolicyFixResult extends PolicyFailure {\n\t/**\n\t * Set to true if the failure was resolved by the automated fixer.\n\t */\n\tresolved: boolean;\n}\n\n/**\n * Result type that accepts both legacy and new formats.\n *\n * @alpha\n */\nexport type PolicyHandlerResult =\n\t| true\n\t| PolicyFailure\n\t| PolicyFixResult\n\t| PolicyError;\n\n// ============================================================================\n// Handler Types\n// ============================================================================\n\n/**\n * A policy handler function that checks a file against a policy.\n *\n * @remarks\n * Policy handlers can be implemented in two ways:\n * - As an async function returning a Promise\n * - As an Effection generator function returning an Operation\n *\n * Both styles are supported. Async handlers are automatically wrapped for Effection.\n *\n * Handlers can return either the legacy format ({@link PolicyFailure}) or\n * the new format ({@link PolicyError}). The new format is simpler and recommended\n * for new policies.\n *\n * @alpha\n */\nexport type PolicyHandler<C = unknown | undefined> =\n\t| ((args: PolicyArgs<C>) => Promise<PolicyHandlerResult>)\n\t| ((args: PolicyArgs<C>) => Operation<PolicyHandlerResult>);\n\n/**\n * A standalone resolver function that can fix policy violations (legacy format).\n *\n * @deprecated Use {@link PolicyResolver} instead, which uses {@link PolicyError}.\n *\n * @alpha\n */\nexport type PolicyStandaloneResolver<C = undefined> = (\n\targs: Omit<PolicyArgs<C>, \"resolve\">,\n) => Promise<PolicyFixResult> | Operation<PolicyFixResult>;\n\n/**\n * A standalone resolver function using the new format.\n *\n * @alpha\n */\nexport type PolicyResolver<C = void> = (\n\targs: Omit<PolicyArgs<C>, \"resolve\">,\n) => Promise<PolicyError> | Operation<PolicyError>;\n\n// ============================================================================\n// Policy Definition Types\n// ============================================================================\n\n/**\n * Interface describing the shape of a policy definition.\n *\n * @typeParam C - Type of configuration object used by the policy\n *\n * @alpha\n */\nexport interface PolicyShape<C = void> {\n\t/**\n\t * The name of the policy; displayed in UI and used in settings.\n\t */\n\tname: PolicyName;\n\n\t/**\n\t * A detailed description of the policy and its purpose.\n\t */\n\tdescription: string;\n\n\t/**\n\t * A regular expression that matches files this policy applies to.\n\t */\n\tmatch: RegExp;\n\n\t/**\n\t * The handler function that checks if a file complies with the policy.\n\t */\n\thandler: PolicyHandler<C>;\n\n\t/**\n\t * An optional resolver function that can automatically fix violations.\n\t */\n\tresolver?: PolicyStandaloneResolver<C> | undefined;\n\n\t/**\n\t * A default configuration that will be used if none is provided.\n\t */\n\tdefaultConfig?: C | undefined;\n}\n\n/**\n * Abstract base class for creating policies with object-based construction.\n *\n * @remarks\n * This class accepts a {@link PolicyShape} object in its constructor,\n * making it easier to add new optional properties in the future without breaking changes.\n *\n * @alpha\n */\nexport abstract class Policy<C = void> implements PolicyShape<C> {\n\tpublic readonly name: string;\n\tpublic readonly description: string;\n\tpublic readonly match: RegExp;\n\tpublic readonly handler: PolicyHandler<C>;\n\tpublic readonly defaultConfig?: C | undefined;\n\tpublic readonly resolver?: PolicyStandaloneResolver<C> | undefined;\n\n\tpublic constructor(definition: PolicyShape<C>) {\n\t\tthis.name = definition.name;\n\t\tthis.description = definition.description;\n\t\tthis.match = definition.match;\n\t\tthis.handler = definition.handler;\n\t\tthis.defaultConfig = definition.defaultConfig;\n\t\tthis.resolver = definition.resolver;\n\t}\n}\n\n/**\n * @deprecated Use {@link PolicyShape} instead.\n * @alpha\n */\nexport type PolicyDefinition<C = undefined> = PolicyShape<C>;\n\n/**\n * A policy instance with configuration and exclusion settings applied.\n *\n * @typeParam C - Type of configuration object used by the policy\n *\n * @alpha\n */\nexport interface ConfiguredPolicy<C = void> extends PolicyShape<C> {\n\t/**\n\t * An optional stable identifier for this configured policy instance.\n\t *\n\t * This is required when the same policy definition is configured more than once.\n\t */\n\tinstanceId?: PolicyInstanceId | undefined;\n\n\t/**\n\t * The configuration applied to this policy instance.\n\t */\n\tconfig?: C | undefined;\n\n\t/**\n\t * File paths matching these patterns will be excluded from this policy.\n\t * @deprecated Use `excludeFiles` instead for backward compatibility.\n\t */\n\texclude?: (string | RegExp)[] | undefined;\n\n\t/**\n\t * File paths matching these patterns will be excluded from this policy.\n\t */\n\texcludeFiles?: (string | RegExp)[] | undefined;\n\n\t/**\n\t * Internal normalized handler (always an Effection Operation).\n\t * This is set by the policy() function and used by the execution engine.\n\t * @internal\n\t */\n\t_internalHandler?: (args: PolicyArgs<C>) => Operation<PolicyHandlerResult>;\n}\n\n/**\n * Settings for configuring a policy instance.\n * @alpha\n */\nexport interface PolicyInstanceSettings<C> {\n\t/**\n\t * A stable identifier for this configured policy instance.\n\t */\n\tinstanceId?: PolicyInstanceId | undefined;\n\n\t/**\n\t * An array of strings/regular expressions. File paths that match any of these expressions will be completely excluded\n\t * from policy.\n\t *\n\t * Paths will be matched relative to the root of the repo.\n\t */\n\texcludeFiles?: (string | RegExp)[];\n\n\t/**\n\t * The config that is applied to the policy instance.\n\t */\n\tconfig?: C | undefined;\n}\n\n/**\n * @deprecated Use {@link ConfiguredPolicy} instead.\n * @alpha\n */\nexport type PolicyInstance<C = undefined> = ConfiguredPolicy<C>;\n\n/**\n * A configured policy instance with its runtime identity assigned.\n *\n * @alpha\n */\nexport type IdentifiedPolicy<C = undefined> = ConfiguredPolicy<C> & {\n\tinstanceId: PolicyInstanceId;\n};\n\n// ============================================================================\n// Type Guards\n// ============================================================================\n\n/**\n * Type guard to check if a result is a {@link PolicyFixResult} (legacy).\n *\n * @deprecated Use {@link isPolicyError} instead when working with the new {@link PolicyError} format.\n *\n * @alpha\n */\n// biome-ignore lint/suspicious/noExplicitAny: type guard\nexport function isPolicyFixResult(toCheck: any): toCheck is PolicyFixResult {\n\tif (typeof toCheck !== \"object\" || toCheck === null) {\n\t\treturn false;\n\t}\n\treturn \"resolved\" in toCheck;\n}\n\n/**\n * Type guard to check if a result is a PolicyError (new format).\n *\n * @alpha\n */\n// biome-ignore lint/suspicious/noExplicitAny: type guard\nexport function isPolicyError(toCheck: any): toCheck is PolicyError {\n\tif (typeof toCheck !== \"object\" || toCheck === null) {\n\t\treturn false;\n\t}\n\treturn \"error\" in toCheck && typeof toCheck.error === \"string\";\n}\n\n/**\n * Type guard to check if a result is a {@link PolicyFailure} (legacy format).\n *\n * @deprecated Use {@link isPolicyError} instead when working with the new {@link PolicyError} format.\n *\n * @alpha\n */\n// biome-ignore lint/suspicious/noExplicitAny: type guard\nexport function isPolicyFailure(toCheck: any): toCheck is PolicyFailure {\n\tif (typeof toCheck !== \"object\" || toCheck === null) {\n\t\treturn false;\n\t}\n\treturn \"errorMessages\" in toCheck && Array.isArray(toCheck.errorMessages);\n}\n\n// ============================================================================\n// Conversion Functions\n// ============================================================================\n\n/**\n * Converts a legacy PolicyFailure/PolicyFixResult to the new PolicyError format.\n * @internal\n */\nexport function convertLegacyResult(\n\tresult: PolicyHandlerResult,\n\t_file: string,\n): PolicyResult {\n\tif (result === true) {\n\t\treturn true;\n\t}\n\n\t// Check if it's already the new format\n\tif (isPolicyError(result)) {\n\t\treturn result;\n\t}\n\n\t// It's a legacy PolicyFailure or PolicyFixResult\n\tconst error = result.errorMessages?.join(\"; \") ?? \"Policy violation\";\n\tconst isFixResult = isPolicyFixResult(result);\n\n\treturn {\n\t\terror,\n\t\tfixable: result.autoFixable ?? false,\n\t\tfixed: isFixResult ? result.resolved : undefined,\n\t\tmanualFix: result.manualFix,\n\t};\n}\n\n/**\n * Converts a new PolicyError to the legacy PolicyFailure format.\n * @internal\n */\nexport function convertToLegacyResult(\n\tresult: PolicyError,\n\tpolicyName: string,\n\tfile: string,\n): PolicyFailure | PolicyFixResult {\n\tconst base: PolicyFailure = {\n\t\tname: policyName,\n\t\tfile,\n\t\tautoFixable: result.fixable,\n\t\terrorMessages: [result.error],\n\t\tmanualFix: result.manualFix,\n\t};\n\n\tif (result.fixed !== undefined) {\n\t\treturn {\n\t\t\t...base,\n\t\t\tresolved: result.fixed,\n\t\t} satisfies PolicyFixResult;\n\t}\n\n\treturn base;\n}\n\n// ============================================================================\n// Default Policies\n// ============================================================================\n\n/**\n * Default policies included with repopo.\n *\n * @alpha\n */\n// biome-ignore lint/suspicious/noExplicitAny: FIXME\nexport const DefaultPolicies: Policy<any>[] = [\n\tNoJsFileExtensions,\n\tPackageJsonRepoDirectoryProperty,\n\tPackageJsonSorted,\n] as const;\n"]}
+{"version":3,"file":"policy.js","sourceRoot":"","sources":["../src/policy.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,gCAAgC,EAAE,MAAM,gDAAgD,CAAC;AAClG,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AAqGpE,iFAAiF;AACjF,MAAM,CAAC,MAAM,eAAe,GAAG;IAC9B,kBAAkB;IAClB,gCAAgC;IAChC,iBAAiB;CACR,CAAC","sourcesContent":["import type { Operation } from \"effection\";\nimport { NoJsFileExtensions } from \"./policies/NoJsFileExtensions.js\";\nimport { PackageJsonRepoDirectoryProperty } from \"./policies/PackageJsonRepoDirectoryProperty.js\";\nimport { PackageJsonSorted } from \"./policies/PackageJsonSorted.js\";\n\n/** Display name of a policy. @public */\nexport type PolicyName = string;\n/** Stable configured-instance identity. @public */\nexport type PolicyInstanceId = string;\n\n/** Arguments supplied to a file handler. @public */\nexport interface PolicyArgs<C = void> {\n\tfile: string;\n\troot: string;\n\tresolve: boolean;\n\tconfig?: C | undefined;\n}\n\n/** Arguments supplied to a repository handler; selection never limits files. @public */\nexport interface RepositoryPolicyArgs<C = void>\n\textends Omit<PolicyArgs<C>, \"file\"> {\n\tfiles: readonly string[];\n}\n\n/** A single independently actionable violation or recorded fix. @public */\nexport interface PolicyFinding {\n\tmessage: string;\n\tmanualFix?: string | undefined;\n\tfixStatus?: \"available\" | \"fixed\" | \"failed\" | undefined;\n\t/** Repo-relative affected files. Only repository handlers may supply this. */\n\tfiles?: readonly string[] | undefined;\n}\n\n/** Empty means pass. Fixed findings remain visible. @public */\nexport type PolicyResult = readonly PolicyFinding[];\n\n/** Standalone file fixers receive and return the complete findings list. @public */\nexport type PolicyResolver<C = void> = {\n\tresolve(\n\t\targs: Omit<PolicyArgs<C>, \"resolve\"> & { findings: PolicyResult },\n\t): Promise<PolicyResult> | Operation<PolicyResult>;\n}[\"resolve\"];\n\n/** File scope is the default. @public */\nexport interface FilePolicyDefinition<C = void> {\n\tname: PolicyName;\n\tdescription: string;\n\tscope?: \"file\";\n\tmatch: RegExp;\n\thandler(args: PolicyArgs<C>): Promise<PolicyResult> | Operation<PolicyResult>;\n\tresolver?: PolicyResolver<C> | undefined;\n\tdefaultConfig?: C | undefined;\n\trequiresConfig?: boolean | undefined;\n}\n\n/** Repository scope is explicit; repository fixers are inline only. @public */\nexport interface RepositoryPolicyDefinition<C = void> {\n\tname: PolicyName;\n\tdescription: string;\n\tscope: \"repository\";\n\thandler(\n\t\targs: RepositoryPolicyArgs<C>,\n\t): Promise<PolicyResult> | Operation<PolicyResult>;\n\tresolver?: never;\n\tdefaultConfig?: C | undefined;\n\trequiresConfig?: boolean | undefined;\n}\n\n/** A canonical policy definition. @public */\nexport type PolicyDefinition<C = void> =\n\t| FilePolicyDefinition<C>\n\t| RepositoryPolicyDefinition<C>;\n\n/** Async and Effection file handlers are supported. @public */\nexport type PolicyHandler<C = void> = FilePolicyDefinition<C>[\"handler\"];\n/** Async and Effection repository handlers are supported. @public */\nexport type RepositoryPolicyHandler<C = void> =\n\tRepositoryPolicyDefinition<C>[\"handler\"];\n\n/** Exclude undefined (including void) while preserving allowed null values. @internal */\nexport type DefinedConfig<C> = NonNullable<C> | (C & null);\n\n/** Instance configuration and repo-relative regex exclusions. @public */\nexport interface PolicyOptions<C = void> {\n\tconfig?: C | undefined;\n\texclude?: readonly (string | RegExp)[] | undefined;\n\tinstanceId?: PolicyInstanceId | undefined;\n}\n\n/** A configured file policy. @public */\nexport type ConfiguredFilePolicy<C = void> = FilePolicyDefinition<C> &\n\tPolicyOptions<C>;\n/** A configured repository policy. @public */\nexport type ConfiguredRepositoryPolicy<C = void> =\n\tRepositoryPolicyDefinition<C> & PolicyOptions<C>;\n/** A configured policy, retaining scope discrimination. @public */\nexport type ConfiguredPolicy<C = unknown> =\n\t| ConfiguredFilePolicy<C>\n\t| ConfiguredRepositoryPolicy<C>;\n/** A configured policy with a validated stable identity. @public */\nexport type IdentifiedPolicy<C = unknown> = ConfiguredPolicy<C> & {\n\tinstanceId: PolicyInstanceId;\n};\n\n/** The default definitions, configured when no policies are supplied. @public */\nexport const DefaultPolicies = [\n\tNoJsFileExtensions,\n\tPackageJsonRepoDirectoryProperty,\n\tPackageJsonSorted,\n] as const;\n"]}

package/esm/policyDefiners/defineCargoPolicy.d.ts

@@ -1,9 +1,9 @@
 import { type Operation } from "effection";
-import type { PolicyArgs, PolicyHandlerResult, PolicyShape } from "../policy.js";
+import type { DefinedConfig, FilePolicyDefinition, PolicyArgs, PolicyResult } from "../policy.js";
 /**
  * A parsed Cargo.toml represented as a record of sections and values.
  *
- * @alpha
+ * @public
  */
 export type CargoToml = Record<string, unknown>;
 /**
@@ -12,13 +12,13 @@ export type CargoToml = Record<string, unknown>;
  * @remarks
  * Receives the parsed TOML content and the standard policy arguments.
  *
- * @alpha
+ * @public
  */
-export type CargoTomlHandler<C> = (toml: CargoToml, args: PolicyArgs<C>) => Operation<PolicyHandlerResult> | Promise<PolicyHandlerResult>;
+export type CargoTomlHandler<C> = (toml: CargoToml, args: PolicyArgs<C>) => Operation<PolicyResult> | Promise<PolicyResult>;
 /**
  * Input arguments for defining a Cargo.toml policy.
  *
- * @alpha
+ * @public
  */
 export interface DefineCargoPolicyArgs<C> {
     /**
@@ -37,6 +37,7 @@ export interface DefineCargoPolicyArgs<C> {
      * Optional default configuration for the policy.
      */
     defaultConfig?: C;
+    requiresConfig?: boolean;
 }
 /**
  * Define a repo policy for Cargo.toml files.
@@ -45,6 +46,9 @@ export interface DefineCargoPolicyArgs<C> {
  * This is a helper function that creates a policy pre-configured to match
  * Cargo.toml files. The handler receives the parsed TOML content.
  *
+ * @param args - Policy metadata, parsed-TOML handler, and optional defaults.
+ * @returns A file policy that reads and parses matching Cargo.toml files.
+ *
  * @example
  * ```typescript
  * const MyCargoPolicy = defineCargoPolicy({
@@ -53,14 +57,26 @@ export interface DefineCargoPolicyArgs<C> {
  *   handler: async (toml, { file }) => {
  *     const pkg = toml.package as Record<string, unknown> | undefined;
  *     if (!pkg?.name) {
- *       return { error: "Missing package name", fixable: false };
+ *       return [{ message: "Missing package name" }];
  *     }
- *     return true;
+ *     return [];
  *   },
  * });
  * ```
  *
- * @alpha
+ * @public
  */
-export declare function defineCargoPolicy<C = undefined>(args: DefineCargoPolicyArgs<C>): PolicyShape<C>;
+export declare function defineCargoPolicy<C = void>(args: DefineCargoPolicyArgs<C> & {
+    defaultConfig: DefinedConfig<C>;
+}): FilePolicyDefinition<C> & {
+    defaultConfig: DefinedConfig<C>;
+};
+/** Define a Cargo policy that requires explicit configuration. @public */
+export declare function defineCargoPolicy<C = void>(args: DefineCargoPolicyArgs<C> & {
+    requiresConfig: true;
+}): FilePolicyDefinition<C> & {
+    requiresConfig: true;
+};
+/** Define a Cargo policy with optional configuration. @public */
+export declare function defineCargoPolicy<C = void>(args: DefineCargoPolicyArgs<C>): FilePolicyDefinition<C>;
 //# sourceMappingURL=defineCargoPolicy.d.ts.map