repopo 0.12.0 → 0.13.0

package/CHANGELOG.md

@@ -1,5 +1,58 @@
 # repopo
 
+## 0.13.0
+
+### Minor Changes
+
+- Introduce a shared API for file and repository policies, with consistent check results and fix status reporting. _[`#811`](https://github.com/tylerbutler/tools-monorepo/pull/811) [`d76e9e7`](https://github.com/tylerbutler/tools-monorepo/commit/d76e9e72c8d75863a97517ca662001aa567207da) [@tylerbutler](https://github.com/tylerbutler)_
+
+	
+	**Breaking change:** Update custom policies and configurations together.
+	This change is released as a minor version while the packages are pre-1.0.
+	See the [migration guide](https://repopo.tylerbutler.com/usage/migration/) for replacements for removed APIs and complete examples.
+	
+	Key migration steps for `repopo`:
+	
+	- Define policies as objects with `satisfies FilePolicyDefinition<C>` or `satisfies RepositoryPolicyDefinition<C>` instead of policy classes or factory aliases. Use `definePackagePolicy` instead of `generatePackagePolicy`.
+	- Configure policies with `makePolicy(definition, { config, exclude, instanceId })` instead of positional configuration or a third argument. Instance exclusions use `exclude`; global `RepopoConfig.excludeFiles` remains supported. Repeated instances of the same policy need unique `instanceId` values.
+	- Mark required configuration with `requiresConfig: true` and supply complete settings or a complete default. Omitted or `undefined` configuration selects the default; explicit configuration replaces it without merging.
+	- Return arrays of findings instead of the previous success and failure results. An empty handler result passes. Findings use `message`, optional `manualFix`, and optional `fixStatus: "available" | "fixed" | "failed"`. Only `"fixed"` resolves a finding; `"fixed"` and `"failed"` are valid only in fix mode. Standalone resolvers must return the findings they update; returning `[]` does not resolve the original findings.
+	- Run policies with `runPolicies(options)` for Promise-based code or `new PolicyRunner(options).run()` for Effection code. Results separate `findings`, `errors`, `skipped`, and `perfStats`. Input and registration errors throw; policy execution errors are collected.
+	- Supply the full repository `inventory` or an async inventory loader when running repository policies programmatically. Use a loader to refresh the inventory after file fixes and between repository fixes. `LicenseFileExists` and `SharedDependencyVersions` now check the whole repository, even with an empty file selection or `--stdin`. Repository fixes can modify files outside the selected list.
+	
+	In fix mode, an execution error stops later work on the affected file and skips repository policies, or stops later repository policies if the error occurs in that phase.
+	Completed writes are not rolled back.
+	Both `check` and `check-native` follow these rules.
+	
+	Import the programmatic API from `repopo/api` and built-in policies from `repopo/policies`.
+	The root `repopo` entry point also exports the CLI's `run` function.
+	
+	For `sort-tsconfig`, the exported `SortTsconfigsPolicy` is now a file policy definition.
+	Configure it with the same `makePolicy` options object.
+	If you call its handler directly, update your code to handle finding arrays and fix statuses.
+	
+	For `remark-repopo-policies`, generated policy tables now read instance exclusions from `exclude`, so exclusion details remain visible after migration.
+
+### Patch Changes
+
+- Speed up read-only checks by processing up to eight files at a time and avoiding repeated parsing of `package.json`, `Cargo.toml`, and `gleam.toml` files. _[`#807`](https://github.com/tylerbutler/tools-monorepo/pull/807) [`5e6c97b`](https://github.com/tylerbutler/tools-monorepo/commit/5e6c97b9afa99c93b1728ee0e48b45fa0a130501) [@tylerbutler](https://github.com/tylerbutler)_
+
+	Each policy still receives an independent copy of the parsed data.
+	
+	Set the file limit with `--concurrency` on `repopo check` or `repopo check-native`, or with `PolicyRunnerOptions.concurrency` in the programmatic API.
+	Use `--concurrency 1` for custom policies that must process files one at a time.
+	Automatic fixes still run one at a time and read fresh file contents.
+- Correct the reported file counts so each file that passes global exclusions is counted once, regardless of how many policies run on it. _[`#779`](https://github.com/tylerbutler/tools-monorepo/pull/779) [`ca340db`](https://github.com/tylerbutler/tools-monorepo/commit/ca340dbefce4e967ecf73a043207ec13b0651213) [@tylerbutler](https://github.com/tylerbutler)_
+
+	Ignore empty entries in file lists from Git and `--stdin`, so blank records do not become file paths.
+- Show a policy's manual fix instructions when `repopo check` or `repopo check-native` reports an unresolved violation, including after a failed automatic fix. _[`#803`](https://github.com/tylerbutler/tools-monorepo/pull/803) [`c401c9c`](https://github.com/tylerbutler/tools-monorepo/commit/c401c9c7ab783222afac4df6de0b421dbe215093) [@tylerbutler](https://github.com/tylerbutler)_
+
+	If the automatic fixer does not provide instructions, keep the policy's original guidance.
+	Do not show manual fix instructions for violations that were successfully fixed.
+- Reject file paths that resolve outside the repository root in `repopo check`, including paths supplied with `--stdin`. _[`#665`](https://github.com/tylerbutler/tools-monorepo/pull/665) [`1333d28`](https://github.com/tylerbutler/tools-monorepo/commit/1333d287abdee51a01a22540914600877fe8f557) [@tylerbutler](https://github.com/tylerbutler)_
+
+	Apply the same validation to package and file-header policy helpers, so these checks and fixes reject paths such as `../outside.txt`.
+
 ## 0.12.0
 
 ### Minor Changes

package/README.md

@@ -3,104 +3,55 @@
 repopo is a tool to apply policies to the files in your git repo. You can think of it as a sort of lint tool for any
 file in your git repo, with a straightforward way to write your own policies.
 
+**Documentation: <https://repopo.tylerbutler.com>**
+
 <!-- toc -->
 * [repopo - police the files in your git repo with extensible policies](#repopo---police-the-files-in-your-git-repo-with-extensible-policies)
-* [Configuring policies](#configuring-policies)
-* [Included policies](#included-policies)
-* [Policy generators](#policy-generators)
+* [Quick start](#quick-start)
+* [Documentation](#documentation)
 * [CLI Usage](#cli-usage)
 <!-- tocstop -->
 
-# Configuring policies
-
-Repopo and its policies can be configured in a `repopo.config.ts` (or `.cjs`, or `.mjs`) file in the root of the repo. Using a
-TypeScript configuration file is recommended.
-
-The policy config must export a default object of the type `PolicyConfig`.
-
-Omit `policies` to use the default policies with either `check` or `check-native`.
-Set `policies: []` to disable them.
-
-With `check --fix`, policies run in configuration order for each file so that one
-fix does not overwrite another. Read-only checks can run policies concurrently.
-
-## Excluding files from policy check
-
-By default, all files in the repo are checked. You can exclude files completely from the policy check by configuring the
-d `excludeFiles` setting. It should be an array of strings/regular expressions. Paths that match any of these
-expressions will be completely excluded from all policies.
-
-You can exclude files from individual policies as well by configuring the `excludeFiles` setting when calling
-`makePolicy`.
-
-## Configuring individual policies
-
-Individual policies can be configured by passing configuration settings to a `PolicyDefinition` in `makePolicy`.
-
-# Included policies
-
-repopo includes the following policies. All of the included policies are enabled by default.
-
-## HtmlFileHeaders and JsTsFileHeaders
+# Quick start
 
-Use `HtmlFileHeaders` for `.html` and `.htm` files, and `JsTsFileHeaders` for
-JavaScript and TypeScript files.
+Install repopo as a dev dependency:
 
-### Configuration
-
-Pass `{ headerText: "Copyright Example" }` to `policy()` for either policy.
-Checks compare the file header with that configured text; `--fix` adds a missing header.
-
-## NoJsFileExtensions
-
-The NoJsFileExtensions policy checks for JavaScript source files that just use the .js file extension. Such files may be
-interpreted by Node.js as either CommonJS or ESM based on the `type` field in the nearest package.json file. This can
-create unexpected behavior for JS files; changing the package.json nearest to one will change how the JS is processed by
-node. Using explicit file extensions reduces ambiguity and ensures a CJS file isn't suddenly treated like an ESM file.
-
-## PackageJsonProperties
-
-The PackageJsonProperties policy is used to enforce fields in package.json files across the repo.
-
-### Configuration
+```bash
+pnpm add -D repopo
+```
 
-The `verbatim` setting requires that all the configured fields in package.json match the values in the configuration.
-Array values replace existing arrays rather than append to them. Unspecified object fields remain unchanged.
+Create `repopo.config.ts` in the root of the repo:
 
 ```ts
-import type { PolicyConfig } from "@tylerbu/repopo";
-const config: PolicyConfig = {
-	policySettings: {
-		PackageJsonProperties: {
-      // This setting will force all package.json files to contain these fields with the exact configured values.
-			verbatim: {
-				license: "MIT",
-				author: "Tyler Butler <tyler@tylerbutler.com>",
-				bugs: "https://github.com/tylerbutler/tools-monorepo/issues",
-				repository: {
-					type: "git",
-					url: "git+https://github.com/tylerbutler/tools-monorepo.git",
-				}
-			}
-		}
-	}
-};
+import { makePolicy, type RepopoConfig } from "repopo";
+import { NoJsFileExtensions, PackageJsonProperties } from "repopo/policies";
+
+export default {
+	policies: [
+		makePolicy(NoJsFileExtensions, { exclude: ["^bin/"] }),
+		makePolicy(PackageJsonProperties, {
+			config: { verbatim: { license: "MIT" } },
+		}),
+	],
+} satisfies RepopoConfig;
 ```
 
-## PackageJsonRepoDirectoryProperty
+Then check the repo, and fix what can be fixed automatically:
 
-A RepoPolicy that checks that the `repository.directory` property in package.json is set correctly. If the repository
-field is a string instead of an object the package will be ignored.
-
-# Policy generators
-
-There are some filetypes that often have policies applied to them, like package.json. You can use the policy generator
-functions to generate policies for those filetypes. Using the generators is not required; they simply reduce the amount
-of boilerplate code you have to write for a policy.
+```bash
+repopo check
+repopo check --fix
+```
 
-## generatePackagePolicy
+# Documentation
 
-Use `generatePackagePolicy` to generate policies for package.json files.
+- [Configuration](https://repopo.tylerbutler.com/usage/config/): choosing policies, policy options, and file exclusions
+- [Built-in policies](https://repopo.tylerbutler.com/policies/built-in/): every included policy and its options
+- [Custom policies](https://repopo.tylerbutler.com/policies/custom/): writing file and repository policies
+- [Programmatic API](https://repopo.tylerbutler.com/usage/programmatic-api/): running policies with `runPolicies` and `PolicyRunner`
+- [Migrating to the 1.0 API](https://repopo.tylerbutler.com/usage/migration/): breaking changes to configuration, policy results, and runners
+- [Benchmarking](https://repopo.tylerbutler.com/usage/benchmarking/): comparing the TypeScript and Rust engines
+- [API reference](https://repopo.tylerbutler.com/api/readme/)
 
 # CLI Usage
 
@@ -115,15 +66,22 @@ Checks and applies policies to the files in the repository.
 
 ```
 USAGE
-  $ repopo check [-v | --quiet] [-f] [--stdin]
+  $ repopo check [-v | --quiet] [--concurrency <value>] [-f] [--stdin]
 
 FLAGS
-  -f, --fix    Fix errors if possible.
-      --stdin  Read list of files from stdin.
+  -f, --fix                  Fix errors if possible.
+      --concurrency=<value>  [default: 8] Maximum concurrent files in read-only checks. Fixes remain sequential.
+      --stdin                Read list of files from stdin.
 
 LOGGING FLAGS
   -v, --verbose  Enable verbose logging.
       --quiet    Disable all logging.
+
+DESCRIPTION
+  Checks and applies policies to the files in the repository.
+
+  File policies check selected files. Repository policies always run with the full repository file inventory, including
+  with --stdin. With --fix, repository policies can modify files outside the stdin selection.
 ```
 
 _See code: [src/commands/check.ts](https://github.com/tylerbutler/tools-monorepo/blob/main/packages/repopo/src/commands/check.ts)_
@@ -134,8 +92,8 @@ Checks and applies policies using the Rust engine.
 
 ```
 USAGE
-  $ repopo check-native [-f] [--stdin] [-v] [-q] [-c <value>] [--sidecar-path <value>] [--binary-path <value>]
-    [--runtime auto|node|bun]
+  $ repopo check-native [--concurrency <value>] [-f] [--stdin] [-v] [-q] [-c <value>] [--sidecar-path <value>]
+    [--binary-path <value>] [--runtime auto|node|bun]
 
 FLAGS
   -c, --config=<value>        Path to the config file.
@@ -143,6 +101,7 @@ FLAGS
   -q, --quiet                 Suppress all output except errors.
   -v, --verbose               Show verbose output including per-policy timing.
       --binary-path=<value>   [env: REPOPO_CORE_PATH] Path to the repopo-core Rust binary.
+      --concurrency=<value>   [default: 8] Maximum concurrent files in read-only checks. Fixes remain sequential.
       --runtime=<option>      [env: REPOPO_RUNTIME] JS runtime for the sidecar process (auto, node, bun).
                               <options: auto|node|bun>
       --sidecar-path=<value>  [env: REPOPO_SIDECAR_PATH] Path to the Node.js sidecar script.
@@ -151,8 +110,9 @@ FLAGS
 DESCRIPTION
   Checks and applies policies using the Rust engine.
 
-  Runs the Rust-based repopo-core engine with the Node.js sidecar. This provides the same policy checking as 'check' but
-  with Rust-based file enumeration, regex matching, and orchestration for better performance.
+  Runs the Rust-based repopo-core engine with the Node.js sidecar. Rust handles file matching, scheduling and reporting;
+  the sidecar shares per-policy contracts with 'check'. Repository policies always run with the full repository
+  inventory, including with --stdin. With --fix, repository policies can modify files outside the stdin selection.
 ```
 
 _See code: [src/commands/check-native.ts](https://github.com/tylerbutler/tools-monorepo/blob/main/packages/repopo/src/commands/check-native.ts)_

package/THIRD-PARTY-LICENSES.txt

@@ -27,7 +27,7 @@ OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHE
 
 The following npm package may be included in this product:
 
- - @rushstack/node-core-library@5.23.1
+ - @rushstack/node-core-library@5.25.1
 
 This package contains the following license:
 
@@ -90,7 +90,7 @@ Copyright (c) 2024-present Cedric van Putten <me@cedric.dev>
 
 The following npm package may be included in this product:
 
- - @fluid-tools/build-infrastructure@0.65.0
+ - @fluid-tools/build-infrastructure@0.68.0
 
 This package contains the following license:
 
@@ -118,6 +118,136 @@ SOFTWARE.
 
 -----------
 
+The following npm package may be included in this product:
+
+ - type-fest@5.10.0
+
+This package contains the following license:
+
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.
+
+-----------
+
 The following npm package may be included in this product:
 
  - picocolors@1.1.1
@@ -142,12 +272,11 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 -----------
 
-The following npm packages may be included in this product:
+The following npm package may be included in this product:
 
- - effection@4.0.3
- - simple-git@3.36.0
+ - effection@4.2.0
 
-These packages each contain the following license:
+This package contains the following license:
 
 MIT
 
@@ -155,8 +284,8 @@ MIT
 
 The following npm packages may be included in this product:
 
- - @oclif/core@4.11.14
- - @oclif/plugin-help@6.2.53
+ - @oclif/core@5.1.9
+ - @oclif/plugin-help@7.0.5
 
 These packages each contain the following license:
 
@@ -186,7 +315,7 @@ SOFTWARE.
 
 The following npm package may be included in this product:
 
- - microdiff@1.5.0
+ - microdiff@1.6.0
 
 This package contains the following license:
 
@@ -216,7 +345,7 @@ SOFTWARE.
 
 The following npm package may be included in this product:
 
- - lilconfig@3.1.3
+ - lilconfig@3.1.4
 
 This package contains the following license:
 
@@ -471,7 +600,7 @@ SOFTWARE.
 
 The following npm package may be included in this product:
 
- - picomatch@4.0.5
+ - picomatch@4.0.7
 
 This package contains the following license:
 
@@ -499,5 +628,34 @@ THE SOFTWARE.
 
 -----------
 
+The following npm package may be included in this product:
+
+ - simple-git@4.0.2
+
+This package contains the following license:
+
+The MIT License (MIT)
+
+Copyright (c) 2025 Steve King
+
+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.
+
+-----------
+
 This file was generated with the generate-license-file npm package!
 https://www.npmjs.com/package/generate-license-file

package/esm/adapters/fluidFramework.d.ts

@@ -1,10 +1,10 @@
-import type { PolicyDefinition } from "../policy.js";
+import type { FilePolicyDefinition } from "../policy.js";
 /**
  * A FluidFramework build-tools policy handler interface.
  *
  * This interface matches the `Handler` interface from `@fluidframework/build-tools`.
  *
- * @alpha
+ * @public
  */
 export interface FluidHandler {
     /**
@@ -31,17 +31,21 @@ export interface FluidHandler {
      * @returns An object indicating whether the fix was successful.
      */
     resolver?: (file: string, root: string) => Promise<{
+        /** Whether the violation was fixed. */
         resolved: boolean;
+        /** Optional explanation of the fix result. */
         message?: string;
     }> | {
+        /** Whether the violation was fixed. */
         resolved: boolean;
+        /** Optional explanation of the fix result. */
         message?: string;
     };
 }
 /**
  * Options for converting FluidFramework handlers to repopo policies.
  *
- * @alpha
+ * @public
  */
 export interface FluidAdapterOptions {
     /**
@@ -62,19 +66,19 @@ export interface FluidAdapterOptions {
  * Key differences handled by this adapter:
  *
  * - **Handler signature**: Fluid uses `(file, root) => string | undefined`,
- *   repopo uses `(args) => PolicyHandlerResult`
+ *   repopo uses `(args) => Promise<PolicyResult> | Operation<PolicyResult>`
  *
  * - **File paths**: Fluid passes absolute paths, repopo passes repo-relative paths.
  *   The adapter converts between the two.
  *
  * - **Return types**: Fluid returns `string | undefined` (error message or success),
- *   repopo returns `true | PolicyFailure | PolicyFixResult`
+ *   repopo returns `readonly PolicyFinding[]`
  *
  * For a single handler, wrap it in an array: `fromFluidHandlers([handler])`.
  *
  * @example
  * ```typescript
- * import { fromFluidHandlers, makePolicy } from "repopo";
+ * import { fromFluidHandlers, makePolicy, type RepopoConfig } from "repopo";
  * import { copyrightFileHeaderHandlers, fluidCaseHandler } from "@fluidframework/build-tools";
  *
  * // Convert multiple handlers with a namespace prefix
@@ -87,7 +91,7 @@ export interface FluidAdapterOptions {
  *
  * const config: RepopoConfig = {
  *   policies: [
- *     ...FluidCopyrightPolicies.map(p => makePolicy(p)),
+ *     ...FluidCopyrightPolicies.map((p) => makePolicy(p)),
  *     makePolicy(FluidCasePolicy),
  *   ],
  * };
@@ -97,7 +101,7 @@ export interface FluidAdapterOptions {
  * @param options - Optional configuration applied to all conversions.
  * @returns An array of repopo PolicyDefinitions.
  *
- * @alpha
+ * @public
  */
-export declare function fromFluidHandlers(fluidHandlers: FluidHandler[], options?: FluidAdapterOptions): PolicyDefinition[];
+export declare function fromFluidHandlers(fluidHandlers: FluidHandler[], options?: FluidAdapterOptions): FilePolicyDefinition[];
 //# sourceMappingURL=fluidFramework.d.ts.map

package/esm/adapters/fluidFramework.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fluidFramework.d.ts","sourceRoot":"","sources":["../../src/adapters/fluidFramework.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACX,gBAAgB,EAIhB,MAAM,cAAc,CAAC;AAEtB;;;;;;GAMG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;;OAMG;IACH,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAErE;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,CACV,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,KAEV,OAAO,CAAC;QAAE,QAAQ,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,GAChD;QAAE,QAAQ,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC3C;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IACnC;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AAwFD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,wBAAgB,iBAAiB,CAChC,aAAa,EAAE,YAAY,EAAE,EAC7B,OAAO,CAAC,EAAE,mBAAmB,GAC3B,gBAAgB,EAAE,CAEpB"}
+{"version":3,"file":"fluidFramework.d.ts","sourceRoot":"","sources":["../../src/adapters/fluidFramework.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,oBAAoB,EAAiB,MAAM,cAAc,CAAC;AAExE;;;;;;GAMG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;;OAMG;IACH,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAErE;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,CACV,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,KAEV,OAAO,CAAC;QACR,uCAAuC;QACvC,QAAQ,EAAE,OAAO,CAAC;QAClB,8CAA8C;QAC9C,OAAO,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC,GACF;QACA,uCAAuC;QACvC,QAAQ,EAAE,OAAO,CAAC;QAClB,8CAA8C;QAC9C,OAAO,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;CACL;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IACnC;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AA8DD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,wBAAgB,iBAAiB,CAChC,aAAa,EAAE,YAAY,EAAE,EAC7B,OAAO,CAAC,EAAE,mBAAmB,GAC3B,oBAAoB,EAAE,CAExB"}