polytypo 1.2.0 → 1.3.1

package/dist/{chunk-YYHKX5HE.cjs → chunk-W2T7B2SH.cjs}

@@ -1,11 +1,11 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkB4O4R6HIcjs = require('./chunk-B4O4R6HI.cjs');
+var _chunkV4EOJ44Scjs = require('./chunk-V4EOJ44S.cjs');
 
 // src/engine/assert-fixed-mode.ts
 function assertFixedMode(mode, fixed, entryPoint) {
   if (mode === void 0 || mode === fixed) return;
-  throw new (0, _chunkB4O4R6HIcjs.PolytypoError)(
+  throw new (0, _chunkV4EOJ44Scjs.PolytypoError)(
     "POLYTYPO_INVALID_MODE",
     `"${entryPoint}" only supports mode "${fixed}". Received "${String(mode)}" \u2014 import from "polytypo" for the other modes, or omit \`mode\` here.`
   );
@@ -14,4 +14,4 @@ function assertFixedMode(mode, fixed, entryPoint) {
 
 
 exports.assertFixedMode = assertFixedMode;
-//# sourceMappingURL=chunk-YYHKX5HE.cjs.map
+//# sourceMappingURL=chunk-W2T7B2SH.cjs.map

package/dist/{chunk-YYHKX5HE.cjs.map → chunk-W2T7B2SH.cjs.map}

@@ -1 +1 @@
-{"version":3,"sources":["/home/runner/work/polytypo-js/polytypo-js/dist/chunk-YYHKX5HE.cjs","../src/engine/assert-fixed-mode.ts"],"names":[],"mappings":"AAAA;AACE;AACF,wDAA6B;AAC7B;AACA;ACMO,SAAS,eAAA,CAAgB,IAAA,EAAe,KAAA,EAAa,UAAA,EAA0B;AACpF,EAAA,GAAA,CAAI,KAAA,IAAS,KAAA,EAAA,GAAa,KAAA,IAAS,KAAA,EAAO,MAAA;AAC1C,EAAA,MAAM,IAAI,oCAAA;AAAA,IACR,uBAAA;AAAA,IACA,CAAA,CAAA,EAAI,UAAU,CAAA,sBAAA,EAAyB,KAAK,CAAA,aAAA,EAAgB,MAAA,CAAO,IAAI,CAAC,CAAA,2EAAA;AAAA,EAE1E,CAAA;AACF;ADLA;AACA;AACE;AACF,0CAAC","file":"/home/runner/work/polytypo-js/polytypo-js/dist/chunk-YYHKX5HE.cjs","sourcesContent":[null,"import { PolytypoError } from \"../errors.js\";\nimport type { Mode } from \"../types.js\";\n\n/**\n * `polytypo/text`, `polytypo/html` and `polytypo/markdown` each fix `mode` at the type level by\n * omitting it from their Options type (AUDIT_REMEDIATION_AND_RELEASE_PLAN.md 5.1, criterion 6).\n * A plain-JS caller — or a TypeScript caller passing a wider-typed variable, which excess-property\n * checking does not catch — can still supply a conflicting `mode` at runtime. That is rejected\n * explicitly here, never silently ignored or overridden.\n */\nexport function assertFixedMode(mode: unknown, fixed: Mode, entryPoint: string): void {\n  if (mode === undefined || mode === fixed) return;\n  throw new PolytypoError(\n    \"POLYTYPO_INVALID_MODE\",\n    `\"${entryPoint}\" only supports mode \"${fixed}\". Received \"${String(mode)}\" — ` +\n      `import from \"polytypo\" for the other modes, or omit \\`mode\\` here.`,\n  );\n}\n"]}
+{"version":3,"sources":["/home/runner/work/polytypo-js/polytypo-js/dist/chunk-W2T7B2SH.cjs","../src/engine/assert-fixed-mode.ts"],"names":[],"mappings":"AAAA;AACE;AACF,wDAA6B;AAC7B;AACA;ACMO,SAAS,eAAA,CAAgB,IAAA,EAAe,KAAA,EAAa,UAAA,EAA0B;AACpF,EAAA,GAAA,CAAI,KAAA,IAAS,KAAA,EAAA,GAAa,KAAA,IAAS,KAAA,EAAO,MAAA;AAC1C,EAAA,MAAM,IAAI,oCAAA;AAAA,IACR,uBAAA;AAAA,IACA,CAAA,CAAA,EAAI,UAAU,CAAA,sBAAA,EAAyB,KAAK,CAAA,aAAA,EAAgB,MAAA,CAAO,IAAI,CAAC,CAAA,2EAAA;AAAA,EAE1E,CAAA;AACF;ADLA;AACA;AACE;AACF,0CAAC","file":"/home/runner/work/polytypo-js/polytypo-js/dist/chunk-W2T7B2SH.cjs","sourcesContent":[null,"import { PolytypoError } from \"../errors.js\";\nimport type { Mode } from \"../types.js\";\n\n/**\n * `polytypo/text`, `polytypo/html` and `polytypo/markdown` each fix `mode` at the type level by\n * omitting it from their Options type (AUDIT_REMEDIATION_AND_RELEASE_PLAN.md 5.1, criterion 6).\n * A plain-JS caller — or a TypeScript caller passing a wider-typed variable, which excess-property\n * checking does not catch — can still supply a conflicting `mode` at runtime. That is rejected\n * explicitly here, never silently ignored or overridden.\n */\nexport function assertFixedMode(mode: unknown, fixed: Mode, entryPoint: string): void {\n  if (mode === undefined || mode === fixed) return;\n  throw new PolytypoError(\n    \"POLYTYPO_INVALID_MODE\",\n    `\"${entryPoint}\" only supports mode \"${fixed}\". Received \"${String(mode)}\" — ` +\n      `import from \"polytypo\" for the other modes, or omit \\`mode\\` here.`,\n  );\n}\n"]}

package/dist/{errors-joZChNws.d.ts → errors-CGFOVO3h.d.cts}

@@ -1,4 +1,4 @@
-type Mode = "text" | "html" | "markdown";
+type Mode = "text" | "html" | "markdown" | "yaml";
 /**
  * `markdown` is not one language (spec/rules/modes.md 3.7.1). CommonMark and MDX disagree on
  * ordinary documents, so the caller states which they have — it is the file extension, and the
@@ -11,8 +11,15 @@ interface Options {
     /** Required. An unknown locale throws; there is never a fallback to English. */
     locale: string;
     mode?: Mode;
-    /** Required when `mode` is `"markdown"`, with no default; ignored in `text` and `html`. */
+    /** Required when `mode` is `"markdown"`, with no default; ignored in the other three modes. */
     dialect?: Dialect;
+    /**
+     * Required when `mode` is `"yaml"`, with no default; ignored in the other three modes
+     * (spec/rules/modes.md §3.8.2). The mapping keys whose scalar values are processable — YAML is
+     * a data format with islands of prose in it, so the caller names them and the library never
+     * guesses. An empty list is legal and processes nothing.
+     */
+    keys?: readonly string[];
     /**
      * Per-rule override, keyed by `RuleId`. For a default-on rule (every rule except `ranges`),
      * `false` disables it and `true` is a no-op. For `ranges` — off by default (spec 0.5.0) —
@@ -20,7 +27,15 @@ interface Options {
      * key always means "use that rule's own default", never "off".
      */
     rules?: Partial<Record<RuleId, boolean>>;
+    /**
+     * `"nbsp"` makes the engine emit U+00A0 everywhere it would emit U+202F — the narrow no-break
+     * space many common faces do not carry (nbsp.md §3.1a). Default `"narrow"`. This moves the
+     * rule's target rather than post-processing the output, so the result stays a fixed point.
+     */
+    narrowNbsp?: NarrowNbsp;
 }
+/** nbsp.md §3.1a. `"narrow"` (the default) emits U+202F; `"nbsp"` emits U+00A0 in its place. */
+type NarrowNbsp = "narrow" | "nbsp";
 /** Mirrors spec/schema/locale.schema.json. Literal data only — no patterns, no priorities. */
 interface QuotePair {
     readonly open: string;
@@ -103,6 +118,12 @@ interface RuleContext {
     readonly cp: readonly number[];
     readonly locale: LocaleData;
     readonly mode: Mode;
+    /**
+     * nbsp.md §3.1a's NARROW-TARGET, already resolved to a code point: U+202F by default, U+00A0
+     * when the caller passed `narrowNbsp: "nbsp"`. A rule reads a code point and never the option,
+     * so the string never reaches the pipeline.
+     */
+    readonly narrowTarget: number;
 }
 interface Rule {
     readonly id: RuleId;
@@ -110,11 +131,20 @@ interface Rule {
     apply(ctx: RuleContext): Edit[];
 }
 
-type PolytypoErrorCode = "POLYTYPO_UNKNOWN_LOCALE" | "POLYTYPO_INVALID_MODE" | "POLYTYPO_INVALID_DIALECT" | "POLYTYPO_UNKNOWN_RULE" | "POLYTYPO_MALFORMED_LOCALE_DATA" | "POLYTYPO_RULE_CONTRACT" | "POLYTYPO_MALFORMED_INPUT";
+/** One entry of `analyze`'s result, in input coordinates (analyze.md §2). */
+interface Change {
+    readonly ruleId: RuleId;
+    readonly start: number;
+    readonly end: number;
+    readonly before: string;
+    readonly after: string;
+}
+
+type PolytypoErrorCode = "POLYTYPO_UNKNOWN_LOCALE" | "POLYTYPO_INVALID_MODE" | "POLYTYPO_INVALID_DIALECT" | "POLYTYPO_UNKNOWN_RULE" | "POLYTYPO_MALFORMED_LOCALE_DATA" | "POLYTYPO_RULE_CONTRACT" | "POLYTYPO_MALFORMED_INPUT" | "POLYTYPO_INVALID_OPTION";
 /** Codes are the contract across all five runtimes; messages are English and are not (ARCHITECTURE.md 4.6). */
 declare class PolytypoError extends Error {
     readonly code: PolytypoErrorCode;
     constructor(code: PolytypoErrorCode, message: string);
 }
 
-export { type Dialect as D, type Edit as E, type LocaleData as L, type Mode as M, type Options as O, PolytypoError as P, type QuotePair as Q, type Rule as R, type LocaleSource as a, type PolytypoErrorCode as b, type RuleContext as c, type RuleId as d };
+export { type Change as C, type Dialect as D, type Edit as E, type LocaleData as L, type Mode as M, type NarrowNbsp as N, type Options as O, PolytypoError as P, type QuotePair as Q, type Rule as R, type LocaleSource as a, type PolytypoErrorCode as b, type RuleContext as c, type RuleId as d };

package/dist/{errors-joZChNws.d.cts → errors-CGFOVO3h.d.ts}

@@ -1,4 +1,4 @@
-type Mode = "text" | "html" | "markdown";
+type Mode = "text" | "html" | "markdown" | "yaml";
 /**
  * `markdown` is not one language (spec/rules/modes.md 3.7.1). CommonMark and MDX disagree on
  * ordinary documents, so the caller states which they have — it is the file extension, and the
@@ -11,8 +11,15 @@ interface Options {
     /** Required. An unknown locale throws; there is never a fallback to English. */
     locale: string;
     mode?: Mode;
-    /** Required when `mode` is `"markdown"`, with no default; ignored in `text` and `html`. */
+    /** Required when `mode` is `"markdown"`, with no default; ignored in the other three modes. */
     dialect?: Dialect;
+    /**
+     * Required when `mode` is `"yaml"`, with no default; ignored in the other three modes
+     * (spec/rules/modes.md §3.8.2). The mapping keys whose scalar values are processable — YAML is
+     * a data format with islands of prose in it, so the caller names them and the library never
+     * guesses. An empty list is legal and processes nothing.
+     */
+    keys?: readonly string[];
     /**
      * Per-rule override, keyed by `RuleId`. For a default-on rule (every rule except `ranges`),
      * `false` disables it and `true` is a no-op. For `ranges` — off by default (spec 0.5.0) —
@@ -20,7 +27,15 @@ interface Options {
      * key always means "use that rule's own default", never "off".
      */
     rules?: Partial<Record<RuleId, boolean>>;
+    /**
+     * `"nbsp"` makes the engine emit U+00A0 everywhere it would emit U+202F — the narrow no-break
+     * space many common faces do not carry (nbsp.md §3.1a). Default `"narrow"`. This moves the
+     * rule's target rather than post-processing the output, so the result stays a fixed point.
+     */
+    narrowNbsp?: NarrowNbsp;
 }
+/** nbsp.md §3.1a. `"narrow"` (the default) emits U+202F; `"nbsp"` emits U+00A0 in its place. */
+type NarrowNbsp = "narrow" | "nbsp";
 /** Mirrors spec/schema/locale.schema.json. Literal data only — no patterns, no priorities. */
 interface QuotePair {
     readonly open: string;
@@ -103,6 +118,12 @@ interface RuleContext {
     readonly cp: readonly number[];
     readonly locale: LocaleData;
     readonly mode: Mode;
+    /**
+     * nbsp.md §3.1a's NARROW-TARGET, already resolved to a code point: U+202F by default, U+00A0
+     * when the caller passed `narrowNbsp: "nbsp"`. A rule reads a code point and never the option,
+     * so the string never reaches the pipeline.
+     */
+    readonly narrowTarget: number;
 }
 interface Rule {
     readonly id: RuleId;
@@ -110,11 +131,20 @@ interface Rule {
     apply(ctx: RuleContext): Edit[];
 }
 
-type PolytypoErrorCode = "POLYTYPO_UNKNOWN_LOCALE" | "POLYTYPO_INVALID_MODE" | "POLYTYPO_INVALID_DIALECT" | "POLYTYPO_UNKNOWN_RULE" | "POLYTYPO_MALFORMED_LOCALE_DATA" | "POLYTYPO_RULE_CONTRACT" | "POLYTYPO_MALFORMED_INPUT";
+/** One entry of `analyze`'s result, in input coordinates (analyze.md §2). */
+interface Change {
+    readonly ruleId: RuleId;
+    readonly start: number;
+    readonly end: number;
+    readonly before: string;
+    readonly after: string;
+}
+
+type PolytypoErrorCode = "POLYTYPO_UNKNOWN_LOCALE" | "POLYTYPO_INVALID_MODE" | "POLYTYPO_INVALID_DIALECT" | "POLYTYPO_UNKNOWN_RULE" | "POLYTYPO_MALFORMED_LOCALE_DATA" | "POLYTYPO_RULE_CONTRACT" | "POLYTYPO_MALFORMED_INPUT" | "POLYTYPO_INVALID_OPTION";
 /** Codes are the contract across all five runtimes; messages are English and are not (ARCHITECTURE.md 4.6). */
 declare class PolytypoError extends Error {
     readonly code: PolytypoErrorCode;
     constructor(code: PolytypoErrorCode, message: string);
 }
 
-export { type Dialect as D, type Edit as E, type LocaleData as L, type Mode as M, type Options as O, PolytypoError as P, type QuotePair as Q, type Rule as R, type LocaleSource as a, type PolytypoErrorCode as b, type RuleContext as c, type RuleId as d };
+export { type Change as C, type Dialect as D, type Edit as E, type LocaleData as L, type Mode as M, type NarrowNbsp as N, type Options as O, PolytypoError as P, type QuotePair as Q, type Rule as R, type LocaleSource as a, type PolytypoErrorCode as b, type RuleContext as c, type RuleId as d };

package/dist/html.cjs

@@ -1,22 +1,30 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }
 
-var _chunkHGUA2NVXcjs = require('./chunk-HGUA2NVX.cjs');
-require('./chunk-LS57O4KJ.cjs');
 
+var _chunkFK3F3YZTcjs = require('./chunk-FK3F3YZT.cjs');
+require('./chunk-THTCAO3O.cjs');
+require('./chunk-ECYUONLP.cjs');
 
-var _chunkYYHKX5HEcjs = require('./chunk-YYHKX5HE.cjs');
 
+var _chunkW2T7B2SHcjs = require('./chunk-W2T7B2SH.cjs');
 
-var _chunkB4O4R6HIcjs = require('./chunk-B4O4R6HI.cjs');
+
+var _chunkV4EOJ44Scjs = require('./chunk-V4EOJ44S.cjs');
 
 // src/index.html.ts
 function transform(input, options) {
   const given = _nullishCoalesce(options, () => ( {}));
-  _chunkYYHKX5HEcjs.assertFixedMode.call(void 0, given.mode, "html", "polytypo/html");
-  return _chunkHGUA2NVXcjs.runHtmlPipeline.call(void 0, input, given);
+  _chunkW2T7B2SHcjs.assertFixedMode.call(void 0, given.mode, "html", "polytypo/html");
+  return _chunkFK3F3YZTcjs.runHtmlPipeline.call(void 0, input, given);
+}
+function analyze(input, options) {
+  const given = _nullishCoalesce(options, () => ( {}));
+  _chunkW2T7B2SHcjs.assertFixedMode.call(void 0, given.mode, "html", "polytypo/html");
+  return _chunkFK3F3YZTcjs.analyzeHtmlPipeline.call(void 0, input, given);
 }
 
 
 
-exports.PolytypoError = _chunkB4O4R6HIcjs.PolytypoError; exports.transform = transform;
+
+exports.PolytypoError = _chunkV4EOJ44Scjs.PolytypoError; exports.analyze = analyze; exports.transform = transform;
 //# sourceMappingURL=html.cjs.map

package/dist/html.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["/home/runner/work/polytypo-js/polytypo-js/dist/html.cjs","../src/index.html.ts"],"names":[],"mappings":"AAAA;AACE;AACF,wDAA6B;AAC7B,gCAA6B;AAC7B;AACE;AACF,wDAA6B;AAC7B;AACE;AACF,wDAA6B;AAC7B;AACA;ACIO,SAAS,SAAA,CAAU,KAAA,EAAe,OAAA,EAA8B;AACrE,EAAA,MAAM,MAAA,mBAAS,OAAA,UAAW,CAAC,GAAA;AAC3B,EAAA,+CAAA,KAAgB,CAAM,IAAA,EAAM,MAAA,EAAQ,eAAe,CAAA;AACnD,EAAA,OAAO,+CAAA,KAAgB,EAAO,KAAK,CAAA;AACrC;ADFA;AACE;AACA;AACF,uFAAC","file":"/home/runner/work/polytypo-js/polytypo-js/dist/html.cjs","sourcesContent":[null,"import { assertFixedMode } from \"./engine/assert-fixed-mode.js\";\nimport { runHtmlPipeline } from \"./engine/html-pipeline.js\";\nimport type { Options } from \"./types.js\";\n\n/**\n * `polytypo/html` — HTML-only entry point. Its module graph includes `parse5` but excludes the\n * Micromark/MDX stack (AUDIT_REMEDIATION_AND_RELEASE_PLAN.md 5.1): it imports\n * `./engine/html-pipeline.js` directly and never `./engine/pipeline.js` or `./modes/markdown.js`.\n *\n * `mode` is absent from `HtmlOptions`, since this entry only ever runs `html` mode. `dialect` is\n * likewise absent — it has no effect in `html` mode even in the aggregate entry (types.ts), so\n * there is nothing for it to conflict with here.\n */\nexport type HtmlOptions = Omit<Options, \"mode\" | \"dialect\">;\n\nexport function transform(input: string, options: HtmlOptions): string {\n  const given = (options ?? {}) as Partial<Options>;\n  assertFixedMode(given.mode, \"html\", \"polytypo/html\");\n  return runHtmlPipeline(input, given);\n}\n\nexport { PolytypoError } from \"./errors.js\";\nexport type { PolytypoErrorCode } from \"./errors.js\";\nexport type { LocaleData, LocaleSource, QuotePair, Rule, RuleContext, RuleId } from \"./types.js\";\n"]}
+{"version":3,"sources":["/home/runner/work/polytypo-js/polytypo-js/dist/html.cjs","../src/index.html.ts"],"names":[],"mappings":"AAAA;AACE;AACA;AACF,wDAA6B;AAC7B,gCAA6B;AAC7B,gCAA6B;AAC7B;AACE;AACF,wDAA6B;AAC7B;AACE;AACF,wDAA6B;AAC7B;AACA;ACGO,SAAS,SAAA,CAAU,KAAA,EAAe,OAAA,EAA8B;AACrE,EAAA,MAAM,MAAA,mBAAS,OAAA,UAAW,CAAC,GAAA;AAC3B,EAAA,+CAAA,KAAgB,CAAM,IAAA,EAAM,MAAA,EAAQ,eAAe,CAAA;AACnD,EAAA,OAAO,+CAAA,KAAgB,EAAO,KAAK,CAAA;AACrC;AAOO,SAAS,OAAA,CAAQ,KAAA,EAAe,OAAA,EAAgC;AACrE,EAAA,MAAM,MAAA,mBAAS,OAAA,UAAW,CAAC,GAAA;AAC3B,EAAA,+CAAA,KAAgB,CAAM,IAAA,EAAM,MAAA,EAAQ,eAAe,CAAA;AACnD,EAAA,OAAO,mDAAA,KAAoB,EAAO,KAAK,CAAA;AACzC;ADPA;AACE;AACA;AACA;AACF,kHAAC","file":"/home/runner/work/polytypo-js/polytypo-js/dist/html.cjs","sourcesContent":[null,"import { assertFixedMode } from \"./engine/assert-fixed-mode.js\";\nimport { analyzeHtmlPipeline, runHtmlPipeline } from \"./engine/html-pipeline.js\";\nimport type { Change } from \"./engine/origin.js\";\nimport type { Options } from \"./types.js\";\n\n/**\n * `polytypo/html` — HTML-only entry point. Its module graph includes `parse5` but excludes the\n * Micromark/MDX stack (AUDIT_REMEDIATION_AND_RELEASE_PLAN.md 5.1): it imports\n * `./engine/html-pipeline.js` directly and never `./engine/pipeline.js` or `./modes/markdown.js`.\n *\n * `mode` is absent from `HtmlOptions`, since this entry only ever runs `html` mode. `dialect` is\n * likewise absent — it has no effect in `html` mode even in the aggregate entry (types.ts), so\n * there is nothing for it to conflict with here.\n */\nexport type HtmlOptions = Omit<Options, \"mode\" | \"dialect\">;\n\nexport function transform(input: string, options: HtmlOptions): string {\n  const given = (options ?? {}) as Partial<Options>;\n  assertFixedMode(given.mode, \"html\", \"polytypo/html\");\n  return runHtmlPipeline(input, given);\n}\n\n/**\n * The same pipeline as this entry's `transform`, reporting instead of applying\n * (spec/rules/analyze.md). Offsets are code-point offsets into `input` — into the document,\n * not into a span (analyze.md §6).\n */\nexport function analyze(input: string, options: HtmlOptions): Change[] {\n  const given = (options ?? {}) as Partial<Options>;\n  assertFixedMode(given.mode, \"html\", \"polytypo/html\");\n  return analyzeHtmlPipeline(input, given);\n}\n\nexport { PolytypoError } from \"./errors.js\";\nexport type { PolytypoErrorCode } from \"./errors.js\";\nexport type { Change } from \"./engine/origin.js\";\nexport type { NarrowNbsp } from \"./types.js\";\nexport type { LocaleData, LocaleSource, QuotePair, Rule, RuleContext, RuleId } from \"./types.js\";\n"]}

package/dist/html.d.cts

@@ -1,5 +1,5 @@
-import { O as Options } from './errors-joZChNws.cjs';
-export { L as LocaleData, a as LocaleSource, P as PolytypoError, b as PolytypoErrorCode, Q as QuotePair, R as Rule, c as RuleContext, d as RuleId } from './errors-joZChNws.cjs';
+import { O as Options, C as Change } from './errors-CGFOVO3h.cjs';
+export { L as LocaleData, a as LocaleSource, N as NarrowNbsp, P as PolytypoError, b as PolytypoErrorCode, Q as QuotePair, R as Rule, c as RuleContext, d as RuleId } from './errors-CGFOVO3h.cjs';
 
 /**
  * `polytypo/html` — HTML-only entry point. Its module graph includes `parse5` but excludes the
@@ -12,5 +12,11 @@ export { L as LocaleData, a as LocaleSource, P as PolytypoError, b as PolytypoEr
  */
 type HtmlOptions = Omit<Options, "mode" | "dialect">;
 declare function transform(input: string, options: HtmlOptions): string;
+/**
+ * The same pipeline as this entry's `transform`, reporting instead of applying
+ * (spec/rules/analyze.md). Offsets are code-point offsets into `input` — into the document,
+ * not into a span (analyze.md §6).
+ */
+declare function analyze(input: string, options: HtmlOptions): Change[];
 
-export { type HtmlOptions, transform };
+export { Change, type HtmlOptions, analyze, transform };

package/dist/html.d.ts

@@ -1,5 +1,5 @@
-import { O as Options } from './errors-joZChNws.js';
-export { L as LocaleData, a as LocaleSource, P as PolytypoError, b as PolytypoErrorCode, Q as QuotePair, R as Rule, c as RuleContext, d as RuleId } from './errors-joZChNws.js';
+import { O as Options, C as Change } from './errors-CGFOVO3h.js';
+export { L as LocaleData, a as LocaleSource, N as NarrowNbsp, P as PolytypoError, b as PolytypoErrorCode, Q as QuotePair, R as Rule, c as RuleContext, d as RuleId } from './errors-CGFOVO3h.js';
 
 /**
  * `polytypo/html` — HTML-only entry point. Its module graph includes `parse5` but excludes the
@@ -12,5 +12,11 @@ export { L as LocaleData, a as LocaleSource, P as PolytypoError, b as PolytypoEr
  */
 type HtmlOptions = Omit<Options, "mode" | "dialect">;
 declare function transform(input: string, options: HtmlOptions): string;
+/**
+ * The same pipeline as this entry's `transform`, reporting instead of applying
+ * (spec/rules/analyze.md). Offsets are code-point offsets into `input` — into the document,
+ * not into a span (analyze.md §6).
+ */
+declare function analyze(input: string, options: HtmlOptions): Change[];
 
-export { type HtmlOptions, transform };
+export { Change, type HtmlOptions, analyze, transform };

package/dist/html.js

@@ -1,13 +1,15 @@
 import {
+  analyzeHtmlPipeline,
   runHtmlPipeline
-} from "./chunk-44A6YP7S.js";
-import "./chunk-VARU43JT.js";
+} from "./chunk-VC5XLP6O.js";
+import "./chunk-DXWMSR26.js";
+import "./chunk-5U3DRTV7.js";
 import {
   assertFixedMode
-} from "./chunk-KAO74OJ6.js";
+} from "./chunk-4GYU4TXA.js";
 import {
   PolytypoError
-} from "./chunk-OHF7OFWY.js";
+} from "./chunk-VKJVMMCI.js";
 
 // src/index.html.ts
 function transform(input, options) {
@@ -15,8 +17,14 @@ function transform(input, options) {
   assertFixedMode(given.mode, "html", "polytypo/html");
   return runHtmlPipeline(input, given);
 }
+function analyze(input, options) {
+  const given = options ?? {};
+  assertFixedMode(given.mode, "html", "polytypo/html");
+  return analyzeHtmlPipeline(input, given);
+}
 export {
   PolytypoError,
+  analyze,
   transform
 };
 //# sourceMappingURL=html.js.map

package/dist/html.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.html.ts"],"sourcesContent":["import { assertFixedMode } from \"./engine/assert-fixed-mode.js\";\nimport { runHtmlPipeline } from \"./engine/html-pipeline.js\";\nimport type { Options } from \"./types.js\";\n\n/**\n * `polytypo/html` — HTML-only entry point. Its module graph includes `parse5` but excludes the\n * Micromark/MDX stack (AUDIT_REMEDIATION_AND_RELEASE_PLAN.md 5.1): it imports\n * `./engine/html-pipeline.js` directly and never `./engine/pipeline.js` or `./modes/markdown.js`.\n *\n * `mode` is absent from `HtmlOptions`, since this entry only ever runs `html` mode. `dialect` is\n * likewise absent — it has no effect in `html` mode even in the aggregate entry (types.ts), so\n * there is nothing for it to conflict with here.\n */\nexport type HtmlOptions = Omit<Options, \"mode\" | \"dialect\">;\n\nexport function transform(input: string, options: HtmlOptions): string {\n  const given = (options ?? {}) as Partial<Options>;\n  assertFixedMode(given.mode, \"html\", \"polytypo/html\");\n  return runHtmlPipeline(input, given);\n}\n\nexport { PolytypoError } from \"./errors.js\";\nexport type { PolytypoErrorCode } from \"./errors.js\";\nexport type { LocaleData, LocaleSource, QuotePair, Rule, RuleContext, RuleId } from \"./types.js\";\n"],"mappings":";;;;;;;;;;;;AAeO,SAAS,UAAU,OAAe,SAA8B;AACrE,QAAM,QAAS,WAAW,CAAC;AAC3B,kBAAgB,MAAM,MAAM,QAAQ,eAAe;AACnD,SAAO,gBAAgB,OAAO,KAAK;AACrC;","names":[]}
+{"version":3,"sources":["../src/index.html.ts"],"sourcesContent":["import { assertFixedMode } from \"./engine/assert-fixed-mode.js\";\nimport { analyzeHtmlPipeline, runHtmlPipeline } from \"./engine/html-pipeline.js\";\nimport type { Change } from \"./engine/origin.js\";\nimport type { Options } from \"./types.js\";\n\n/**\n * `polytypo/html` — HTML-only entry point. Its module graph includes `parse5` but excludes the\n * Micromark/MDX stack (AUDIT_REMEDIATION_AND_RELEASE_PLAN.md 5.1): it imports\n * `./engine/html-pipeline.js` directly and never `./engine/pipeline.js` or `./modes/markdown.js`.\n *\n * `mode` is absent from `HtmlOptions`, since this entry only ever runs `html` mode. `dialect` is\n * likewise absent — it has no effect in `html` mode even in the aggregate entry (types.ts), so\n * there is nothing for it to conflict with here.\n */\nexport type HtmlOptions = Omit<Options, \"mode\" | \"dialect\">;\n\nexport function transform(input: string, options: HtmlOptions): string {\n  const given = (options ?? {}) as Partial<Options>;\n  assertFixedMode(given.mode, \"html\", \"polytypo/html\");\n  return runHtmlPipeline(input, given);\n}\n\n/**\n * The same pipeline as this entry's `transform`, reporting instead of applying\n * (spec/rules/analyze.md). Offsets are code-point offsets into `input` — into the document,\n * not into a span (analyze.md §6).\n */\nexport function analyze(input: string, options: HtmlOptions): Change[] {\n  const given = (options ?? {}) as Partial<Options>;\n  assertFixedMode(given.mode, \"html\", \"polytypo/html\");\n  return analyzeHtmlPipeline(input, given);\n}\n\nexport { PolytypoError } from \"./errors.js\";\nexport type { PolytypoErrorCode } from \"./errors.js\";\nexport type { Change } from \"./engine/origin.js\";\nexport type { NarrowNbsp } from \"./types.js\";\nexport type { LocaleData, LocaleSource, QuotePair, Rule, RuleContext, RuleId } from \"./types.js\";\n"],"mappings":";;;;;;;;;;;;;;AAgBO,SAAS,UAAU,OAAe,SAA8B;AACrE,QAAM,QAAS,WAAW,CAAC;AAC3B,kBAAgB,MAAM,MAAM,QAAQ,eAAe;AACnD,SAAO,gBAAgB,OAAO,KAAK;AACrC;AAOO,SAAS,QAAQ,OAAe,SAAgC;AACrE,QAAM,QAAS,WAAW,CAAC;AAC3B,kBAAgB,MAAM,MAAM,QAAQ,eAAe;AACnD,SAAO,oBAAoB,OAAO,KAAK;AACzC;","names":[]}

