deltafold 0.2.0 → 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +33 -1
- package/dist/changelog.d.ts +10 -10
- package/dist/changelog.js +4 -4
- package/dist/changelog.js.map +1 -1
- package/dist/{document-BZcZo9nr.js → document-HfPyYxEd.js} +20 -20
- package/dist/{document-BZcZo9nr.js.map → document-HfPyYxEd.js.map} +1 -1
- package/dist/{document-DWHsgywm.d.ts → document-f2Zy7NQO.d.ts} +41 -41
- package/dist/{document-DWHsgywm.d.ts.map → document-f2Zy7NQO.d.ts.map} +1 -1
- package/dist/html.d.ts +2 -2
- package/dist/html.js +2 -2
- package/dist/html.js.map +1 -1
- package/dist/index.d.ts +437 -105
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +750 -273
- package/dist/index.js.map +1 -1
- package/dist/markdown.d.ts +2 -2
- package/dist/markdown.js +2 -2
- package/dist/markdown.js.map +1 -1
- package/dist/{mdast-DiRsYwPU.js → mdast-Oqkh0Gs1.js} +2 -2
- package/dist/{mdast-DiRsYwPU.js.map → mdast-Oqkh0Gs1.js.map} +1 -1
- package/dist/{package-BfBYnaCz.d.ts → package-BsMlK5xD.d.ts} +126 -116
- package/dist/{package-BfBYnaCz.d.ts.map → package-BsMlK5xD.d.ts.map} +1 -1
- package/package.json +5 -5
- package/src/features/documents/changelog.ts +8 -8
- package/src/features/documents/document.ts +39 -39
- package/src/features/documents/index.ts +2 -2
- package/src/features/execution/executor.ts +485 -313
- package/src/features/execution/handler.ts +30 -30
- package/src/features/execution/interaction.ts +11 -11
- package/src/features/execution/observation.ts +489 -0
- package/src/features/execution/observer.ts +395 -0
- package/src/features/package.ts +13 -8
- package/src/features/planning/history.ts +10 -10
- package/src/features/planning/identifiers.ts +7 -4
- package/src/features/planning/resolve-error.ts +13 -13
- package/src/features/planning/resolve.ts +11 -4
- package/src/features/planning/validate.ts +1 -1
- package/src/foundation/action.ts +17 -17
- package/src/foundation/change.ts +10 -10
- package/src/foundation/instruction.ts +5 -5
- package/src/foundation/migration.ts +12 -12
- package/src/foundation/plan.ts +23 -18
- package/src/foundation/rule.ts +6 -6
- package/src/foundation/shortcut.ts +6 -6
- package/src/foundation/version.ts +6 -6
- package/src/index.ts +14 -12
- package/src/renderers/html.ts +1 -1
- package/src/renderers/markdown.ts +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"package-
|
|
1
|
+
{"version":3,"file":"package-BsMlK5xD.d.ts","names":["Action.Ref","Action.Any","Any","Sequence","Step","Parallel","ActionsOf","define","Any","make","Change.Any","Options","make","Action.Any","Action.Ref","Action.Step","Change.Any","Any","ActionsOf","ChangesOf","make","Action.ActionsOf","Action.Any","Action.Parallel","Action.Step","Any","ActionsOf","Action.Any","Change.Any","Migration.Any","Migration.Migration","Any","ActionsOf","ChangesOf","make","Rule.Any","Action.Any","Migration.Any","Action.Concurrency","Action.Ref","Shortcut.Any","Change.Any","Any","ActionsOf","Action.Any","Change.Any","Migration.Any","Rule.Any","Shortcut.Any","make","Migration.ActionsOf","Rule.ActionsOf","Shortcut.ActionsOf","Migration.ChangesOf","Shortcut.ChangesOf","Action.Any"],"sources":["../src/foundation/template.ts","../src/foundation/instruction.ts","../src/foundation/action.ts","../src/foundation/change.ts","../src/foundation/version.ts","../src/foundation/migration.ts","../src/foundation/rule.ts","../src/foundation/shortcut.ts","../src/foundation/plan.ts","../src/features/planning/validate.ts","../src/features/planning/resolve-error.ts","../src/features/planning/resolve.ts","../src/features/planning/history.ts","../src/features/package.ts"],"mappings":";;KAcY;;;;;;KCHA;WACF;WACA;;;;;;;KAQE,QAAQ,cAAc,OAAOA;;;;;;KAO7B,aAAa,SAASA;;;;;;;;KAStB,YAAY,UAAUC,QAAaA;WACrC;WACA,QAAQ;WACR,SAAS;;;;;;;;;;;;;;cA+DN,cACX,UAAUA,OAAU,QAAU,OAAC,SACtB,yBAAoB,QAAa,cAAc,gBAAc,YAAY;;;;;;;;;KChGxE,KAAK;WACP;WACA;WACA,WAAW,SAAS;;WAEpB,aAAa,mBAAmB,IAAI,IAAI,SAAS,MAAM,OAAO,IAAI;;;;;;;;KAShE,OAAO,4BAA4B;WACrC;WACA,IAAI;WACJ;WACA,SAAS;;WAET;;;;;;;KAQEC,QAAM;;;;;;KAON;WACF;WACA,QAAQA;;;;;;;KAQNC,WAAS,UAAUD,QAAMA;WAC3B;WACA,UAAU,cAAcE;;WAExB,aAAa;;;;;;;KAQX;;;;;;;KAQAC,WAAS,UAAUH,QAAMA;WAC3B;WACA,UAAU,cAAcE;WACxB,aAAa;;WAEb,aAAa;;;;;;;KAQXA,OAAK,UAAUF,QAAMA,SAAO,IAAI,YAAY,KAAKC,WAAS,KAAKE,WAAS;;;;;;KAOxEC,YAAU,KACrB,UAAU,aAAa,UAAU,KAC9B,OAAO,IAAI,KACX,UAAU,kBAAkB,KAC3B,IACA,UAAUH,iBAAe,KACxB,IACA,UAAUE,iBAAe,KACxB;;;;;;;;;;;;;;;;;;;cAqBME,WAAU,GAAC,cACX;WACQ,YAAY,SAAS;MACvC,KAAK;;;;;;cAsBK,MAAG,QAAYL,UAAM;;;;;;cAOrB,iBAAkB,UAAU,cAAcE,SAAK,UACjD,MACRD,WAASG,YAAU;;;;;;;cAQT,iBAAkB,UAAU,cAAcF,SAAK,UACjD,GAAC;WACS,cAAc;MAChCC,WAASC,YAAU;;cAOT,WAAQ,mBAAqB,SAASJ;;cAItC,QAAK,mBAAqB,SAAS;;cAGnC,aAAU,mBAAqB,SAASC;;cAIxC,aAAU,mBAAqB,SAASE;;;;;;;;;KCjLzC;YAAuB;;;KAGvB;YAAyB;;;;;;;;;;;KAWzB,OAAO,mBAAmB;WAC5B;;WAEA;WACA,UAAU;WACV;;WAEA,SAAS,cAAcG;;WAEvB,YAAYA;;;;;;;;KASVA,QAAM;;;;;;KAON;WACF,UAAU,cAAcA;WACxB,aAAaA;;;;;;;KAQX,SAAS,qBACpB,SAAS,yBACN,QAAQ,cAAc,YACrB,OAAO;;;;;;;;;;;;;;;;;iBA4CIC,OAAK,aAAa,SAAS;iBAC3BA,aAAW,kBAC1B,YACA,UAAU,GACV,YAAY,YACV,SAAS;;;;;;KAUA,WAAW;WACb,OAAO,YAAY,UAAU,GAAG,YAAY,cAAc,SAAS;;;;;;;;;;;;;;;;;;;;;cAsBhE,SAAU,uBAAqB,WAAW;;cAG1C,WAAQ,mBAAqB,SAAS;;;;;KC7IvC,QAAQ,UAAUC,QAAaA;WACjC;WACA;;;;;;WAMA,UAAU;;WAEV,SAAS,cAAc;;;KAIrBC,UAAQ,UAAUD,QAAaA;WACjC,WAAW;WACX,SAAS,cAAc;;;;;;;;;;;;;cAcpBE,SAAQ,UAAUF,eAAkB,YACtC,SACDC,UAAQ,OACf,QAAQ;;cAQE,YAAS,mBAAqB,SAAS;;;;;;;KAQxC,QAAQ;WACV;WACA,SAAS;WACT,UAAU;;;;;;;;;;;;;;;cAgBP,qBAAsB,GAAC,SAAW,SAAO,UAAY,MAAI,QAAQ;;;;;;;;;KCxDlE,QAAQ,UAAUE,QAAaA,SAAc,cACxD,OAAOC,MAAaC,OAAY;;;;;;KAQrB,gBAAgB,SAASD,MAAaC;;KAGtC,UAAU,UAAUF,QAAaA,OAAY,UAAUG,QAAaA;WACtE;WACA;WACA,MAAM;WACN,IAAI;;WAEJ,WAAW,cAAc;;WAEzB;;WAEA;WACA,SAAS;;WAET,QAAQ;;WAER,aAAa;;;;;;;KAQXC,QAAM;;;;;;KAONC,YAAU,KAAK,UAAU,gBAAgB,KAAK;;;;;;KAO9CC,YAAU,KAAK,UAAU,qBAAqB,KAAK;;KAGnD,QAAQ,UAAUH,QAAaA;WACjC,MAAM;WACN,IAAI;WACJ,YAAY,cAAc;WAC1B;;;cAIG,cAAW,mBAAqB,SAASC;;;;;;;;;;;;;;;;;;;;cAyFzCG,SACX,UAAUJ,eAAkB,YAAY,SAAW,QAAQ,cACrD,UAAU,cAAc,gBAAc,SACnC,yBAAoB,QAClB,MACT,UAAUK,YAAiB,YAAY;;KAa/B,YAAY,UAAUL,QAAaA,SAAc,QAAQ;;WAE3D;;;;;;;;;cAUG,OAAQ,UAAUA,eAAkB,YACtC,SACD,YAAY,OACnB,iBAAiB;;;;;;;;;;;;;;;;;cA4BP,aACX,UAAUH,OAAY,UAAUG,OAAU,WAAa,UAAU,GAAG,cAC9D,UAAU,cAAc,gBAAc,SACnC,yBAAoB,QAClB,MACT,UAAU,IAAIK,YAAiB,YAAY;;;;;;;;;;KC9NnC,UAAUC,QAAaC;;KAGvB,KAAK,UAAUD,QAAaA;WAC9B;WACA;WACA,OAAO,cAAc;;WAErB,aAAa,cAAcE,OAAY;;;;;;;KAQrCC,QAAM;;;;;;KAONC,YAAU,KAAK,UAAU,WAAW,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;cA0BxC,UAAW,UAAUJ,eAAkB,YACzC;WAEA,OAAO,cAAc;WACrB,aAAa,cAAcE,OAAY;MAE/C,KAAK;;cAQK,SAAM,mBAAqB,SAASC;;;;;KCjErC,SAAS,UAAUE,QAAaA,OAAY,UAAUC,QAAaA;WACrE;WACA;WACA,MAAM;WACN,IAAI;;WAEJ,UAAU,cAAcC;;WAExB,YAAY,cAAcC,UAAoB,GAAG;;WAEjD;;;;;;;KAQEC,QAAM;;;;;;KAONC,YAAU,KAAK,UAAU,eAAe,KAAK;;;;;;KAO7CC,YAAU,KAAK,UAAU,oBAAoB,KAAK;;;;;;;;;;;;;;;;;cAkBjDC,SAAQ,UAAUP,OAAY,UAAUC,eAAkB,YAC5D;WAEA,MAAM;WACN,IAAI;WACJ,UAAU,cAAcC;WACxB,YAAY,cAAcC,UAAoB,GAAG;WACjD;MAER,SAAS,GAAG;;cAWF,aAAU,mBAAqB,SAASC;;;;;;;;;KCjEzC;;;;;;KAOA;WACE;;WAEF;WACA,MAAMI;;WAEN,UAAU,cAAc;;;;;;;;;KAUxB,WAAW,UAAUC,QAAaA;WACpC;;;;;;WAMA;WACA,QAAQ;;WAER,WAAWC;WACX,WAAW;;WAEX,aAAa;WACb,QAAQ;;;KAIN,SAAS,UAAUD,QAAaA;WAClC;WACA,UAAU,cAAc,KAAK;;;KAI3B,SAAS,UAAUA,QAAaA;WAClC;WACA,UAAU,cAAc,KAAK;WAC7B,aAAaE;;;;;;;KAQX,KAAK,UAAUF,QAAaA,SAAc,WAAW,KAAK,SAAS,KAAK,SAAS;;;;;;KAOjF,UAAU,UAAUA,QAAaA,SAC1C,OACAG;WACW;WAA6B,YAAY,WAAW;;WAEtD;WACA;;WAEA,UAAU,cAAc,cAAc,UAAU;;;;;;;;KAShD,KAAK,UAAUH,QAAaA;WAC9B;;;;;WAKA;WACA,WAAWC;WACX,WAAW;WACX,MAAM;WACN,IAAI;WACJ,MAAM,SAAS;;WAEf,OAAO,cAAc,UAAU;;;;;WAK/B;;;;;;;KAQE;WAEA;WACA,MAAMF;WACN,SAAS,cAAc;WACvB,UAAU,cAAc;;WAGxB;WACA,WAAWE;WACX,WAAW;WACX;;;;;;;KAQA;WAEA;WACA,MAAM;WACN,IAAI;;;;;WAKJ,YAAY;aACX,WAAWA;aACX,WAAW;;;WAIZ;WACA,MAAM;WACN,IAAI;WACJ,UAAUG;;;KAIV;;;;;;WAMF;WACA,MAAM,cAAc;;;;;;;KAQlB;;;;;;;KAQA;;;;;;;KAQA,KACX,UAAUJ,QAAaA,OACvB,UAAU,qBACV,WAAWK,QAAaA;WAEf;WACA,MAAM;WACN,IAAI;WACJ,WAAW;WACX,OAAO;WACP,OAAO,cAAc,KAAK;;WAE1B,aAAa,cAAc,WAAW;;WAEtC,SAAS,cAAc;WACvB,cAAc,cAAc;;;;;WAK5B,UAAU;;;;;;;KAQRC,QAAM;;;;;;KAONC,YAAU,KAAK,UAAU,WAAW,UAAU;;;;;;cAO7C,UAAO,MAAUD;;;;;;;;cASjB,sBAAuB,UAAUN,OAAY,WAAWK,OAAU,MACxE,KAAK,GAAG,UAAU,QACtB,KAAK,cAAc;;;;;;KCvOV;WACF;;WAgBA;WACA;;;;;;;KCvBE;;WAEF;WACA,YAAY;WACZ,WAAW;;WAEX;WACA;;WAEA;;;;;;;KAQE;WACF;WACA;WACA;;;;;;;;;;cAQG,uBAAuB;WAC1B,QAAQ,cAAc;;MAElB;;;;;;cAQD,uBAAuB;WAC1B;WACA,OAAO;;MAEH;;;;;;;;;;;cAWD,yBAAyB;WAC5B;WACA;WACA,WAAW;;WAEX,WAAW;;WAEX,SAAS;WACT,UAAU,cAAc;;MAEpB;;;;;;;;;;cAaD,uBAAuB;WAC1B;WACA;WACA,YAAY,cAAc;WAC1B;;MAEI;;;;;;;;;;cAcD,qBAAqB;WACxB;WACA,YAAY,cAAc;;MAEtB;;;;;;;;;;cAYD,qBAAqB;WACxB;WACA,OAAO;WACP;;MAEI;;;;;;;;;;cAUD,4BAA4B;WAC/B;WACA,UAAU;aACT;aACA,OAAO;;;MAGJ;;;;;;;;;;;cAWD,6BAA6B;WAChC;WACA;WACA;;MAEI;;;;;;;;;;cAYD,sBAAsB;WACzB;WACA;WACA;;MAEI;;;KAMF,eAAe,eAAe,sBAAsB;;;;;;;;KASpD,eACT,iBACA,iBACA,mBACA,iBACA,eACA,gBACA;;;;;;;;;;;;;KCnJS;;KA+gBA;WACF,MAAM;WACN,IAAI;;WAEJ;;WAEA,SAAS;;;;;;;KAmFP;WACF,SAAS;WACT,QAAQ;;;;;;WAMR;;;;;;KC3oBE,QAAQ,UAAUG,QAAaA,OAAY,UAAUC,QAAaA;WACpE;WACA,UAAU,cAAc;WACxB,YAAY,cAAcC;WAC1B,OAAO,cAAcC;WACrB,WAAW,cAAcC;;WAEzB,aAAa;;WAEb,aAAa;;;;;;;KAQX,MAAM;;;;;;KAON,UAAU,KAAK,UAAU,cAAc,KAAK;;;;;;KAO5C,UAAU,KAAK,UAAU,mBAAmB,KAAK;;;;;;;;;;cAWhDC,eACN,UAAU,cAAcH,cACxB,UAAU,cAAcC,mBACxB,UAAU,cAAcC,aAAkB;WAEvC,UAAU,cAAc;WACxB,YAAY;WACZ,QAAQ;WACR,YAAY;MAClB,QACHE,YAAoB,aAAaC,YAAe,aAAaC,YAAmB,YAChFC,YAAoB,aAAaC,YAAmB;;cAUxC,YAAS,mBAAqB,SAAS;;;;;;cAsBvC,WAAQ,SAAa,QAAM,cAAc;;;;;;;;;;;;;;;;cAyBzC,UAAW,UAAUV,OAAY,UAAUC,OAAU,SACxD,QAAQ,GAAG,IAAE,SACb,mBACP,OAAO,OAAO,KAAK,aAAa,IAAI;;;;;;cAc1B,WAAQ,SACX,KAAG;WACQ,MAAM;MACxB,OAAO,OAAO,cAAc,cAAc,iBAAiB;;;;;;cAQjD,aAAU,SACb,KAAG;WACQ,MAAM;MACxB,OAAO,OAAO,cAAc,cAAc,iBAAiB;;;;;;;;;;KC5JlD,QAAQ,UAAUU,QAAaA,OAAY;WAC7C;;WAEA,MAAM;WACN,SAAS,QAAQ;;;;;;;;;;;;;cAcd,OAAQ,UAAUA,aAAkB,2BAAyB,MACnE,GAAC;WACa,SAAS,QAAQ;MACnC,QAAQ,GAAG;;cAGD,YAAS,mBAAqB,SAAS"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "deltafold",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.2",
|
|
4
4
|
"description": "Model version history, resolve migration instructions between versions, and generate changelogs.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"changelog",
|
|
@@ -43,14 +43,14 @@
|
|
|
43
43
|
"@types/hast": "3.0.5",
|
|
44
44
|
"@types/mdast": "4.0.4",
|
|
45
45
|
"dedent": "1.7.2",
|
|
46
|
-
"hast-util-to-html": "9.0.
|
|
47
|
-
"mdast-util-to-hast": "13.2.
|
|
48
|
-
"mdast-util-to-markdown": "2.2.
|
|
46
|
+
"hast-util-to-html": "9.0.6",
|
|
47
|
+
"mdast-util-to-hast": "13.2.2",
|
|
48
|
+
"mdast-util-to-markdown": "2.2.3",
|
|
49
49
|
"micromark-util-sanitize-uri": "2.0.1"
|
|
50
50
|
},
|
|
51
51
|
"devDependencies": {
|
|
52
52
|
"@arethetypeswrong/core": "0.18.5",
|
|
53
|
-
"@effect/vitest": "4.1.
|
|
53
|
+
"@effect/vitest": "4.1.4",
|
|
54
54
|
"effect": "^4.1.2",
|
|
55
55
|
"publint": "0.3.25",
|
|
56
56
|
"typescript": "7.0.2",
|
|
@@ -13,7 +13,7 @@ import { asRelease, blocksOf, insertAll } from "./sections.ts";
|
|
|
13
13
|
* A change section of a release. The first section whose `select` matches wins. Selectors
|
|
14
14
|
* read the metadata that the consumer declared on each change.
|
|
15
15
|
*
|
|
16
|
-
* @since
|
|
16
|
+
* @since 0.0.1
|
|
17
17
|
*/
|
|
18
18
|
export type SectionDefinition = {
|
|
19
19
|
readonly _tag: "ChangelogSection";
|
|
@@ -22,7 +22,7 @@ export type SectionDefinition = {
|
|
|
22
22
|
readonly select: (change: Change.Change) => boolean;
|
|
23
23
|
};
|
|
24
24
|
|
|
25
|
-
/** @since
|
|
25
|
+
/** @since 0.0.1 */
|
|
26
26
|
export const section = (
|
|
27
27
|
id: string,
|
|
28
28
|
options: { readonly title: string; readonly select: (change: Change.Change) => boolean },
|
|
@@ -31,7 +31,7 @@ export const section = (
|
|
|
31
31
|
/**
|
|
32
32
|
* Release metadata does not match the package history.
|
|
33
33
|
*
|
|
34
|
-
* @since
|
|
34
|
+
* @since 0.0.1
|
|
35
35
|
*/
|
|
36
36
|
export class ReleaseMetadataError extends Data.TaggedError("ReleaseMetadataError")<{
|
|
37
37
|
readonly reason: "duplicate" | "unrelated" | "missing";
|
|
@@ -39,7 +39,7 @@ export class ReleaseMetadataError extends Data.TaggedError("ReleaseMetadataError
|
|
|
39
39
|
readonly message: string;
|
|
40
40
|
}> {}
|
|
41
41
|
|
|
42
|
-
/** @since
|
|
42
|
+
/** @since 0.0.1 */
|
|
43
43
|
export type HistoryOptions<M> = {
|
|
44
44
|
/**
|
|
45
45
|
* Release metadata annotations, one per included version, in any order. Missing,
|
|
@@ -50,7 +50,7 @@ export type HistoryOptions<M> = {
|
|
|
50
50
|
readonly versions?: ReadonlyArray<Version>;
|
|
51
51
|
};
|
|
52
52
|
|
|
53
|
-
/** @since
|
|
53
|
+
/** @since 0.0.1 */
|
|
54
54
|
export type GuideOptions = {
|
|
55
55
|
/** The modeled package, for the guide title. */
|
|
56
56
|
readonly package?: Package;
|
|
@@ -58,7 +58,7 @@ export type GuideOptions = {
|
|
|
58
58
|
readonly explain?: boolean;
|
|
59
59
|
};
|
|
60
60
|
|
|
61
|
-
/** @since
|
|
61
|
+
/** @since 0.0.1 */
|
|
62
62
|
export type Changelog<M> = {
|
|
63
63
|
readonly sections: ReadonlyArray<SectionDefinition>;
|
|
64
64
|
readonly plugins: ReadonlyArray<Document.Plugin<M>>;
|
|
@@ -85,7 +85,7 @@ export type Changelog<M> = {
|
|
|
85
85
|
) => Document.Document;
|
|
86
86
|
};
|
|
87
87
|
|
|
88
|
-
/** @since
|
|
88
|
+
/** @since 0.0.1 */
|
|
89
89
|
export type Options<M> = {
|
|
90
90
|
readonly sections?: ReadonlyArray<SectionDefinition>;
|
|
91
91
|
readonly plugins?: ReadonlyArray<Document.Plugin<M>>;
|
|
@@ -216,7 +216,7 @@ const stepId = (step: Step) =>
|
|
|
216
216
|
* Markdown.render(changelog.history(widgets, { releases: [release100, release200] }));
|
|
217
217
|
* ```
|
|
218
218
|
*
|
|
219
|
-
* @since
|
|
219
|
+
* @since 0.0.1
|
|
220
220
|
*/
|
|
221
221
|
export const make = <M = unknown>(options: Options<M> = {}): Changelog<M> => {
|
|
222
222
|
const sections = options.sections ?? [];
|
|
@@ -3,45 +3,45 @@ import { Data, Predicate, type Pipeable } from "effect";
|
|
|
3
3
|
import type { Version } from "../../foundation/version.ts";
|
|
4
4
|
import type { Package } from "../package.ts";
|
|
5
5
|
|
|
6
|
-
/** @since
|
|
6
|
+
/** @since 0.0.1 */
|
|
7
7
|
export type Text = { readonly _tag: "Text"; readonly value: string };
|
|
8
|
-
/** @since
|
|
8
|
+
/** @since 0.0.1 */
|
|
9
9
|
export type Code = { readonly _tag: "Code"; readonly value: string };
|
|
10
|
-
/** @since
|
|
10
|
+
/** @since 0.0.1 */
|
|
11
11
|
export type Link = {
|
|
12
12
|
readonly _tag: "Link";
|
|
13
13
|
readonly url: string;
|
|
14
14
|
readonly children: ReadonlyArray<Inline>;
|
|
15
15
|
};
|
|
16
|
-
/** @since
|
|
16
|
+
/** @since 0.0.1 */
|
|
17
17
|
export type Strong = { readonly _tag: "Strong"; readonly children: ReadonlyArray<Inline> };
|
|
18
|
-
/** @since
|
|
18
|
+
/** @since 0.0.1 */
|
|
19
19
|
export type Emphasis = { readonly _tag: "Emphasis"; readonly children: ReadonlyArray<Inline> };
|
|
20
20
|
|
|
21
21
|
/**
|
|
22
22
|
* Phrasing content.
|
|
23
23
|
*
|
|
24
|
-
* @since
|
|
24
|
+
* @since 0.0.1
|
|
25
25
|
*/
|
|
26
26
|
export type Inline = Text | Code | Link | Strong | Emphasis;
|
|
27
27
|
|
|
28
|
-
/** @since
|
|
28
|
+
/** @since 0.0.1 */
|
|
29
29
|
export type Paragraph = { readonly _tag: "Paragraph"; readonly children: ReadonlyArray<Inline> };
|
|
30
|
-
/** @since
|
|
30
|
+
/** @since 0.0.1 */
|
|
31
31
|
export type List = {
|
|
32
32
|
readonly _tag: "List";
|
|
33
33
|
readonly ordered: boolean;
|
|
34
34
|
/** One entry per item. */
|
|
35
35
|
readonly items: ReadonlyArray<ReadonlyArray<Block>>;
|
|
36
36
|
};
|
|
37
|
-
/** @since
|
|
37
|
+
/** @since 0.0.1 */
|
|
38
38
|
export type CodeBlock = {
|
|
39
39
|
readonly _tag: "CodeBlock";
|
|
40
40
|
readonly value: string;
|
|
41
41
|
readonly lang: string | undefined;
|
|
42
42
|
};
|
|
43
43
|
|
|
44
|
-
/** @since
|
|
44
|
+
/** @since 0.0.1 */
|
|
45
45
|
export type Title = Pipeable.Pipeable & {
|
|
46
46
|
readonly _tag: "Title";
|
|
47
47
|
readonly children: ReadonlyArray<Inline>;
|
|
@@ -53,7 +53,7 @@ export type Title = Pipeable.Pipeable & {
|
|
|
53
53
|
* A titled part of a document. Its `id` must be unique within the containing release,
|
|
54
54
|
* or within the document outside releases.
|
|
55
55
|
*
|
|
56
|
-
* @since
|
|
56
|
+
* @since 0.0.1
|
|
57
57
|
*/
|
|
58
58
|
export type Section = Pipeable.Pipeable & {
|
|
59
59
|
readonly _tag: "Section";
|
|
@@ -68,13 +68,13 @@ export type Section = Pipeable.Pipeable & {
|
|
|
68
68
|
readonly release: Version | undefined;
|
|
69
69
|
};
|
|
70
70
|
|
|
71
|
-
/** @since
|
|
71
|
+
/** @since 0.0.1 */
|
|
72
72
|
export type Block = Paragraph | List | CodeBlock | Section;
|
|
73
73
|
|
|
74
74
|
/**
|
|
75
75
|
* A complete document returned by changelog builders.
|
|
76
76
|
*
|
|
77
|
-
* @since
|
|
77
|
+
* @since 0.0.1
|
|
78
78
|
*/
|
|
79
79
|
export type Document = {
|
|
80
80
|
readonly _tag: "Document";
|
|
@@ -85,7 +85,7 @@ export type Document = {
|
|
|
85
85
|
/**
|
|
86
86
|
* Text, or inline nodes.
|
|
87
87
|
*
|
|
88
|
-
* @since
|
|
88
|
+
* @since 0.0.1
|
|
89
89
|
*/
|
|
90
90
|
export type InlineInput = string | Inline | ReadonlyArray<string | Inline>;
|
|
91
91
|
|
|
@@ -109,32 +109,32 @@ const inlines = (value: InlineInput): ReadonlyArray<Inline> => {
|
|
|
109
109
|
return value.map((item) => (typeof item === "string" ? Text(item) : item));
|
|
110
110
|
};
|
|
111
111
|
|
|
112
|
-
/** @since
|
|
112
|
+
/** @since 0.0.1 */
|
|
113
113
|
export const Text = (value: string): Text => ({ _tag: "Text", value });
|
|
114
|
-
/** @since
|
|
114
|
+
/** @since 0.0.1 */
|
|
115
115
|
export const Code = (value: string): Code => ({ _tag: "Code", value });
|
|
116
|
-
/** @since
|
|
116
|
+
/** @since 0.0.1 */
|
|
117
117
|
export const Link = (text: InlineInput, url: string): Link => ({
|
|
118
118
|
_tag: "Link",
|
|
119
119
|
url,
|
|
120
120
|
children: inlines(text),
|
|
121
121
|
});
|
|
122
|
-
/** @since
|
|
122
|
+
/** @since 0.0.1 */
|
|
123
123
|
export const Strong = (children: InlineInput): Strong => ({
|
|
124
124
|
_tag: "Strong",
|
|
125
125
|
children: inlines(children),
|
|
126
126
|
});
|
|
127
|
-
/** @since
|
|
127
|
+
/** @since 0.0.1 */
|
|
128
128
|
export const Emphasis = (children: InlineInput): Emphasis => ({
|
|
129
129
|
_tag: "Emphasis",
|
|
130
130
|
children: inlines(children),
|
|
131
131
|
});
|
|
132
|
-
/** @since
|
|
132
|
+
/** @since 0.0.1 */
|
|
133
133
|
export const Paragraph = (children: InlineInput): Paragraph => ({
|
|
134
134
|
_tag: "Paragraph",
|
|
135
135
|
children: inlines(children),
|
|
136
136
|
});
|
|
137
|
-
/** @since
|
|
137
|
+
/** @since 0.0.1 */
|
|
138
138
|
export const CodeBlock = (value: string, options: { readonly lang?: string } = {}): CodeBlock => ({
|
|
139
139
|
_tag: "CodeBlock",
|
|
140
140
|
value,
|
|
@@ -144,7 +144,7 @@ export const CodeBlock = (value: string, options: { readonly lang?: string } = {
|
|
|
144
144
|
/**
|
|
145
145
|
* Builds a list. Each item is text, an inline node, a block, or several blocks.
|
|
146
146
|
*
|
|
147
|
-
* @since
|
|
147
|
+
* @since 0.0.1
|
|
148
148
|
*/
|
|
149
149
|
export const List = (
|
|
150
150
|
items: ReadonlyArray<string | Inline | Block | ReadonlyArray<Block>>,
|
|
@@ -163,7 +163,7 @@ export const List = (
|
|
|
163
163
|
/**
|
|
164
164
|
* An insertion point inside a plugin's scope.
|
|
165
165
|
*
|
|
166
|
-
* @since
|
|
166
|
+
* @since 0.0.1
|
|
167
167
|
*/
|
|
168
168
|
export type Anchor = {
|
|
169
169
|
readonly _tag: "Anchor";
|
|
@@ -189,7 +189,7 @@ const makeTitle = (text: InlineInput, options: { readonly level?: number } = {})
|
|
|
189
189
|
* Builds a title. `Document.Title.pre` and `Document.Title.post` are the insertion points
|
|
190
190
|
* around a scoped section's title.
|
|
191
191
|
*
|
|
192
|
-
* @since
|
|
192
|
+
* @since 0.0.1
|
|
193
193
|
*/
|
|
194
194
|
export const Title = Object.assign(makeTitle, {
|
|
195
195
|
pre: anchor("title", "pre"),
|
|
@@ -199,14 +199,14 @@ export const Title = Object.assign(makeTitle, {
|
|
|
199
199
|
/**
|
|
200
200
|
* The insertion points around a scoped section's body.
|
|
201
201
|
*
|
|
202
|
-
* @since
|
|
202
|
+
* @since 0.0.1
|
|
203
203
|
*/
|
|
204
204
|
export const Body = { pre: anchor("body", "pre"), post: anchor("body", "post") } as const;
|
|
205
205
|
|
|
206
206
|
const titleOf = (title: Title | string | undefined) =>
|
|
207
207
|
typeof title === "string" ? makeTitle(title) : title;
|
|
208
208
|
|
|
209
|
-
/** @since
|
|
209
|
+
/** @since 0.0.1 */
|
|
210
210
|
export const Section = (id: string, options: SectionOptions = {}): Section => {
|
|
211
211
|
if (id.startsWith(reservedPrefix)) {
|
|
212
212
|
throw new DocumentError({
|
|
@@ -240,7 +240,7 @@ export const generatedSection = (id: string, options: SectionOptions = {}): Sect
|
|
|
240
240
|
/**
|
|
241
241
|
* Sets an absolute heading level on a title. Levels outside 1 to 6 fail at render time.
|
|
242
242
|
*
|
|
243
|
-
* @since
|
|
243
|
+
* @since 0.0.1
|
|
244
244
|
*/
|
|
245
245
|
export const withLevel =
|
|
246
246
|
(level: number) =>
|
|
@@ -250,7 +250,7 @@ export const withLevel =
|
|
|
250
250
|
/**
|
|
251
251
|
* Sets the title of a section.
|
|
252
252
|
*
|
|
253
|
-
* @since
|
|
253
|
+
* @since 0.0.1
|
|
254
254
|
*/
|
|
255
255
|
export const withTitle =
|
|
256
256
|
(title: Title | string) =>
|
|
@@ -260,7 +260,7 @@ export const withTitle =
|
|
|
260
260
|
/**
|
|
261
261
|
* Appends blocks to a section's body.
|
|
262
262
|
*
|
|
263
|
-
* @since
|
|
263
|
+
* @since 0.0.1
|
|
264
264
|
*/
|
|
265
265
|
export const append =
|
|
266
266
|
(...blocks: ReadonlyArray<Block>) =>
|
|
@@ -270,7 +270,7 @@ export const append =
|
|
|
270
270
|
/**
|
|
271
271
|
* A document structure that cannot be rendered.
|
|
272
272
|
*
|
|
273
|
-
* @since
|
|
273
|
+
* @since 0.0.1
|
|
274
274
|
*/
|
|
275
275
|
export class DocumentError extends Data.TaggedError("DocumentError")<{
|
|
276
276
|
readonly reason: "duplicate-section" | "heading-level" | "reserved-id";
|
|
@@ -282,24 +282,24 @@ export class DocumentError extends Data.TaggedError("DocumentError")<{
|
|
|
282
282
|
/**
|
|
283
283
|
* Release-scoped plugins run once per included release.
|
|
284
284
|
*
|
|
285
|
-
* @since
|
|
285
|
+
* @since 0.0.1
|
|
286
286
|
*/
|
|
287
287
|
export const Release = "release";
|
|
288
288
|
/**
|
|
289
289
|
* History-scoped plugins run once per history document.
|
|
290
290
|
*
|
|
291
|
-
* @since
|
|
291
|
+
* @since 0.0.1
|
|
292
292
|
*/
|
|
293
293
|
export const History = "history";
|
|
294
294
|
|
|
295
|
-
/** @since
|
|
295
|
+
/** @since 0.0.1 */
|
|
296
296
|
export type ReleaseContext<M> = {
|
|
297
297
|
readonly package: Package;
|
|
298
298
|
readonly version: Version;
|
|
299
299
|
readonly metadata: M;
|
|
300
300
|
};
|
|
301
301
|
|
|
302
|
-
/** @since
|
|
302
|
+
/** @since 0.0.1 */
|
|
303
303
|
export type HistoryContext<M> = {
|
|
304
304
|
readonly package: Package;
|
|
305
305
|
readonly releases: ReadonlyArray<ReleaseContext<M>>;
|
|
@@ -308,7 +308,7 @@ export type HistoryContext<M> = {
|
|
|
308
308
|
/**
|
|
309
309
|
* Plugin output: blocks to insert, or `null` for nothing.
|
|
310
310
|
*
|
|
311
|
-
* @since
|
|
311
|
+
* @since 0.0.1
|
|
312
312
|
*/
|
|
313
313
|
export type PluginOutput = Block | ReadonlyArray<Block> | null;
|
|
314
314
|
|
|
@@ -319,7 +319,7 @@ export type PluginOutput = Block | ReadonlyArray<Block> | null;
|
|
|
319
319
|
* `Document.Body.post` of that scope's section. Each insertion point receives every
|
|
320
320
|
* plugin's content in configuration order.
|
|
321
321
|
*
|
|
322
|
-
* @since
|
|
322
|
+
* @since 0.0.1
|
|
323
323
|
*/
|
|
324
324
|
export type PluginOptions<M> =
|
|
325
325
|
| {
|
|
@@ -338,11 +338,11 @@ export type PluginOptions<M> =
|
|
|
338
338
|
* they must not fetch metadata or execute migrations. Output is inserted once and is not
|
|
339
339
|
* processed by other plugins.
|
|
340
340
|
*
|
|
341
|
-
* @since
|
|
341
|
+
* @since 0.0.1
|
|
342
342
|
*/
|
|
343
343
|
export type Plugin<M> = { readonly _tag: "Plugin"; readonly id: string } & PluginOptions<M>;
|
|
344
344
|
|
|
345
|
-
/** @since
|
|
345
|
+
/** @since 0.0.1 */
|
|
346
346
|
export const makePlugin = <M>(id: string, options: PluginOptions<M>): Plugin<M> => ({
|
|
347
347
|
_tag: "Plugin",
|
|
348
348
|
id,
|
|
@@ -352,6 +352,6 @@ export const makePlugin = <M>(id: string, options: PluginOptions<M>): Plugin<M>
|
|
|
352
352
|
/**
|
|
353
353
|
* `Document.Plugin.make`
|
|
354
354
|
*
|
|
355
|
-
* @since
|
|
355
|
+
* @since 0.0.1
|
|
356
356
|
*/
|
|
357
357
|
export const Plugin = { make: makePlugin } as const;
|