polytypo 1.0.2 → 1.2.0

package/README.md

@@ -35,7 +35,7 @@ npm install polytypo
 ## Usage
 
 ```ts
-import { transform } from "polytypo";
+import { transform } from "polytypo/text";
 
 transform(`She said, "it's fine" -- but I wasn't sure...`, { locale: "en-US" });
 // She said, “it’s fine”—but I wasn’t sure…
@@ -49,6 +49,16 @@ transform(`Sie sagte: "Alles gut" -- aber ich war mir nicht sicher...`, { locale
 // Sie sagte: „Alles gut“ – aber ich war mir nicht sicher…
 ```
 
+Import the entry for the mode you use. Each subpath entry defaults `mode` to itself and loads only
+the parsers that mode needs:
+
+| Entry               | Parsers it loads                                              |
+| ------------------- | ------------------------------------------------------------- |
+| `polytypo/text`     | none                                                          |
+| `polytypo/html`     | parse5                                                        |
+| `polytypo/markdown` | parse5, micromark and its GFM, frontmatter and MDX extensions |
+| `polytypo`          | all of the above                                              |
+
 HTML and Markdown are first-class modes, not an afterthought — tags, attributes and fenced code
 are left alone; only text content is touched:
 
@@ -59,10 +69,9 @@ transform(`<a title="test... wait">Wait... she said "go on."</a>`, { locale: "en
 // <a title="test... wait">Wait… she said “go on.”</a>
 ```
 
-Subpath entries (`polytypo/text`, `polytypo/html`, `polytypo/markdown`) exclude the parser
-dependencies the other modes don't need, and each defaults `mode` to itself. The aggregate
-`polytypo` entry defaults `mode` to `"text"`; `locale` has no default anywhere and must always be
-passed explicitly — there is no silent fallback to English.
+The aggregate `polytypo` entry defaults `mode` to `"text"` and is the one to use when the mode is
+chosen at runtime. `locale` has no default anywhere and must always be passed explicitly — there is
+no silent fallback to English.
 
 ## Licence
 

package/dist/{chunk-UKWVAQMR.js → chunk-44A6YP7S.js}

@@ -1,11 +1,11 @@
 import {
   htmlSpans,
   runOverSpans
-} from "./chunk-E63PQ3N7.js";
+} from "./chunk-VARU43JT.js";
 import {
   getLocaleData,
   planRules
-} from "./chunk-47XAYIKV.js";
+} from "./chunk-OHF7OFWY.js";
 
 // src/engine/html-pipeline.ts
 function runHtmlPipeline(input, options) {
@@ -18,4 +18,4 @@ function runHtmlPipeline(input, options) {
 export {
   runHtmlPipeline
 };
-//# sourceMappingURL=chunk-UKWVAQMR.js.map
+//# sourceMappingURL=chunk-44A6YP7S.js.map

package/dist/chunk-5VBDCDS6.cjs

@@ -0,0 +1,19 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+
+
+
+var _chunkB4O4R6HIcjs = require('./chunk-B4O4R6HI.cjs');
+
+// src/engine/text-pipeline.ts
+function runTextPipeline(input, options) {
+  const planned = _chunkB4O4R6HIcjs.planRules.call(void 0, options.rules);
+  const locale = _chunkB4O4R6HIcjs.getLocaleData.call(void 0, options.locale);
+  return _chunkB4O4R6HIcjs.fromCodePoints.call(void 0, _chunkB4O4R6HIcjs.runRules.call(void 0, _chunkB4O4R6HIcjs.toCodePoints.call(void 0, input), planned, locale, "text"));
+}
+
+
+
+exports.runTextPipeline = runTextPipeline;
+//# sourceMappingURL=chunk-5VBDCDS6.cjs.map

package/dist/{chunk-DZ72ITYV.cjs.map → chunk-5VBDCDS6.cjs.map}

@@ -1 +1 @@
-{"version":3,"sources":["/home/runner/work/polytypo-js/polytypo-js/dist/chunk-DZ72ITYV.cjs","../src/engine/text-pipeline.ts"],"names":[],"mappings":"AAAA;AACE;AACA;AACA;AACA;AACA;AACF,wDAA6B;AAC7B;AACA;ACQO,SAAS,eAAA,CAAgB,KAAA,EAAe,OAAA,EAAmC;AAChF,EAAA,MAAM,QAAA,EAAU,yCAAA,OAAU,CAAQ,KAAK,CAAA;AACvC,EAAA,MAAM,OAAA,EAAS,6CAAA,OAAc,CAAQ,MAAM,CAAA;AAC3C,EAAA,OAAO,8CAAA,wCAAe,4CAAS,KAAkB,CAAA,EAAG,OAAA,EAAS,MAAA,EAAQ,MAAM,CAAC,CAAA;AAC9E;ADNA;AACA;AACE;AACF,0CAAC","file":"/home/runner/work/polytypo-js/polytypo-js/dist/chunk-DZ72ITYV.cjs","sourcesContent":[null,"import type { Options } from \"../types.js\";\nimport { fromCodePoints, toCodePoints } from \"./codepoints.js\";\nimport { getLocaleData } from \"./locale.js\";\nimport { planRules, runRules } from \"./rule-runner.js\";\n\n/**\n * `text` mode only. Deliberately imports nothing from `../modes/html.js` or\n * `../modes/markdown.js` (or their parser dependencies) — this is what makes `polytypo/text`'s\n * module graph exclude `parse5` and the Micromark stack (AUDIT_REMEDIATION_AND_RELEASE_PLAN.md\n * 5.1).\n *\n * Validation order — `planRules` before `getLocaleData` — mirrors the pre-Stage-5 aggregate\n * `runPipeline` exactly (an unknown-rule error must win over an unknown-locale error when both\n * are present, since that is public, tested behaviour, not an implementation detail this\n * refactor was authorised to change).\n */\nexport function runTextPipeline(input: string, options: Partial<Options>): string {\n  const planned = planRules(options.rules);\n  const locale = getLocaleData(options.locale);\n  return fromCodePoints(runRules(toCodePoints(input), planned, locale, \"text\"));\n}\n"]}
+{"version":3,"sources":["/home/runner/work/polytypo-js/polytypo-js/dist/chunk-5VBDCDS6.cjs","../src/engine/text-pipeline.ts"],"names":[],"mappings":"AAAA;AACE;AACA;AACA;AACA;AACA;AACF,wDAA6B;AAC7B;AACA;ACQO,SAAS,eAAA,CAAgB,KAAA,EAAe,OAAA,EAAmC;AAChF,EAAA,MAAM,QAAA,EAAU,yCAAA,OAAU,CAAQ,KAAK,CAAA;AACvC,EAAA,MAAM,OAAA,EAAS,6CAAA,OAAc,CAAQ,MAAM,CAAA;AAC3C,EAAA,OAAO,8CAAA,wCAAe,4CAAS,KAAkB,CAAA,EAAG,OAAA,EAAS,MAAA,EAAQ,MAAM,CAAC,CAAA;AAC9E;ADNA;AACA;AACE;AACF,0CAAC","file":"/home/runner/work/polytypo-js/polytypo-js/dist/chunk-5VBDCDS6.cjs","sourcesContent":[null,"import type { Options } from \"../types.js\";\nimport { fromCodePoints, toCodePoints } from \"./codepoints.js\";\nimport { getLocaleData } from \"./locale.js\";\nimport { planRules, runRules } from \"./rule-runner.js\";\n\n/**\n * `text` mode only. Deliberately imports nothing from `../modes/html.js` or\n * `../modes/markdown.js` (or their parser dependencies) — this is what makes `polytypo/text`'s\n * module graph exclude `parse5` and the Micromark stack (AUDIT_REMEDIATION_AND_RELEASE_PLAN.md\n * 5.1).\n *\n * Validation order — `planRules` before `getLocaleData` — mirrors the pre-Stage-5 aggregate\n * `runPipeline` exactly (an unknown-rule error must win over an unknown-locale error when both\n * are present, since that is public, tested behaviour, not an implementation detail this\n * refactor was authorised to change).\n */\nexport function runTextPipeline(input: string, options: Partial<Options>): string {\n  const planned = planRules(options.rules);\n  const locale = getLocaleData(options.locale);\n  return fromCodePoints(runRules(toCodePoints(input), planned, locale, \"text\"));\n}\n"]}

package/dist/{chunk-HZPDGNOO.js → chunk-6NTDU63P.js}

@@ -3,12 +3,12 @@ import {
   isSkippedElement,
   runOverSpans,
   wrapParserErrors
-} from "./chunk-E63PQ3N7.js";
+} from "./chunk-VARU43JT.js";
 import {
   PolytypoError,
   getLocaleData,
   planRules
-} from "./chunk-47XAYIKV.js";
+} from "./chunk-OHF7OFWY.js";
 
 // src/modes/markdown.ts
 import { parse, postprocess, preprocess } from "micromark";
@@ -160,4 +160,4 @@ function runMarkdownPipeline(input, options) {
 export {
   runMarkdownPipeline
 };
-//# sourceMappingURL=chunk-HZPDGNOO.js.map
+//# sourceMappingURL=chunk-6NTDU63P.js.map