package/dist/index.cjs

@@ -1,40 +1,61 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }
 
-var _chunk5VBDCDS6cjs = require('./chunk-5VBDCDS6.cjs');
 
+var _chunkQNSBCZU5cjs = require('./chunk-QNSBCZU5.cjs');
 
-var _chunkHGUA2NVXcjs = require('./chunk-HGUA2NVX.cjs');
 
 
-var _chunkPOGDWVG5cjs = require('./chunk-POGDWVG5.cjs');
-require('./chunk-LS57O4KJ.cjs');
+var _chunkFK3F3YZTcjs = require('./chunk-FK3F3YZT.cjs');
 
 
-var _chunkB4O4R6HIcjs = require('./chunk-B4O4R6HI.cjs');
+
+var _chunkAR6FDQAXcjs = require('./chunk-AR6FDQAX.cjs');
+require('./chunk-THTCAO3O.cjs');
+
+
+
+var _chunk5VNPHCL2cjs = require('./chunk-5VNPHCL2.cjs');
+require('./chunk-ECYUONLP.cjs');
+
+
+var _chunkV4EOJ44Scjs = require('./chunk-V4EOJ44S.cjs');
 
 // src/engine/pipeline.ts
 function resolveMode(mode) {
   if (mode === void 0 || mode === "text") return "text";
-  if (mode === "html" || mode === "markdown") return mode;
-  throw new (0, _chunkB4O4R6HIcjs.PolytypoError)(
+  if (mode === "html" || mode === "markdown" || mode === "yaml") return mode;
+  throw new (0, _chunkV4EOJ44Scjs.PolytypoError)(
     "POLYTYPO_INVALID_MODE",
-    `Unknown mode "${String(mode)}". Expected "text", "html" or "markdown".`
+    `Unknown mode "${String(mode)}". Expected "text", "html", "markdown" or "yaml".`
   );
 }
 function runPipeline(input, options) {
   const given = _nullishCoalesce(options, () => ( {}));
   const mode = resolveMode(given.mode);
-  if (mode === "text") return _chunk5VBDCDS6cjs.runTextPipeline.call(void 0, input, given);
-  if (mode === "html") return _chunkHGUA2NVXcjs.runHtmlPipeline.call(void 0, input, given);
-  return _chunkPOGDWVG5cjs.runMarkdownPipeline.call(void 0, input, given);
+  if (mode === "text") return _chunkQNSBCZU5cjs.runTextPipeline.call(void 0, input, given);
+  if (mode === "html") return _chunkFK3F3YZTcjs.runHtmlPipeline.call(void 0, input, given);
+  if (mode === "yaml") return _chunk5VNPHCL2cjs.runYamlPipeline.call(void 0, input, given);
+  return _chunkAR6FDQAXcjs.runMarkdownPipeline.call(void 0, input, given);
+}
+function runAnalyze(input, options) {
+  const given = _nullishCoalesce(options, () => ( {}));
+  const mode = resolveMode(given.mode);
+  if (mode === "text") return _chunkQNSBCZU5cjs.analyzeTextPipeline.call(void 0, input, given);
+  if (mode === "html") return _chunkFK3F3YZTcjs.analyzeHtmlPipeline.call(void 0, input, given);
+  if (mode === "yaml") return _chunk5VNPHCL2cjs.analyzeYamlPipeline.call(void 0, input, given);
+  return _chunkAR6FDQAXcjs.analyzeMarkdownPipeline.call(void 0, input, given);
 }
 
 // src/index.ts
 function transform(input, options) {
   return runPipeline(input, options);
 }
+function analyze(input, options) {
+  return runAnalyze(input, options);
+}
+
 
 
 
-exports.PolytypoError = _chunkB4O4R6HIcjs.PolytypoError; exports.transform = transform;
+exports.PolytypoError = _chunkV4EOJ44Scjs.PolytypoError; exports.analyze = analyze; exports.transform = transform;
 //# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["/home/runner/work/polytypo-js/polytypo-js/dist/index.cjs","../src/engine/pipeline.ts","../src/index.ts"],"names":[],"mappings":"AAAA;AACE;AACF,wDAA6B;AAC7B;AACE;AACF,wDAA6B;AAC7B;AACE;AACF,wDAA6B;AAC7B,gCAA6B;AAC7B;AACE;AACF,wDAA6B;AAC7B;AACA;ACNA,SAAS,WAAA,CAAY,IAAA,EAA8B;AACjD,EAAA,GAAA,CAAI,KAAA,IAAS,KAAA,EAAA,GAAa,KAAA,IAAS,MAAA,EAAQ,OAAO,MAAA;AAClD,EAAA,GAAA,CAAI,KAAA,IAAS,OAAA,GAAU,KAAA,IAAS,UAAA,EAAY,OAAO,IAAA;AACnD,EAAA,MAAM,IAAI,oCAAA;AAAA,IACR,uBAAA;AAAA,IACA,CAAA,cAAA,EAAiB,MAAA,CAAO,IAAI,CAAC,CAAA,yCAAA;AAAA,EAC/B,CAAA;AACF;AASO,SAAS,WAAA,CAAY,KAAA,EAAe,OAAA,EAA0B;AAInE,EAAA,MAAM,MAAA,mBAA0B,OAAA,UAAW,CAAC,GAAA;AAC5C,EAAA,MAAM,KAAA,EAAO,WAAA,CAAY,KAAA,CAAM,IAAI,CAAA;AACnC,EAAA,GAAA,CAAI,KAAA,IAAS,MAAA,EAAQ,OAAO,+CAAA,KAAgB,EAAO,KAAK,CAAA;AACxD,EAAA,GAAA,CAAI,KAAA,IAAS,MAAA,EAAQ,OAAO,+CAAA,KAAgB,EAAO,KAAK,CAAA;AACxD,EAAA,OAAO,mDAAA,KAAoB,EAAO,KAAK,CAAA;AACzC;ADHA;AACA;AE5BO,SAAS,SAAA,CAAU,KAAA,EAAe,OAAA,EAA0B;AACjE,EAAA,OAAO,WAAA,CAAY,KAAA,EAAO,OAAO,CAAA;AACnC;AF8BA;AACE;AACA;AACF,uFAAC","file":"/home/runner/work/polytypo-js/polytypo-js/dist/index.cjs","sourcesContent":[null,"import { PolytypoError } from \"../errors.js\";\nimport type { Mode, Options } from \"../types.js\";\nimport { runHtmlPipeline } from \"./html-pipeline.js\";\nimport { runMarkdownPipeline } from \"./markdown-pipeline.js\";\nimport { runTextPipeline } from \"./text-pipeline.js\";\n\nexport { planRules } from \"./rule-runner.js\";\n\nfunction resolveMode(mode: Mode | undefined): Mode {\n  if (mode === undefined || mode === \"text\") return \"text\";\n  if (mode === \"html\" || mode === \"markdown\") return mode;\n  throw new PolytypoError(\n    \"POLYTYPO_INVALID_MODE\",\n    `Unknown mode \"${String(mode)}\". Expected \"text\", \"html\" or \"markdown\".`,\n  );\n}\n\n/**\n * The aggregate entry's dispatcher: every mode is reachable, so it is the only pipeline module\n * that imports all three mode-specific ones (and therefore the only one whose module graph\n * includes both `parse5` and the Micromark/MDX stack). `polytypo/text`, `polytypo/html` and\n * `polytypo/markdown` each call their own mode-specific pipeline directly and never import this\n * module (AUDIT_REMEDIATION_AND_RELEASE_PLAN.md 5.1).\n */\nexport function runPipeline(input: string, options: Options): string {\n  // A plain-JS caller can omit the options object entirely. Reading through a null here would\n  // raise a native TypeError, which is outside the error taxonomy; an absent `locale` is an\n  // unknown locale and must say so with a code (locale-resolution.md 3.1).\n  const given: Partial<Options> = options ?? {};\n  const mode = resolveMode(given.mode);\n  if (mode === \"text\") return runTextPipeline(input, given);\n  if (mode === \"html\") return runHtmlPipeline(input, given);\n  return runMarkdownPipeline(input, given);\n}\n","import { runPipeline } from \"./engine/pipeline.js\";\nimport type { Options } from \"./types.js\";\n\nexport function transform(input: string, options: Options): string {\n  return runPipeline(input, options);\n}\n\nexport { PolytypoError } from \"./errors.js\";\nexport type { PolytypoErrorCode } from \"./errors.js\";\nexport type {\n  Dialect,\n  Edit,\n  LocaleData,\n  LocaleSource,\n  Mode,\n  Options,\n  QuotePair,\n  Rule,\n  RuleContext,\n  RuleId,\n} from \"./types.js\";\n"]}
+{"version":3,"sources":["/home/runner/work/polytypo-js/polytypo-js/dist/index.cjs","../src/engine/pipeline.ts","../src/index.ts"],"names":[],"mappings":"AAAA;AACE;AACA;AACF,wDAA6B;AAC7B;AACE;AACA;AACF,wDAA6B;AAC7B;AACE;AACA;AACF,wDAA6B;AAC7B,gCAA6B;AAC7B;AACE;AACA;AACF,wDAA6B;AAC7B,gCAA6B;AAC7B;AACE;AACF,wDAA6B;AAC7B;AACA;ACZA,SAAS,WAAA,CAAY,IAAA,EAA8B;AACjD,EAAA,GAAA,CAAI,KAAA,IAAS,KAAA,EAAA,GAAa,KAAA,IAAS,MAAA,EAAQ,OAAO,MAAA;AAClD,EAAA,GAAA,CAAI,KAAA,IAAS,OAAA,GAAU,KAAA,IAAS,WAAA,GAAc,KAAA,IAAS,MAAA,EAAQ,OAAO,IAAA;AACtE,EAAA,MAAM,IAAI,oCAAA;AAAA,IACR,uBAAA;AAAA,IACA,CAAA,cAAA,EAAiB,MAAA,CAAO,IAAI,CAAC,CAAA,iDAAA;AAAA,EAC/B,CAAA;AACF;AASO,SAAS,WAAA,CAAY,KAAA,EAAe,OAAA,EAA0B;AAInE,EAAA,MAAM,MAAA,mBAA0B,OAAA,UAAW,CAAC,GAAA;AAC5C,EAAA,MAAM,KAAA,EAAO,WAAA,CAAY,KAAA,CAAM,IAAI,CAAA;AACnC,EAAA,GAAA,CAAI,KAAA,IAAS,MAAA,EAAQ,OAAO,+CAAA,KAAgB,EAAO,KAAK,CAAA;AACxD,EAAA,GAAA,CAAI,KAAA,IAAS,MAAA,EAAQ,OAAO,+CAAA,KAAgB,EAAO,KAAK,CAAA;AACxD,EAAA,GAAA,CAAI,KAAA,IAAS,MAAA,EAAQ,OAAO,+CAAA,KAAgB,EAAO,KAAK,CAAA;AACxD,EAAA,OAAO,mDAAA,KAAoB,EAAO,KAAK,CAAA;AACzC;AAOO,SAAS,UAAA,CAAW,KAAA,EAAe,OAAA,EAA4B;AACpE,EAAA,MAAM,MAAA,mBAA0B,OAAA,UAAW,CAAC,GAAA;AAC5C,EAAA,MAAM,KAAA,EAAO,WAAA,CAAY,KAAA,CAAM,IAAI,CAAA;AACnC,EAAA,GAAA,CAAI,KAAA,IAAS,MAAA,EAAQ,OAAO,mDAAA,KAAoB,EAAO,KAAK,CAAA;AAC5D,EAAA,GAAA,CAAI,KAAA,IAAS,MAAA,EAAQ,OAAO,mDAAA,KAAoB,EAAO,KAAK,CAAA;AAC5D,EAAA,GAAA,CAAI,KAAA,IAAS,MAAA,EAAQ,OAAO,mDAAA,KAAoB,EAAO,KAAK,CAAA;AAC5D,EAAA,OAAO,uDAAA,KAAwB,EAAO,KAAK,CAAA;AAC7C;ADHA;AACA;AE5CO,SAAS,SAAA,CAAU,KAAA,EAAe,OAAA,EAA0B;AACjE,EAAA,OAAO,WAAA,CAAY,KAAA,EAAO,OAAO,CAAA;AACnC;AAYO,SAAS,OAAA,CAAQ,KAAA,EAAe,OAAA,EAA4B;AACjE,EAAA,OAAO,UAAA,CAAW,KAAA,EAAO,OAAO,CAAA;AAClC;AFmCA;AACE;AACA;AACA;AACF,kHAAC","file":"/home/runner/work/polytypo-js/polytypo-js/dist/index.cjs","sourcesContent":[null,"import { PolytypoError } from \"../errors.js\";\nimport type { Mode, Options } from \"../types.js\";\nimport { analyzeHtmlPipeline, runHtmlPipeline } from \"./html-pipeline.js\";\nimport { analyzeMarkdownPipeline, runMarkdownPipeline } from \"./markdown-pipeline.js\";\nimport { analyzeTextPipeline, runTextPipeline } from \"./text-pipeline.js\";\nimport { analyzeYamlPipeline, runYamlPipeline } from \"./yaml-pipeline.js\";\nimport type { Change } from \"./origin.js\";\n\nexport { planRules } from \"./rule-runner.js\";\n\nfunction resolveMode(mode: Mode | undefined): Mode {\n  if (mode === undefined || mode === \"text\") return \"text\";\n  if (mode === \"html\" || mode === \"markdown\" || mode === \"yaml\") return mode;\n  throw new PolytypoError(\n    \"POLYTYPO_INVALID_MODE\",\n    `Unknown mode \"${String(mode)}\". Expected \"text\", \"html\", \"markdown\" or \"yaml\".`,\n  );\n}\n\n/**\n * The aggregate entry's dispatcher: every mode is reachable, so it is the only pipeline module\n * that imports all four mode-specific ones (and therefore the only one whose module graph\n * includes both `parse5` and the Micromark/MDX stack). `polytypo/text`, `polytypo/html` and\n * `polytypo/markdown` each call their own mode-specific pipeline directly and never import this\n * module (AUDIT_REMEDIATION_AND_RELEASE_PLAN.md 5.1).\n */\nexport function runPipeline(input: string, options: Options): string {\n  // A plain-JS caller can omit the options object entirely. Reading through a null here would\n  // raise a native TypeError, which is outside the error taxonomy; an absent `locale` is an\n  // unknown locale and must say so with a code (locale-resolution.md 3.1).\n  const given: Partial<Options> = options ?? {};\n  const mode = resolveMode(given.mode);\n  if (mode === \"text\") return runTextPipeline(input, given);\n  if (mode === \"html\") return runHtmlPipeline(input, given);\n  if (mode === \"yaml\") return runYamlPipeline(input, given);\n  return runMarkdownPipeline(input, given);\n}\n\n/**\n * The dispatcher for `analyze` (analyze.md §1). Mode resolution, and therefore\n * POLYTYPO_INVALID_MODE, is shared with `runPipeline` rather than duplicated: A1 requires the\n * two entry points to accept and reject exactly the same arguments.\n */\nexport function runAnalyze(input: string, options: Options): Change[] {\n  const given: Partial<Options> = options ?? {};\n  const mode = resolveMode(given.mode);\n  if (mode === \"text\") return analyzeTextPipeline(input, given);\n  if (mode === \"html\") return analyzeHtmlPipeline(input, given);\n  if (mode === \"yaml\") return analyzeYamlPipeline(input, given);\n  return analyzeMarkdownPipeline(input, given);\n}\n","import { runAnalyze, runPipeline } from \"./engine/pipeline.js\";\nimport type { Change } from \"./engine/origin.js\";\nimport type { Options } from \"./types.js\";\n\nexport function transform(input: string, options: Options): string {\n  return runPipeline(input, options);\n}\n\n/**\n * The same pipeline as `transform`, reporting what it would do instead of doing it\n * (spec/rules/analyze.md). Offsets are code-point offsets into `input` in every mode.\n *\n * What it guarantees: the list is empty exactly when `transform` would return the input\n * unchanged, every `ruleId` was enabled for the call, and every offset is inside the input.\n * What it does not: the list is a report, not a patch — two rules may touch the same original\n * range, so replaying it is not guaranteed to reproduce `transform`'s output. Call `transform`\n * for the text (analyze.md §4, §5).\n */\nexport function analyze(input: string, options: Options): Change[] {\n  return runAnalyze(input, options);\n}\n\nexport { PolytypoError } from \"./errors.js\";\nexport type { PolytypoErrorCode } from \"./errors.js\";\nexport type { Change } from \"./engine/origin.js\";\nexport type {\n  Dialect,\n  Edit,\n  LocaleData,\n  LocaleSource,\n  Mode,\n  NarrowNbsp,\n  Options,\n  QuotePair,\n  Rule,\n  RuleContext,\n  RuleId,\n} from \"./types.js\";\n"]}

package/dist/index.d.cts

@@ -1,6 +1,17 @@
-import { O as Options } from './errors-joZChNws.cjs';
-export { D as Dialect, E as Edit, L as LocaleData, a as LocaleSource, M as Mode, P as PolytypoError, b as PolytypoErrorCode, Q as QuotePair, R as Rule, c as RuleContext, d as RuleId } from './errors-joZChNws.cjs';
+import { O as Options, C as Change } from './errors-CGFOVO3h.cjs';
+export { D as Dialect, E as Edit, L as LocaleData, a as LocaleSource, M as Mode, N as NarrowNbsp, P as PolytypoError, b as PolytypoErrorCode, Q as QuotePair, R as Rule, c as RuleContext, d as RuleId } from './errors-CGFOVO3h.cjs';
 
 declare function transform(input: string, options: Options): string;
+/**
+ * The same pipeline as `transform`, reporting what it would do instead of doing it
+ * (spec/rules/analyze.md). Offsets are code-point offsets into `input` in every mode.
+ *
+ * What it guarantees: the list is empty exactly when `transform` would return the input
+ * unchanged, every `ruleId` was enabled for the call, and every offset is inside the input.
+ * What it does not: the list is a report, not a patch — two rules may touch the same original
+ * range, so replaying it is not guaranteed to reproduce `transform`'s output. Call `transform`
+ * for the text (analyze.md §4, §5).
+ */
+declare function analyze(input: string, options: Options): Change[];
 
-export { Options, transform };
+export { Change, Options, analyze, transform };

package/dist/index.d.ts

@@ -1,6 +1,17 @@
-import { O as Options } from './errors-joZChNws.js';
-export { D as Dialect, E as Edit, L as LocaleData, a as LocaleSource, M as Mode, P as PolytypoError, b as PolytypoErrorCode, Q as QuotePair, R as Rule, c as RuleContext, d as RuleId } from './errors-joZChNws.js';
+import { O as Options, C as Change } from './errors-CGFOVO3h.js';
+export { D as Dialect, E as Edit, L as LocaleData, a as LocaleSource, M as Mode, N as NarrowNbsp, P as PolytypoError, b as PolytypoErrorCode, Q as QuotePair, R as Rule, c as RuleContext, d as RuleId } from './errors-CGFOVO3h.js';
 
 declare function transform(input: string, options: Options): string;
+/**
+ * The same pipeline as `transform`, reporting what it would do instead of doing it
+ * (spec/rules/analyze.md). Offsets are code-point offsets into `input` in every mode.
+ *
+ * What it guarantees: the list is empty exactly when `transform` would return the input
+ * unchanged, every `ruleId` was enabled for the call, and every offset is inside the input.
+ * What it does not: the list is a report, not a patch — two rules may touch the same original
+ * range, so replaying it is not guaranteed to reproduce `transform`'s output. Call `transform`
+ * for the text (analyze.md §4, §5).
+ */
+declare function analyze(input: string, options: Options): Change[];
 
-export { Options, transform };
+export { Change, Options, analyze, transform };

package/dist/index.js

@@ -1,24 +1,32 @@
 import {
+  analyzeTextPipeline,
   runTextPipeline
-} from "./chunk-RC3UKUYZ.js";
+} from "./chunk-B7WXSXRG.js";
 import {
+  analyzeHtmlPipeline,
   runHtmlPipeline
-} from "./chunk-44A6YP7S.js";
+} from "./chunk-VC5XLP6O.js";
 import {
+  analyzeMarkdownPipeline,
   runMarkdownPipeline
-} from "./chunk-6NTDU63P.js";
-import "./chunk-VARU43JT.js";
+} from "./chunk-5NCJ3Y65.js";
+import "./chunk-DXWMSR26.js";
+import {
+  analyzeYamlPipeline,
+  runYamlPipeline
+} from "./chunk-UBEV2AC3.js";
+import "./chunk-5U3DRTV7.js";
 import {
   PolytypoError
-} from "./chunk-OHF7OFWY.js";
+} from "./chunk-VKJVMMCI.js";
 
 // src/engine/pipeline.ts
 function resolveMode(mode) {
   if (mode === void 0 || mode === "text") return "text";
-  if (mode === "html" || mode === "markdown") return mode;
+  if (mode === "html" || mode === "markdown" || mode === "yaml") return mode;
   throw new PolytypoError(
     "POLYTYPO_INVALID_MODE",
-    `Unknown mode "${String(mode)}". Expected "text", "html" or "markdown".`
+    `Unknown mode "${String(mode)}". Expected "text", "html", "markdown" or "yaml".`
   );
 }
 function runPipeline(input, options) {
@@ -26,15 +34,28 @@ function runPipeline(input, options) {
   const mode = resolveMode(given.mode);
   if (mode === "text") return runTextPipeline(input, given);
   if (mode === "html") return runHtmlPipeline(input, given);
+  if (mode === "yaml") return runYamlPipeline(input, given);
   return runMarkdownPipeline(input, given);
 }
+function runAnalyze(input, options) {
+  const given = options ?? {};
+  const mode = resolveMode(given.mode);
+  if (mode === "text") return analyzeTextPipeline(input, given);
+  if (mode === "html") return analyzeHtmlPipeline(input, given);
+  if (mode === "yaml") return analyzeYamlPipeline(input, given);
+  return analyzeMarkdownPipeline(input, given);
+}
 
 // src/index.ts
 function transform(input, options) {
   return runPipeline(input, options);
 }
+function analyze(input, options) {
+  return runAnalyze(input, options);
+}
 export {
   PolytypoError,
+  analyze,
   transform
 };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/engine/pipeline.ts","../src/index.ts"],"sourcesContent":["import { PolytypoError } from \"../errors.js\";\nimport type { Mode, Options } from \"../types.js\";\nimport { runHtmlPipeline } from \"./html-pipeline.js\";\nimport { runMarkdownPipeline } from \"./markdown-pipeline.js\";\nimport { runTextPipeline } from \"./text-pipeline.js\";\n\nexport { planRules } from \"./rule-runner.js\";\n\nfunction resolveMode(mode: Mode | undefined): Mode {\n  if (mode === undefined || mode === \"text\") return \"text\";\n  if (mode === \"html\" || mode === \"markdown\") return mode;\n  throw new PolytypoError(\n    \"POLYTYPO_INVALID_MODE\",\n    `Unknown mode \"${String(mode)}\". Expected \"text\", \"html\" or \"markdown\".`,\n  );\n}\n\n/**\n * The aggregate entry's dispatcher: every mode is reachable, so it is the only pipeline module\n * that imports all three mode-specific ones (and therefore the only one whose module graph\n * includes both `parse5` and the Micromark/MDX stack). `polytypo/text`, `polytypo/html` and\n * `polytypo/markdown` each call their own mode-specific pipeline directly and never import this\n * module (AUDIT_REMEDIATION_AND_RELEASE_PLAN.md 5.1).\n */\nexport function runPipeline(input: string, options: Options): string {\n  // A plain-JS caller can omit the options object entirely. Reading through a null here would\n  // raise a native TypeError, which is outside the error taxonomy; an absent `locale` is an\n  // unknown locale and must say so with a code (locale-resolution.md 3.1).\n  const given: Partial<Options> = options ?? {};\n  const mode = resolveMode(given.mode);\n  if (mode === \"text\") return runTextPipeline(input, given);\n  if (mode === \"html\") return runHtmlPipeline(input, given);\n  return runMarkdownPipeline(input, given);\n}\n","import { runPipeline } from \"./engine/pipeline.js\";\nimport type { Options } from \"./types.js\";\n\nexport function transform(input: string, options: Options): string {\n  return runPipeline(input, options);\n}\n\nexport { PolytypoError } from \"./errors.js\";\nexport type { PolytypoErrorCode } from \"./errors.js\";\nexport type {\n  Dialect,\n  Edit,\n  LocaleData,\n  LocaleSource,\n  Mode,\n  Options,\n  QuotePair,\n  Rule,\n  RuleContext,\n  RuleId,\n} from \"./types.js\";\n"],"mappings":";;;;;;;;;;;;;;;AAQA,SAAS,YAAY,MAA8B;AACjD,MAAI,SAAS,UAAa,SAAS,OAAQ,QAAO;AAClD,MAAI,SAAS,UAAU,SAAS,WAAY,QAAO;AACnD,QAAM,IAAI;AAAA,IACR;AAAA,IACA,iBAAiB,OAAO,IAAI,CAAC;AAAA,EAC/B;AACF;AASO,SAAS,YAAY,OAAe,SAA0B;AAInE,QAAM,QAA0B,WAAW,CAAC;AAC5C,QAAM,OAAO,YAAY,MAAM,IAAI;AACnC,MAAI,SAAS,OAAQ,QAAO,gBAAgB,OAAO,KAAK;AACxD,MAAI,SAAS,OAAQ,QAAO,gBAAgB,OAAO,KAAK;AACxD,SAAO,oBAAoB,OAAO,KAAK;AACzC;;;AC9BO,SAAS,UAAU,OAAe,SAA0B;AACjE,SAAO,YAAY,OAAO,OAAO;AACnC;","names":[]}
+{"version":3,"sources":["../src/engine/pipeline.ts","../src/index.ts"],"sourcesContent":["import { PolytypoError } from \"../errors.js\";\nimport type { Mode, Options } from \"../types.js\";\nimport { analyzeHtmlPipeline, runHtmlPipeline } from \"./html-pipeline.js\";\nimport { analyzeMarkdownPipeline, runMarkdownPipeline } from \"./markdown-pipeline.js\";\nimport { analyzeTextPipeline, runTextPipeline } from \"./text-pipeline.js\";\nimport { analyzeYamlPipeline, runYamlPipeline } from \"./yaml-pipeline.js\";\nimport type { Change } from \"./origin.js\";\n\nexport { planRules } from \"./rule-runner.js\";\n\nfunction resolveMode(mode: Mode | undefined): Mode {\n  if (mode === undefined || mode === \"text\") return \"text\";\n  if (mode === \"html\" || mode === \"markdown\" || mode === \"yaml\") return mode;\n  throw new PolytypoError(\n    \"POLYTYPO_INVALID_MODE\",\n    `Unknown mode \"${String(mode)}\". Expected \"text\", \"html\", \"markdown\" or \"yaml\".`,\n  );\n}\n\n/**\n * The aggregate entry's dispatcher: every mode is reachable, so it is the only pipeline module\n * that imports all four mode-specific ones (and therefore the only one whose module graph\n * includes both `parse5` and the Micromark/MDX stack). `polytypo/text`, `polytypo/html` and\n * `polytypo/markdown` each call their own mode-specific pipeline directly and never import this\n * module (AUDIT_REMEDIATION_AND_RELEASE_PLAN.md 5.1).\n */\nexport function runPipeline(input: string, options: Options): string {\n  // A plain-JS caller can omit the options object entirely. Reading through a null here would\n  // raise a native TypeError, which is outside the error taxonomy; an absent `locale` is an\n  // unknown locale and must say so with a code (locale-resolution.md 3.1).\n  const given: Partial<Options> = options ?? {};\n  const mode = resolveMode(given.mode);\n  if (mode === \"text\") return runTextPipeline(input, given);\n  if (mode === \"html\") return runHtmlPipeline(input, given);\n  if (mode === \"yaml\") return runYamlPipeline(input, given);\n  return runMarkdownPipeline(input, given);\n}\n\n/**\n * The dispatcher for `analyze` (analyze.md §1). Mode resolution, and therefore\n * POLYTYPO_INVALID_MODE, is shared with `runPipeline` rather than duplicated: A1 requires the\n * two entry points to accept and reject exactly the same arguments.\n */\nexport function runAnalyze(input: string, options: Options): Change[] {\n  const given: Partial<Options> = options ?? {};\n  const mode = resolveMode(given.mode);\n  if (mode === \"text\") return analyzeTextPipeline(input, given);\n  if (mode === \"html\") return analyzeHtmlPipeline(input, given);\n  if (mode === \"yaml\") return analyzeYamlPipeline(input, given);\n  return analyzeMarkdownPipeline(input, given);\n}\n","import { runAnalyze, runPipeline } from \"./engine/pipeline.js\";\nimport type { Change } from \"./engine/origin.js\";\nimport type { Options } from \"./types.js\";\n\nexport function transform(input: string, options: Options): string {\n  return runPipeline(input, options);\n}\n\n/**\n * The same pipeline as `transform`, reporting what it would do instead of doing it\n * (spec/rules/analyze.md). Offsets are code-point offsets into `input` in every mode.\n *\n * What it guarantees: the list is empty exactly when `transform` would return the input\n * unchanged, every `ruleId` was enabled for the call, and every offset is inside the input.\n * What it does not: the list is a report, not a patch — two rules may touch the same original\n * range, so replaying it is not guaranteed to reproduce `transform`'s output. Call `transform`\n * for the text (analyze.md §4, §5).\n */\nexport function analyze(input: string, options: Options): Change[] {\n  return runAnalyze(input, options);\n}\n\nexport { PolytypoError } from \"./errors.js\";\nexport type { PolytypoErrorCode } from \"./errors.js\";\nexport type { Change } from \"./engine/origin.js\";\nexport type {\n  Dialect,\n  Edit,\n  LocaleData,\n  LocaleSource,\n  Mode,\n  NarrowNbsp,\n  Options,\n  QuotePair,\n  Rule,\n  RuleContext,\n  RuleId,\n} from \"./types.js\";\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAUA,SAAS,YAAY,MAA8B;AACjD,MAAI,SAAS,UAAa,SAAS,OAAQ,QAAO;AAClD,MAAI,SAAS,UAAU,SAAS,cAAc,SAAS,OAAQ,QAAO;AACtE,QAAM,IAAI;AAAA,IACR;AAAA,IACA,iBAAiB,OAAO,IAAI,CAAC;AAAA,EAC/B;AACF;AASO,SAAS,YAAY,OAAe,SAA0B;AAInE,QAAM,QAA0B,WAAW,CAAC;AAC5C,QAAM,OAAO,YAAY,MAAM,IAAI;AACnC,MAAI,SAAS,OAAQ,QAAO,gBAAgB,OAAO,KAAK;AACxD,MAAI,SAAS,OAAQ,QAAO,gBAAgB,OAAO,KAAK;AACxD,MAAI,SAAS,OAAQ,QAAO,gBAAgB,OAAO,KAAK;AACxD,SAAO,oBAAoB,OAAO,KAAK;AACzC;AAOO,SAAS,WAAW,OAAe,SAA4B;AACpE,QAAM,QAA0B,WAAW,CAAC;AAC5C,QAAM,OAAO,YAAY,MAAM,IAAI;AACnC,MAAI,SAAS,OAAQ,QAAO,oBAAoB,OAAO,KAAK;AAC5D,MAAI,SAAS,OAAQ,QAAO,oBAAoB,OAAO,KAAK;AAC5D,MAAI,SAAS,OAAQ,QAAO,oBAAoB,OAAO,KAAK;AAC5D,SAAO,wBAAwB,OAAO,KAAK;AAC7C;;;AC9CO,SAAS,UAAU,OAAe,SAA0B;AACjE,SAAO,YAAY,OAAO,OAAO;AACnC;AAYO,SAAS,QAAQ,OAAe,SAA4B;AACjE,SAAO,WAAW,OAAO,OAAO;AAClC;","names":[]}

package/dist/markdown.cjs

@@ -1,22 +1,30 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }
 
-var _chunkPOGDWVG5cjs = require('./chunk-POGDWVG5.cjs');
-require('./chunk-LS57O4KJ.cjs');
 
+var _chunkAR6FDQAXcjs = require('./chunk-AR6FDQAX.cjs');
+require('./chunk-THTCAO3O.cjs');
+require('./chunk-ECYUONLP.cjs');
 
-var _chunkYYHKX5HEcjs = require('./chunk-YYHKX5HE.cjs');
 
+var _chunkW2T7B2SHcjs = require('./chunk-W2T7B2SH.cjs');
 
-var _chunkB4O4R6HIcjs = require('./chunk-B4O4R6HI.cjs');
+
+var _chunkV4EOJ44Scjs = require('./chunk-V4EOJ44S.cjs');
 
 // src/index.markdown.ts
 function transform(input, options) {
   const given = _nullishCoalesce(options, () => ( {}));
-  _chunkYYHKX5HEcjs.assertFixedMode.call(void 0, given.mode, "markdown", "polytypo/markdown");
-  return _chunkPOGDWVG5cjs.runMarkdownPipeline.call(void 0, input, given);
+  _chunkW2T7B2SHcjs.assertFixedMode.call(void 0, given.mode, "markdown", "polytypo/markdown");
+  return _chunkAR6FDQAXcjs.runMarkdownPipeline.call(void 0, input, given);
+}
+function analyze(input, options) {
+  const given = _nullishCoalesce(options, () => ( {}));
+  _chunkW2T7B2SHcjs.assertFixedMode.call(void 0, given.mode, "markdown", "polytypo/markdown");
+  return _chunkAR6FDQAXcjs.analyzeMarkdownPipeline.call(void 0, input, given);
 }
 
 
 
-exports.PolytypoError = _chunkB4O4R6HIcjs.PolytypoError; exports.transform = transform;
+
+exports.PolytypoError = _chunkV4EOJ44Scjs.PolytypoError; exports.analyze = analyze; exports.transform = transform;
 //# sourceMappingURL=markdown.cjs.map

package/dist/markdown.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["/home/runner/work/polytypo-js/polytypo-js/dist/markdown.cjs","../src/index.markdown.ts"],"names":[],"mappings":"AAAA;AACE;AACF,wDAA6B;AAC7B,gCAA6B;AAC7B;AACE;AACF,wDAA6B;AAC7B;AACE;AACF,wDAA6B;AAC7B;AACA;ACOO,SAAS,SAAA,CAAU,KAAA,EAAe,OAAA,EAAkC;AACzE,EAAA,MAAM,MAAA,mBAAS,OAAA,UAAW,CAAC,GAAA;AAC3B,EAAA,+CAAA,KAAgB,CAAM,IAAA,EAAM,UAAA,EAAY,mBAAmB,CAAA;AAC3D,EAAA,OAAO,mDAAA,KAAoB,EAAO,KAAK,CAAA;AACzC;ADLA;AACE;AACA;AACF,uFAAC","file":"/home/runner/work/polytypo-js/polytypo-js/dist/markdown.cjs","sourcesContent":[null,"import { assertFixedMode } from \"./engine/assert-fixed-mode.js\";\nimport { runMarkdownPipeline } from \"./engine/markdown-pipeline.js\";\nimport type { Dialect, Options } from \"./types.js\";\n\n/**\n * `polytypo/markdown` — Markdown-only entry point. Its module graph includes the Micromark/MDX\n * stack and `parse5` (the latter via `./modes/markdown.js` importing `./modes/html.js` for\n * normative embedded-HTML handling, modes.md 3.7) — both are legitimately reachable here\n * (AUDIT_REMEDIATION_AND_RELEASE_PLAN.md 5.1). It imports `./engine/markdown-pipeline.js`\n * directly and never `./engine/pipeline.js`.\n *\n * `mode` is absent from `MarkdownOptions`, since this entry only ever runs `markdown` mode.\n * `dialect` keeps the aggregate entry's contract: required, no default (types.ts).\n */\nexport type MarkdownOptions = Omit<Options, \"mode\"> & {\n  dialect: Dialect;\n};\n\nexport function transform(input: string, options: MarkdownOptions): string {\n  const given = (options ?? {}) as Partial<Options>;\n  assertFixedMode(given.mode, \"markdown\", \"polytypo/markdown\");\n  return runMarkdownPipeline(input, given);\n}\n\nexport { PolytypoError } from \"./errors.js\";\nexport type { PolytypoErrorCode } from \"./errors.js\";\nexport type {\n  Dialect,\n  LocaleData,\n  LocaleSource,\n  QuotePair,\n  Rule,\n  RuleContext,\n  RuleId,\n} from \"./types.js\";\n"]}
+{"version":3,"sources":["/home/runner/work/polytypo-js/polytypo-js/dist/markdown.cjs","../src/index.markdown.ts"],"names":[],"mappings":"AAAA;AACE;AACA;AACF,wDAA6B;AAC7B,gCAA6B;AAC7B,gCAA6B;AAC7B;AACE;AACF,wDAA6B;AAC7B;AACE;AACF,wDAA6B;AAC7B;AACA;ACMO,SAAS,SAAA,CAAU,KAAA,EAAe,OAAA,EAAkC;AACzE,EAAA,MAAM,MAAA,mBAAS,OAAA,UAAW,CAAC,GAAA;AAC3B,EAAA,+CAAA,KAAgB,CAAM,IAAA,EAAM,UAAA,EAAY,mBAAmB,CAAA;AAC3D,EAAA,OAAO,mDAAA,KAAoB,EAAO,KAAK,CAAA;AACzC;AAOO,SAAS,OAAA,CAAQ,KAAA,EAAe,OAAA,EAAoC;AACzE,EAAA,MAAM,MAAA,mBAAS,OAAA,UAAW,CAAC,GAAA;AAC3B,EAAA,+CAAA,KAAgB,CAAM,IAAA,EAAM,UAAA,EAAY,mBAAmB,CAAA;AAC3D,EAAA,OAAO,uDAAA,KAAwB,EAAO,KAAK,CAAA;AAC7C;ADVA;AACE;AACA;AACA;AACF,kHAAC","file":"/home/runner/work/polytypo-js/polytypo-js/dist/markdown.cjs","sourcesContent":[null,"import { assertFixedMode } from \"./engine/assert-fixed-mode.js\";\nimport { analyzeMarkdownPipeline, runMarkdownPipeline } from \"./engine/markdown-pipeline.js\";\nimport type { Change } from \"./engine/origin.js\";\nimport type { Dialect, Options } from \"./types.js\";\n\n/**\n * `polytypo/markdown` — Markdown-only entry point. Its module graph includes the Micromark/MDX\n * stack and `parse5` (the latter via `./modes/markdown.js` importing `./modes/html.js` for\n * normative embedded-HTML handling, modes.md 3.7) — both are legitimately reachable here\n * (AUDIT_REMEDIATION_AND_RELEASE_PLAN.md 5.1). It imports `./engine/markdown-pipeline.js`\n * directly and never `./engine/pipeline.js`.\n *\n * `mode` is absent from `MarkdownOptions`, since this entry only ever runs `markdown` mode.\n * `dialect` keeps the aggregate entry's contract: required, no default (types.ts).\n */\nexport type MarkdownOptions = Omit<Options, \"mode\"> & {\n  dialect: Dialect;\n};\n\nexport function transform(input: string, options: MarkdownOptions): string {\n  const given = (options ?? {}) as Partial<Options>;\n  assertFixedMode(given.mode, \"markdown\", \"polytypo/markdown\");\n  return runMarkdownPipeline(input, given);\n}\n\n/**\n * The same pipeline as this entry's `transform`, reporting instead of applying\n * (spec/rules/analyze.md). Offsets are code-point offsets into `input` — into the document,\n * not into a span (analyze.md §6).\n */\nexport function analyze(input: string, options: MarkdownOptions): Change[] {\n  const given = (options ?? {}) as Partial<Options>;\n  assertFixedMode(given.mode, \"markdown\", \"polytypo/markdown\");\n  return analyzeMarkdownPipeline(input, given);\n}\n\nexport { PolytypoError } from \"./errors.js\";\nexport type { PolytypoErrorCode } from \"./errors.js\";\nexport type {\n  Dialect,\n  LocaleData,\n  LocaleSource,\n  NarrowNbsp,\n  QuotePair,\n  Rule,\n  RuleContext,\n  RuleId,\n} from \"./types.js\";\n"]}