politty 0.4.8 → 0.4.9
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/dist/docs/index.cjs +46 -3
- package/dist/docs/index.cjs.map +1 -1
- package/dist/docs/index.d.cts +1 -1
- package/dist/docs/index.d.cts.map +1 -1
- package/dist/docs/index.d.ts +1 -1
- package/dist/docs/index.d.ts.map +1 -1
- package/dist/docs/index.js +46 -3
- package/dist/docs/index.js.map +1 -1
- package/package.json +2 -2
package/dist/docs/index.d.cts
CHANGED
|
@@ -434,7 +434,7 @@ declare const UPDATE_GOLDEN_ENV = "POLITTY_DOCS_UPDATE";
|
|
|
434
434
|
/**
|
|
435
435
|
* All section types in rendering order
|
|
436
436
|
*/
|
|
437
|
-
declare const SECTION_TYPES: readonly ["heading", "description", "usage", "arguments", "options", "subcommands", "examples", "notes"];
|
|
437
|
+
declare const SECTION_TYPES: readonly ["heading", "description", "usage", "arguments", "options", "global-options-link", "subcommands", "examples", "notes"];
|
|
438
438
|
/**
|
|
439
439
|
* Section types for command documentation markers
|
|
440
440
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/executor/subcommand-router.ts","../../src/docs/render-args.ts","../../src/docs/types.ts","../../src/docs/default-renderers.ts","../../src/docs/doc-comparator.ts","../../src/docs/doc-generator.ts","../../src/docs/example-executor.ts","../../src/docs/golden-test.ts","../../src/docs/render-index.ts"],"mappings":";;;;;;;;;;;AASA;iBAAsB,kBAAA,CAAmB,GAAA,EAAK,eAAA,GAAkB,OAAA,CAAQ,UAAA;;;;;;;KCD5D,SAAA,GAAY,MAAA,SAAe,CAAA,CAAE,OAAA;ADCzC;;;AAAA,KCIY,gBAAA;EDJ4D,6DCMtE,OAAA;AAAA;;;;;;;;;;;AAPF;;;;;;;;;AAKA;;;;iBAyCgB,eAAA,CAAgB,IAAA,EAAM,SAAA,EAAW,OAAA,GAAU,gBAAA;;;;KCjD/C,YAAA;;AFIZ;;KECY,mBAAA;EFDkC,4DEG5C,YAAA,GAAe,YAAA,EFH+C;EEK9D,QAAA;AAAA;;;;UAMe,WAAA;EFXiE;EEahF,IAAA;;EAEA,WAAA;;EAEA,eAAA;EDlBmB;ECoBnB,WAAA;EDpB4B;ECsB5B,KAAA;EDtBqC;ECwBrC,cAAA,EAAgB,iBAAA;EDxB8B;EC0B9C,OAAA,EAAS,iBAAA;EDrBC;ECuBV,WAAA,EAAa,cAAA;;EAEb,SAAA,EAAW,eAAA;EDvBJ;ECyBP,OAAA,EAAS,UAAA;EDcoB;ECZ7B,KAAA;EDYyE;ECVzE,QAAA;EDU8B;ECR9B,OAAA,GAAU,MAAA;EDQqC;ECN/C,QAAA,GAAW,OAAA;EDM8D;ECJzE,cAAA,GAAiB,sBAAA;;EAEjB,WAAA;EA/CU;EAiDV,gBAAA;AAAA;;;AA5CF;UAkDiB,cAAA;;EAEf,IAAA;EAlDA;EAoDA,WAAA;EAlDA;EAoDA,QAAA;AAAA;AA9CF;;;AAAA,UAoDiB,sBAAA;EAtCN;EAwCT,GAAA;EApCW;EAsCX,IAAA;EA9BU;EAgCV,cAAA;EA5BiB;EA8BjB,MAAA;EA9BuC;EAgCvC,MAAA;EA1DA;EA4DA,OAAA;AAAA;;;;;UAOe,oBAAA;EAvDf;EAyDA,IAAA,gBAAoB,OAAA;EAvDpB;EAyDA,OAAA,gBAAuB,OAAA;AAAA;;;;;;;;;;;;;KAeb,aAAA,GAAgB,MAAA,SAAe,oBAAA;AAlD3C;;;AAAA,KAuDY,cAAA,IAAkB,IAAA,EAAM,WAAA;;;;;;AA3CpC;;KAoDY,qBAAA,IAAyB,cAAA,UAAwB,IAAA,EAAM,WAAA;;;;UAKlD,oBAAA;EAjDf;EAmDA,KAAA;EA/CA;EAiDA,WAAA;AAAA;AA1CF;;;AAAA,UAgDiB,oBAAA;EA9Cf;EAgDA,OAAA,EAAS,iBAAA;EA9CT;EAgDA,MAAA,GAAS,OAAA,EAAS,iBAAA,IAAqB,IAAA,GAAO,oBAAA;EAhDhB;EAkD9B,OAAA;EAnCU;EAqCV,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,qBAAA,IAAyB,OAAA,EAAS,oBAAA;;AAlC9C;;UAuCiB,sBAAA;EAvCmB;EAyClC,IAAA,EAAM,iBAAA;EAhCI;EAkCV,MAAA,GAAS,IAAA,EAAM,iBAAA,IAAqB,IAAA,GAAO,oBAAA;;EAE3C,OAAA;EApCmC;EAsCnC,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,uBAAA,IAA2B,OAAA,EAAS,sBAAA;;AAnChD;;UAwCiB,wBAAA;EAtCf;EAwCA,eAAA;EAhCe;EAkCf,WAAA;AAAA;;;;UAMe,wBAAA;EAhCE;EAkCjB,WAAA,EAAa,cAAA;EAxCb;EA0CA,MAAA,GAAS,WAAA,EAAa,cAAA,IAAkB,IAAA,GAAO,wBAAA;EAxC/C;EA0CA,OAAA;EA1CS;EA4CT,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,yBAAA,IAA6B,OAAA,EAAS,wBAAA;;;;UAKjC,qBAAA;EA7CL;EA+CV,WAAA;;EAEA,UAAA;EAjDgE;EAmDhE,aAAA;AAAA;;;;UAMe,qBAAA;EA5CT;EA8CN,QAAA,EAAU,OAAA;EA9CO;EAgDjB,OAAA,GAAU,sBAAA;EAtDJ;EAwDN,MAAA,GACE,QAAA,EAAU,OAAA,IACV,OAAA,GAAU,sBAAA,IACV,IAAA,GAAO,qBAAA;EAzDM;EA4Df,OAAA;EA5D2C;EA8D3C,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,sBAAA,IAA0B,OAAA,EAAS,qBAAA;;;;UAK9B,mBAAA;EA/DkB;EAiEjC,OAAA;EAjE8C;EAmE9C,OAAA;EA9De;EAgEf,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,oBAAA,IAAwB,OAAA,EAAS,mBAAA;;AAxD7C;;UA6DiB,sBAAA;EA3DF;EA6Db,YAAA,GAAe,YAAA;EA3DgC;EA6D/C,WAAA;EAzDiB;EA2DjB,eAAA;EAjEA;EAmEA,wBAAA;EAjEA;EAmEA,iBAAA,GAAoB,oBAAA;EAnEX;EAqET,WAAA,GAAc,oBAAA;EArE0B;EAuExC,eAAA,GAAkB,uBAAA;EAnElB;EAqEA,aAAA,GAAgB,qBAAA;EArEC;EAuEjB,iBAAA,GAAoB,yBAAA;EArEV;EAuEV,WAAA,GAAc,oBAAA;;EAEd,YAAA,GAAe,oBAAA;EAzEyD;EA2ExE,cAAA,GAAiB,sBAAA;AAAA;;;;;UAOF,aAAA;EAvEF;EAyEb,IAAA;EAnEe;;;;EAwEf,aAAA,GAAgB,SAAA;IAAc,IAAA,EAAM,SAAA;IAAW,OAAA,GAAU,gBAAA;EAAA;EA1DnD;EA4DN,YAAA,GAAe,YAAA;EA5DE;EA8DjB,KAAA,GAAQ,mBAAA;AAAA;;;;;UAOO,eAAA;EA3EH;EA6EZ,KAAA;EA5ES;EA8ET,WAAA;EA3EA;EA6EA,MAAA;EA3EM;EA6EN,MAAA;AAAA;AA3EF;;;;;AAKA;;;;;;AALA,KAyFY,UAAA;EAAwB,IAAA;EAAc,QAAA,GAAW,MAAA;AAAA;AA5E7D;;;AAAA,UAiFiB,UAAA;EAjF+C;EAmF9D,QAAA;EA9EqC;EAgFrC,MAAA,GAAS,cAAA;EA9EM;EAgFf,KAAA;EAtEc;EAwEd,WAAA;EApEgB;EAsEhB,QAAA;AAAA;;;;;;;;;;;;;KAeU,WAAA,GAAc,MAAA,oBAA0B,UAAA;;;;UAKnC,iBAAA;EAxFf;EA0FA,OAAA,EAAS,UAAA;EAxFT;;;;;EA8FA,OAAA,GAAU,aAAA;EA1F6B;;AAOzC;;EAwFE,IAAA,GAAO,UAAA;EAjFS;EAmFhB,KAAA,GAAQ,WAAA;EAnFiD;EAqFzD,QAAA,GAAW,eAAA;EAjFH;EAmFR,OAAA;EAnF2B;EAqF3B,MAAA,GAAS,sBAAA;EAzFT;EA2FA,SAAA,GAAY,iBAAA;EA3FkB;EA6F9B,QAAA,GAAW,aAAA;EA7FoC;;;;;EAmG/C,cAAA;EA/F2B;;AAO7B;;EA6FE,UAAA,GAAa,UAAA;AAAA;;;;UAME,iBAAA;EA3FT;EA6FN,OAAA;EA/EU;EAiFV,KAAA,EAAO,KAAA;IAjFoD,gBAmFzD,IAAA,UAnFgC;IAqFhC,MAAA,4CArFyD;IAuFzD,IAAA;EAAA;EAlFa;EAqFf,KAAA;AAAA;;;;;KAOU,iBAAA,IAAqB,OAAA,sBAA6B,OAAA;;;;cAKjD,iBAAA;AAxEb;;;AAAA,cA6Ea,aAAA;;AAxEb;;
|
|
1
|
+
{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/executor/subcommand-router.ts","../../src/docs/render-args.ts","../../src/docs/types.ts","../../src/docs/default-renderers.ts","../../src/docs/doc-comparator.ts","../../src/docs/doc-generator.ts","../../src/docs/example-executor.ts","../../src/docs/golden-test.ts","../../src/docs/render-index.ts"],"mappings":";;;;;;;;;;;AASA;iBAAsB,kBAAA,CAAmB,GAAA,EAAK,eAAA,GAAkB,OAAA,CAAQ,UAAA;;;;;;;KCD5D,SAAA,GAAY,MAAA,SAAe,CAAA,CAAE,OAAA;ADCzC;;;AAAA,KCIY,gBAAA;EDJ4D,6DCMtE,OAAA;AAAA;;;;;;;;;;;AAPF;;;;;;;;;AAKA;;;;iBAyCgB,eAAA,CAAgB,IAAA,EAAM,SAAA,EAAW,OAAA,GAAU,gBAAA;;;;KCjD/C,YAAA;;AFIZ;;KECY,mBAAA;EFDkC,4DEG5C,YAAA,GAAe,YAAA,EFH+C;EEK9D,QAAA;AAAA;;;;UAMe,WAAA;EFXiE;EEahF,IAAA;;EAEA,WAAA;;EAEA,eAAA;EDlBmB;ECoBnB,WAAA;EDpB4B;ECsB5B,KAAA;EDtBqC;ECwBrC,cAAA,EAAgB,iBAAA;EDxB8B;EC0B9C,OAAA,EAAS,iBAAA;EDrBC;ECuBV,WAAA,EAAa,cAAA;;EAEb,SAAA,EAAW,eAAA;EDvBJ;ECyBP,OAAA,EAAS,UAAA;EDcoB;ECZ7B,KAAA;EDYyE;ECVzE,QAAA;EDU8B;ECR9B,OAAA,GAAU,MAAA;EDQqC;ECN/C,QAAA,GAAW,OAAA;EDM8D;ECJzE,cAAA,GAAiB,sBAAA;;EAEjB,WAAA;EA/CU;EAiDV,gBAAA;AAAA;;;AA5CF;UAkDiB,cAAA;;EAEf,IAAA;EAlDA;EAoDA,WAAA;EAlDA;EAoDA,QAAA;AAAA;AA9CF;;;AAAA,UAoDiB,sBAAA;EAtCN;EAwCT,GAAA;EApCW;EAsCX,IAAA;EA9BU;EAgCV,cAAA;EA5BiB;EA8BjB,MAAA;EA9BuC;EAgCvC,MAAA;EA1DA;EA4DA,OAAA;AAAA;;;;;UAOe,oBAAA;EAvDf;EAyDA,IAAA,gBAAoB,OAAA;EAvDpB;EAyDA,OAAA,gBAAuB,OAAA;AAAA;;;;;;;;;;;;;KAeb,aAAA,GAAgB,MAAA,SAAe,oBAAA;AAlD3C;;;AAAA,KAuDY,cAAA,IAAkB,IAAA,EAAM,WAAA;;;;;;AA3CpC;;KAoDY,qBAAA,IAAyB,cAAA,UAAwB,IAAA,EAAM,WAAA;;;;UAKlD,oBAAA;EAjDf;EAmDA,KAAA;EA/CA;EAiDA,WAAA;AAAA;AA1CF;;;AAAA,UAgDiB,oBAAA;EA9Cf;EAgDA,OAAA,EAAS,iBAAA;EA9CT;EAgDA,MAAA,GAAS,OAAA,EAAS,iBAAA,IAAqB,IAAA,GAAO,oBAAA;EAhDhB;EAkD9B,OAAA;EAnCU;EAqCV,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,qBAAA,IAAyB,OAAA,EAAS,oBAAA;;AAlC9C;;UAuCiB,sBAAA;EAvCmB;EAyClC,IAAA,EAAM,iBAAA;EAhCI;EAkCV,MAAA,GAAS,IAAA,EAAM,iBAAA,IAAqB,IAAA,GAAO,oBAAA;;EAE3C,OAAA;EApCmC;EAsCnC,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,uBAAA,IAA2B,OAAA,EAAS,sBAAA;;AAnChD;;UAwCiB,wBAAA;EAtCf;EAwCA,eAAA;EAhCe;EAkCf,WAAA;AAAA;;;;UAMe,wBAAA;EAhCE;EAkCjB,WAAA,EAAa,cAAA;EAxCb;EA0CA,MAAA,GAAS,WAAA,EAAa,cAAA,IAAkB,IAAA,GAAO,wBAAA;EAxC/C;EA0CA,OAAA;EA1CS;EA4CT,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,yBAAA,IAA6B,OAAA,EAAS,wBAAA;;;;UAKjC,qBAAA;EA7CL;EA+CV,WAAA;;EAEA,UAAA;EAjDgE;EAmDhE,aAAA;AAAA;;;;UAMe,qBAAA;EA5CT;EA8CN,QAAA,EAAU,OAAA;EA9CO;EAgDjB,OAAA,GAAU,sBAAA;EAtDJ;EAwDN,MAAA,GACE,QAAA,EAAU,OAAA,IACV,OAAA,GAAU,sBAAA,IACV,IAAA,GAAO,qBAAA;EAzDM;EA4Df,OAAA;EA5D2C;EA8D3C,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,sBAAA,IAA0B,OAAA,EAAS,qBAAA;;;;UAK9B,mBAAA;EA/DkB;EAiEjC,OAAA;EAjE8C;EAmE9C,OAAA;EA9De;EAgEf,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,oBAAA,IAAwB,OAAA,EAAS,mBAAA;;AAxD7C;;UA6DiB,sBAAA;EA3DF;EA6Db,YAAA,GAAe,YAAA;EA3DgC;EA6D/C,WAAA;EAzDiB;EA2DjB,eAAA;EAjEA;EAmEA,wBAAA;EAjEA;EAmEA,iBAAA,GAAoB,oBAAA;EAnEX;EAqET,WAAA,GAAc,oBAAA;EArE0B;EAuExC,eAAA,GAAkB,uBAAA;EAnElB;EAqEA,aAAA,GAAgB,qBAAA;EArEC;EAuEjB,iBAAA,GAAoB,yBAAA;EArEV;EAuEV,WAAA,GAAc,oBAAA;;EAEd,YAAA,GAAe,oBAAA;EAzEyD;EA2ExE,cAAA,GAAiB,sBAAA;AAAA;;;;;UAOF,aAAA;EAvEF;EAyEb,IAAA;EAnEe;;;;EAwEf,aAAA,GAAgB,SAAA;IAAc,IAAA,EAAM,SAAA;IAAW,OAAA,GAAU,gBAAA;EAAA;EA1DnD;EA4DN,YAAA,GAAe,YAAA;EA5DE;EA8DjB,KAAA,GAAQ,mBAAA;AAAA;;;;;UAOO,eAAA;EA3EH;EA6EZ,KAAA;EA5ES;EA8ET,WAAA;EA3EA;EA6EA,MAAA;EA3EM;EA6EN,MAAA;AAAA;AA3EF;;;;;AAKA;;;;;;AALA,KAyFY,UAAA;EAAwB,IAAA;EAAc,QAAA,GAAW,MAAA;AAAA;AA5E7D;;;AAAA,UAiFiB,UAAA;EAjF+C;EAmF9D,QAAA;EA9EqC;EAgFrC,MAAA,GAAS,cAAA;EA9EM;EAgFf,KAAA;EAtEc;EAwEd,WAAA;EApEgB;EAsEhB,QAAA;AAAA;;;;;;;;;;;;;KAeU,WAAA,GAAc,MAAA,oBAA0B,UAAA;;;;UAKnC,iBAAA;EAxFf;EA0FA,OAAA,EAAS,UAAA;EAxFT;;;;;EA8FA,OAAA,GAAU,aAAA;EA1F6B;;AAOzC;;EAwFE,IAAA,GAAO,UAAA;EAjFS;EAmFhB,KAAA,GAAQ,WAAA;EAnFiD;EAqFzD,QAAA,GAAW,eAAA;EAjFH;EAmFR,OAAA;EAnF2B;EAqF3B,MAAA,GAAS,sBAAA;EAzFT;EA2FA,SAAA,GAAY,iBAAA;EA3FkB;EA6F9B,QAAA,GAAW,aAAA;EA7FoC;;;;;EAmG/C,cAAA;EA/F2B;;AAO7B;;EA6FE,UAAA,GAAa,UAAA;AAAA;;;;UAME,iBAAA;EA3FT;EA6FN,OAAA;EA/EU;EAiFV,KAAA,EAAO,KAAA;IAjFoD,gBAmFzD,IAAA,UAnFgC;IAqFhC,MAAA,4CArFyD;IAuFzD,IAAA;EAAA;EAlFa;EAqFf,KAAA;AAAA;;;;;KAOU,iBAAA,IAAqB,OAAA,sBAA6B,OAAA;;;;cAKjD,iBAAA;AAxEb;;;AAAA,cA6Ea,aAAA;;AAxEb;;KAuFY,WAAA,WAAsB,aAAA;;;;;cAMrB,qBAAA;;;;iBAKG,kBAAA,CAAmB,IAAA,EAAM,WAAA,EAAa,KAAA;;;;iBAOtC,gBAAA,CAAiB,IAAA,EAAM,WAAA,EAAa,KAAA;;;;;cAQvC,4BAAA;;;;iBAKG,wBAAA,CAAA;;;;iBAOA,sBAAA,CAAA;;;;cAOH,yBAAA;AAAA,iBAEG,qBAAA,CAAA;AAAA,iBAIA,mBAAA,CAAA;;AAhGhB;;cAuGa,yBAAA;AAAA,iBAEG,qBAAA,CAAA;AAAA,iBAIA,mBAAA,CAAA;;;;;cAQH,mBAAA;;;;iBAKG,gBAAA,CAAiB,KAAA;;;;iBAOjB,cAAA,CAAe,KAAA;;;;;;iBC7df,WAAA,CAAY,IAAA,EAAM,WAAA;;;;iBAyBlB,oBAAA,CAAqB,IAAA,EAAM,WAAA;;;;iBAqB3B,mBAAA,CAAoB,IAAA,EAAM,WAAA;;;;;;;;;AF9E1C;;;;;;iBE4JgB,kBAAA,CAAmB,IAAA,EAAM,WAAA;;;AFvJzC;;;;;AAyCA;;;;iBE8JgB,iBAAA,CAAkB,IAAA,EAAM,WAAA;;;;iBAqDxB,sBAAA,CAAuB,IAAA,EAAM,WAAA,EAAa,eAAA;;;;iBAwC1C,2BAAA,CAA4B,OAAA,EAAS,iBAAA;;;;iBAgLrC,0BAAA,CAA2B,OAAA,EAAS,iBAAA;;;AD7cpD;iBCmegB,6BAAA,CAA8B,IAAA,EAAM,iBAAA;;;;iBAqBpC,4BAAA,CAA6B,IAAA,EAAM,iBAAA;;;;iBAkBnC,+BAAA,CACd,WAAA,EAAa,cAAA,IACb,IAAA,EAAM,WAAA,EACN,eAAA;;;;;;;;;;;;;;;;iBAqDc,qBAAA,CACd,QAAA,EAAU,OAAA,IACV,OAAA,GAAU,sBAAA,IACV,IAAA,GAAO,qBAAA;AAAA,iBA2EO,qBAAA,CAAsB,OAAA,GAAS,sBAAA,GAA8B,cAAA;;;;cAiOhE,gBAAA;EDv1BD,yDCy1BU,sBAAA,KAAsB,cAAA,EDv1B/B;8BAEM;;;;;;;;UE5CF,aAAA;;EAEf,KAAA;EJCsC;EICtC,IAAA;EJD4C;EIG5C,UAAA;AAAA;;;;iBAMc,mBAAA,CAAoB,gBAAA,UAA0B,QAAA,WAAmB,aAAA;;;;iBA6BjE,UAAA,CAAW,QAAA,UAAkB,MAAA;;;;iBAsE7B,SAAA,CAAU,QAAA,UAAkB,OAAA;;;;UA4B3B,YAAA;EACf,UAAA,SAAmB,EAAA,CAAG,UAAA;EACtB,UAAA,SAAmB,EAAA,CAAG,UAAA;AAAA;;;;;;iBC3IF,gBAAA,CACpB,OAAA,EAAS,UAAA,EACT,QAAA,UACA,WAAA,cACC,OAAA,CAAQ,WAAA;ALHX;;;;AAAA,iBK0CsB,kBAAA,CACpB,OAAA,EAAS,UAAA,EACT,QAAA,YACC,OAAA,CAAQ,GAAA,SAAY,WAAA;;;;;;;AL7CvB;;;;;iBMIsB,eAAA,CACpB,QAAA,EAAU,OAAA,IACV,MAAA,EAAQ,oBAAA,EACR,WAAA,EAAa,UAAA,EACb,WAAA,cACC,OAAA,CAAQ,sBAAA;;;;;;iBCyyCW,WAAA,CAAY,MAAA,EAAQ,iBAAA,GAAoB,OAAA,CAAQ,iBAAA;APlzCtE;;;;AAAA,iBO00DsB,cAAA,CAAe,MAAA,EAAQ,iBAAA,GAAoB,OAAA;;;;;;;;iBA6BjD,WAAA,CACd,MAAA,EAAQ,IAAA,CAAK,iBAAA,qBACb,UAAA,GAAa,YAAA;;;;;;KC71DH,eAAA;ERZU,oDQcpB,KAAA;EAEA,WAAA,URhBsE;EQkBtE,QAAA,YRlBqE;EQoBrE,OAAA;AAAA;;;;;;;;APrBF;;;;;;;;;AAKA;;;;;AAyCA;;;;;;;;;iBOuGsB,kBAAA,CACpB,OAAA,EAAS,UAAA,EACT,UAAA,EAAY,eAAA,IACZ,OAAA,GAAU,mBAAA,GACT,OAAA"}
|
package/dist/docs/index.d.ts
CHANGED
|
@@ -434,7 +434,7 @@ declare const UPDATE_GOLDEN_ENV = "POLITTY_DOCS_UPDATE";
|
|
|
434
434
|
/**
|
|
435
435
|
* All section types in rendering order
|
|
436
436
|
*/
|
|
437
|
-
declare const SECTION_TYPES: readonly ["heading", "description", "usage", "arguments", "options", "subcommands", "examples", "notes"];
|
|
437
|
+
declare const SECTION_TYPES: readonly ["heading", "description", "usage", "arguments", "options", "global-options-link", "subcommands", "examples", "notes"];
|
|
438
438
|
/**
|
|
439
439
|
* Section types for command documentation markers
|
|
440
440
|
*/
|
package/dist/docs/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/executor/subcommand-router.ts","../../src/docs/render-args.ts","../../src/docs/types.ts","../../src/docs/default-renderers.ts","../../src/docs/doc-comparator.ts","../../src/docs/doc-generator.ts","../../src/docs/example-executor.ts","../../src/docs/golden-test.ts","../../src/docs/render-index.ts"],"mappings":";;;;;;;;;;;AASA;iBAAsB,kBAAA,CAAmB,GAAA,EAAK,eAAA,GAAkB,OAAA,CAAQ,UAAA;;;;;;;KCD5D,SAAA,GAAY,MAAA,SAAe,CAAA,CAAE,OAAA;ADCzC;;;AAAA,KCIY,gBAAA;EDJ4D,6DCMtE,OAAA;AAAA;;;;;;;;;;;AAPF;;;;;;;;;AAKA;;;;iBAyCgB,eAAA,CAAgB,IAAA,EAAM,SAAA,EAAW,OAAA,GAAU,gBAAA;;;;KCjD/C,YAAA;;AFIZ;;KECY,mBAAA;EFDkC,4DEG5C,YAAA,GAAe,YAAA,EFH+C;EEK9D,QAAA;AAAA;;;;UAMe,WAAA;EFXiE;EEahF,IAAA;;EAEA,WAAA;;EAEA,eAAA;EDlBmB;ECoBnB,WAAA;EDpB4B;ECsB5B,KAAA;EDtBqC;ECwBrC,cAAA,EAAgB,iBAAA;EDxB8B;EC0B9C,OAAA,EAAS,iBAAA;EDrBC;ECuBV,WAAA,EAAa,cAAA;;EAEb,SAAA,EAAW,eAAA;EDvBJ;ECyBP,OAAA,EAAS,UAAA;EDcoB;ECZ7B,KAAA;EDYyE;ECVzE,QAAA;EDU8B;ECR9B,OAAA,GAAU,MAAA;EDQqC;ECN/C,QAAA,GAAW,OAAA;EDM8D;ECJzE,cAAA,GAAiB,sBAAA;;EAEjB,WAAA;EA/CU;EAiDV,gBAAA;AAAA;;;AA5CF;UAkDiB,cAAA;;EAEf,IAAA;EAlDA;EAoDA,WAAA;EAlDA;EAoDA,QAAA;AAAA;AA9CF;;;AAAA,UAoDiB,sBAAA;EAtCN;EAwCT,GAAA;EApCW;EAsCX,IAAA;EA9BU;EAgCV,cAAA;EA5BiB;EA8BjB,MAAA;EA9BuC;EAgCvC,MAAA;EA1DA;EA4DA,OAAA;AAAA;;;;;UAOe,oBAAA;EAvDf;EAyDA,IAAA,gBAAoB,OAAA;EAvDpB;EAyDA,OAAA,gBAAuB,OAAA;AAAA;;;;;;;;;;;;;KAeb,aAAA,GAAgB,MAAA,SAAe,oBAAA;AAlD3C;;;AAAA,KAuDY,cAAA,IAAkB,IAAA,EAAM,WAAA;;;;;;AA3CpC;;KAoDY,qBAAA,IAAyB,cAAA,UAAwB,IAAA,EAAM,WAAA;;;;UAKlD,oBAAA;EAjDf;EAmDA,KAAA;EA/CA;EAiDA,WAAA;AAAA;AA1CF;;;AAAA,UAgDiB,oBAAA;EA9Cf;EAgDA,OAAA,EAAS,iBAAA;EA9CT;EAgDA,MAAA,GAAS,OAAA,EAAS,iBAAA,IAAqB,IAAA,GAAO,oBAAA;EAhDhB;EAkD9B,OAAA;EAnCU;EAqCV,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,qBAAA,IAAyB,OAAA,EAAS,oBAAA;;AAlC9C;;UAuCiB,sBAAA;EAvCmB;EAyClC,IAAA,EAAM,iBAAA;EAhCI;EAkCV,MAAA,GAAS,IAAA,EAAM,iBAAA,IAAqB,IAAA,GAAO,oBAAA;;EAE3C,OAAA;EApCmC;EAsCnC,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,uBAAA,IAA2B,OAAA,EAAS,sBAAA;;AAnChD;;UAwCiB,wBAAA;EAtCf;EAwCA,eAAA;EAhCe;EAkCf,WAAA;AAAA;;;;UAMe,wBAAA;EAhCE;EAkCjB,WAAA,EAAa,cAAA;EAxCb;EA0CA,MAAA,GAAS,WAAA,EAAa,cAAA,IAAkB,IAAA,GAAO,wBAAA;EAxC/C;EA0CA,OAAA;EA1CS;EA4CT,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,yBAAA,IAA6B,OAAA,EAAS,wBAAA;;;;UAKjC,qBAAA;EA7CL;EA+CV,WAAA;;EAEA,UAAA;EAjDgE;EAmDhE,aAAA;AAAA;;;;UAMe,qBAAA;EA5CT;EA8CN,QAAA,EAAU,OAAA;EA9CO;EAgDjB,OAAA,GAAU,sBAAA;EAtDJ;EAwDN,MAAA,GACE,QAAA,EAAU,OAAA,IACV,OAAA,GAAU,sBAAA,IACV,IAAA,GAAO,qBAAA;EAzDM;EA4Df,OAAA;EA5D2C;EA8D3C,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,sBAAA,IAA0B,OAAA,EAAS,qBAAA;;;;UAK9B,mBAAA;EA/DkB;EAiEjC,OAAA;EAjE8C;EAmE9C,OAAA;EA9De;EAgEf,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,oBAAA,IAAwB,OAAA,EAAS,mBAAA;;AAxD7C;;UA6DiB,sBAAA;EA3DF;EA6Db,YAAA,GAAe,YAAA;EA3DgC;EA6D/C,WAAA;EAzDiB;EA2DjB,eAAA;EAjEA;EAmEA,wBAAA;EAjEA;EAmEA,iBAAA,GAAoB,oBAAA;EAnEX;EAqET,WAAA,GAAc,oBAAA;EArE0B;EAuExC,eAAA,GAAkB,uBAAA;EAnElB;EAqEA,aAAA,GAAgB,qBAAA;EArEC;EAuEjB,iBAAA,GAAoB,yBAAA;EArEV;EAuEV,WAAA,GAAc,oBAAA;;EAEd,YAAA,GAAe,oBAAA;EAzEyD;EA2ExE,cAAA,GAAiB,sBAAA;AAAA;;;;;UAOF,aAAA;EAvEF;EAyEb,IAAA;EAnEe;;;;EAwEf,aAAA,GAAgB,SAAA;IAAc,IAAA,EAAM,SAAA;IAAW,OAAA,GAAU,gBAAA;EAAA;EA1DnD;EA4DN,YAAA,GAAe,YAAA;EA5DE;EA8DjB,KAAA,GAAQ,mBAAA;AAAA;;;;;UAOO,eAAA;EA3EH;EA6EZ,KAAA;EA5ES;EA8ET,WAAA;EA3EA;EA6EA,MAAA;EA3EM;EA6EN,MAAA;AAAA;AA3EF;;;;;AAKA;;;;;;AALA,KAyFY,UAAA;EAAwB,IAAA;EAAc,QAAA,GAAW,MAAA;AAAA;AA5E7D;;;AAAA,UAiFiB,UAAA;EAjF+C;EAmF9D,QAAA;EA9EqC;EAgFrC,MAAA,GAAS,cAAA;EA9EM;EAgFf,KAAA;EAtEc;EAwEd,WAAA;EApEgB;EAsEhB,QAAA;AAAA;;;;;;;;;;;;;KAeU,WAAA,GAAc,MAAA,oBAA0B,UAAA;;;;UAKnC,iBAAA;EAxFf;EA0FA,OAAA,EAAS,UAAA;EAxFT;;;;;EA8FA,OAAA,GAAU,aAAA;EA1F6B;;AAOzC;;EAwFE,IAAA,GAAO,UAAA;EAjFS;EAmFhB,KAAA,GAAQ,WAAA;EAnFiD;EAqFzD,QAAA,GAAW,eAAA;EAjFH;EAmFR,OAAA;EAnF2B;EAqF3B,MAAA,GAAS,sBAAA;EAzFT;EA2FA,SAAA,GAAY,iBAAA;EA3FkB;EA6F9B,QAAA,GAAW,aAAA;EA7FoC;;;;;EAmG/C,cAAA;EA/F2B;;AAO7B;;EA6FE,UAAA,GAAa,UAAA;AAAA;;;;UAME,iBAAA;EA3FT;EA6FN,OAAA;EA/EU;EAiFV,KAAA,EAAO,KAAA;IAjFoD,gBAmFzD,IAAA,UAnFgC;IAqFhC,MAAA,4CArFyD;IAuFzD,IAAA;EAAA;EAlFa;EAqFf,KAAA;AAAA;;;;;KAOU,iBAAA,IAAqB,OAAA,sBAA6B,OAAA;;;;cAKjD,iBAAA;AAxEb;;;AAAA,cA6Ea,aAAA;;AAxEb;;
|
|
1
|
+
{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/executor/subcommand-router.ts","../../src/docs/render-args.ts","../../src/docs/types.ts","../../src/docs/default-renderers.ts","../../src/docs/doc-comparator.ts","../../src/docs/doc-generator.ts","../../src/docs/example-executor.ts","../../src/docs/golden-test.ts","../../src/docs/render-index.ts"],"mappings":";;;;;;;;;;;AASA;iBAAsB,kBAAA,CAAmB,GAAA,EAAK,eAAA,GAAkB,OAAA,CAAQ,UAAA;;;;;;;KCD5D,SAAA,GAAY,MAAA,SAAe,CAAA,CAAE,OAAA;ADCzC;;;AAAA,KCIY,gBAAA;EDJ4D,6DCMtE,OAAA;AAAA;;;;;;;;;;;AAPF;;;;;;;;;AAKA;;;;iBAyCgB,eAAA,CAAgB,IAAA,EAAM,SAAA,EAAW,OAAA,GAAU,gBAAA;;;;KCjD/C,YAAA;;AFIZ;;KECY,mBAAA;EFDkC,4DEG5C,YAAA,GAAe,YAAA,EFH+C;EEK9D,QAAA;AAAA;;;;UAMe,WAAA;EFXiE;EEahF,IAAA;;EAEA,WAAA;;EAEA,eAAA;EDlBmB;ECoBnB,WAAA;EDpB4B;ECsB5B,KAAA;EDtBqC;ECwBrC,cAAA,EAAgB,iBAAA;EDxB8B;EC0B9C,OAAA,EAAS,iBAAA;EDrBC;ECuBV,WAAA,EAAa,cAAA;;EAEb,SAAA,EAAW,eAAA;EDvBJ;ECyBP,OAAA,EAAS,UAAA;EDcoB;ECZ7B,KAAA;EDYyE;ECVzE,QAAA;EDU8B;ECR9B,OAAA,GAAU,MAAA;EDQqC;ECN/C,QAAA,GAAW,OAAA;EDM8D;ECJzE,cAAA,GAAiB,sBAAA;;EAEjB,WAAA;EA/CU;EAiDV,gBAAA;AAAA;;;AA5CF;UAkDiB,cAAA;;EAEf,IAAA;EAlDA;EAoDA,WAAA;EAlDA;EAoDA,QAAA;AAAA;AA9CF;;;AAAA,UAoDiB,sBAAA;EAtCN;EAwCT,GAAA;EApCW;EAsCX,IAAA;EA9BU;EAgCV,cAAA;EA5BiB;EA8BjB,MAAA;EA9BuC;EAgCvC,MAAA;EA1DA;EA4DA,OAAA;AAAA;;;;;UAOe,oBAAA;EAvDf;EAyDA,IAAA,gBAAoB,OAAA;EAvDpB;EAyDA,OAAA,gBAAuB,OAAA;AAAA;;;;;;;;;;;;;KAeb,aAAA,GAAgB,MAAA,SAAe,oBAAA;AAlD3C;;;AAAA,KAuDY,cAAA,IAAkB,IAAA,EAAM,WAAA;;;;;;AA3CpC;;KAoDY,qBAAA,IAAyB,cAAA,UAAwB,IAAA,EAAM,WAAA;;;;UAKlD,oBAAA;EAjDf;EAmDA,KAAA;EA/CA;EAiDA,WAAA;AAAA;AA1CF;;;AAAA,UAgDiB,oBAAA;EA9Cf;EAgDA,OAAA,EAAS,iBAAA;EA9CT;EAgDA,MAAA,GAAS,OAAA,EAAS,iBAAA,IAAqB,IAAA,GAAO,oBAAA;EAhDhB;EAkD9B,OAAA;EAnCU;EAqCV,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,qBAAA,IAAyB,OAAA,EAAS,oBAAA;;AAlC9C;;UAuCiB,sBAAA;EAvCmB;EAyClC,IAAA,EAAM,iBAAA;EAhCI;EAkCV,MAAA,GAAS,IAAA,EAAM,iBAAA,IAAqB,IAAA,GAAO,oBAAA;;EAE3C,OAAA;EApCmC;EAsCnC,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,uBAAA,IAA2B,OAAA,EAAS,sBAAA;;AAnChD;;UAwCiB,wBAAA;EAtCf;EAwCA,eAAA;EAhCe;EAkCf,WAAA;AAAA;;;;UAMe,wBAAA;EAhCE;EAkCjB,WAAA,EAAa,cAAA;EAxCb;EA0CA,MAAA,GAAS,WAAA,EAAa,cAAA,IAAkB,IAAA,GAAO,wBAAA;EAxC/C;EA0CA,OAAA;EA1CS;EA4CT,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,yBAAA,IAA6B,OAAA,EAAS,wBAAA;;;;UAKjC,qBAAA;EA7CL;EA+CV,WAAA;;EAEA,UAAA;EAjDgE;EAmDhE,aAAA;AAAA;;;;UAMe,qBAAA;EA5CT;EA8CN,QAAA,EAAU,OAAA;EA9CO;EAgDjB,OAAA,GAAU,sBAAA;EAtDJ;EAwDN,MAAA,GACE,QAAA,EAAU,OAAA,IACV,OAAA,GAAU,sBAAA,IACV,IAAA,GAAO,qBAAA;EAzDM;EA4Df,OAAA;EA5D2C;EA8D3C,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,sBAAA,IAA0B,OAAA,EAAS,qBAAA;;;;UAK9B,mBAAA;EA/DkB;EAiEjC,OAAA;EAjE8C;EAmE9C,OAAA;EA9De;EAgEf,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,oBAAA,IAAwB,OAAA,EAAS,mBAAA;;AAxD7C;;UA6DiB,sBAAA;EA3DF;EA6Db,YAAA,GAAe,YAAA;EA3DgC;EA6D/C,WAAA;EAzDiB;EA2DjB,eAAA;EAjEA;EAmEA,wBAAA;EAjEA;EAmEA,iBAAA,GAAoB,oBAAA;EAnEX;EAqET,WAAA,GAAc,oBAAA;EArE0B;EAuExC,eAAA,GAAkB,uBAAA;EAnElB;EAqEA,aAAA,GAAgB,qBAAA;EArEC;EAuEjB,iBAAA,GAAoB,yBAAA;EArEV;EAuEV,WAAA,GAAc,oBAAA;;EAEd,YAAA,GAAe,oBAAA;EAzEyD;EA2ExE,cAAA,GAAiB,sBAAA;AAAA;;;;;UAOF,aAAA;EAvEF;EAyEb,IAAA;EAnEe;;;;EAwEf,aAAA,GAAgB,SAAA;IAAc,IAAA,EAAM,SAAA;IAAW,OAAA,GAAU,gBAAA;EAAA;EA1DnD;EA4DN,YAAA,GAAe,YAAA;EA5DE;EA8DjB,KAAA,GAAQ,mBAAA;AAAA;;;;;UAOO,eAAA;EA3EH;EA6EZ,KAAA;EA5ES;EA8ET,WAAA;EA3EA;EA6EA,MAAA;EA3EM;EA6EN,MAAA;AAAA;AA3EF;;;;;AAKA;;;;;;AALA,KAyFY,UAAA;EAAwB,IAAA;EAAc,QAAA,GAAW,MAAA;AAAA;AA5E7D;;;AAAA,UAiFiB,UAAA;EAjF+C;EAmF9D,QAAA;EA9EqC;EAgFrC,MAAA,GAAS,cAAA;EA9EM;EAgFf,KAAA;EAtEc;EAwEd,WAAA;EApEgB;EAsEhB,QAAA;AAAA;;;;;;;;;;;;;KAeU,WAAA,GAAc,MAAA,oBAA0B,UAAA;;;;UAKnC,iBAAA;EAxFf;EA0FA,OAAA,EAAS,UAAA;EAxFT;;;;;EA8FA,OAAA,GAAU,aAAA;EA1F6B;;AAOzC;;EAwFE,IAAA,GAAO,UAAA;EAjFS;EAmFhB,KAAA,GAAQ,WAAA;EAnFiD;EAqFzD,QAAA,GAAW,eAAA;EAjFH;EAmFR,OAAA;EAnF2B;EAqF3B,MAAA,GAAS,sBAAA;EAzFT;EA2FA,SAAA,GAAY,iBAAA;EA3FkB;EA6F9B,QAAA,GAAW,aAAA;EA7FoC;;;;;EAmG/C,cAAA;EA/F2B;;AAO7B;;EA6FE,UAAA,GAAa,UAAA;AAAA;;;;UAME,iBAAA;EA3FT;EA6FN,OAAA;EA/EU;EAiFV,KAAA,EAAO,KAAA;IAjFoD,gBAmFzD,IAAA,UAnFgC;IAqFhC,MAAA,4CArFyD;IAuFzD,IAAA;EAAA;EAlFa;EAqFf,KAAA;AAAA;;;;;KAOU,iBAAA,IAAqB,OAAA,sBAA6B,OAAA;;;;cAKjD,iBAAA;AAxEb;;;AAAA,cA6Ea,aAAA;;AAxEb;;KAuFY,WAAA,WAAsB,aAAA;;;;;cAMrB,qBAAA;;;;iBAKG,kBAAA,CAAmB,IAAA,EAAM,WAAA,EAAa,KAAA;;;;iBAOtC,gBAAA,CAAiB,IAAA,EAAM,WAAA,EAAa,KAAA;;;;;cAQvC,4BAAA;;;;iBAKG,wBAAA,CAAA;;;;iBAOA,sBAAA,CAAA;;;;cAOH,yBAAA;AAAA,iBAEG,qBAAA,CAAA;AAAA,iBAIA,mBAAA,CAAA;;AAhGhB;;cAuGa,yBAAA;AAAA,iBAEG,qBAAA,CAAA;AAAA,iBAIA,mBAAA,CAAA;;;;;cAQH,mBAAA;;;;iBAKG,gBAAA,CAAiB,KAAA;;;;iBAOjB,cAAA,CAAe,KAAA;;;;;;iBC7df,WAAA,CAAY,IAAA,EAAM,WAAA;;;;iBAyBlB,oBAAA,CAAqB,IAAA,EAAM,WAAA;;;;iBAqB3B,mBAAA,CAAoB,IAAA,EAAM,WAAA;;;;;;;;;AF9E1C;;;;;;iBE4JgB,kBAAA,CAAmB,IAAA,EAAM,WAAA;;;AFvJzC;;;;;AAyCA;;;;iBE8JgB,iBAAA,CAAkB,IAAA,EAAM,WAAA;;;;iBAqDxB,sBAAA,CAAuB,IAAA,EAAM,WAAA,EAAa,eAAA;;;;iBAwC1C,2BAAA,CAA4B,OAAA,EAAS,iBAAA;;;;iBAgLrC,0BAAA,CAA2B,OAAA,EAAS,iBAAA;;;AD7cpD;iBCmegB,6BAAA,CAA8B,IAAA,EAAM,iBAAA;;;;iBAqBpC,4BAAA,CAA6B,IAAA,EAAM,iBAAA;;;;iBAkBnC,+BAAA,CACd,WAAA,EAAa,cAAA,IACb,IAAA,EAAM,WAAA,EACN,eAAA;;;;;;;;;;;;;;;;iBAqDc,qBAAA,CACd,QAAA,EAAU,OAAA,IACV,OAAA,GAAU,sBAAA,IACV,IAAA,GAAO,qBAAA;AAAA,iBA2EO,qBAAA,CAAsB,OAAA,GAAS,sBAAA,GAA8B,cAAA;;;;cAiOhE,gBAAA;EDv1BD,yDCy1BU,sBAAA,KAAsB,cAAA,EDv1B/B;8BAEM;;;;;;;;UE5CF,aAAA;;EAEf,KAAA;EJCsC;EICtC,IAAA;EJD4C;EIG5C,UAAA;AAAA;;;;iBAMc,mBAAA,CAAoB,gBAAA,UAA0B,QAAA,WAAmB,aAAA;;;;iBA6BjE,UAAA,CAAW,QAAA,UAAkB,MAAA;;;;iBAsE7B,SAAA,CAAU,QAAA,UAAkB,OAAA;;;;UA4B3B,YAAA;EACf,UAAA,SAAmB,EAAA,CAAG,UAAA;EACtB,UAAA,SAAmB,EAAA,CAAG,UAAA;AAAA;;;;;;iBC3IF,gBAAA,CACpB,OAAA,EAAS,UAAA,EACT,QAAA,UACA,WAAA,cACC,OAAA,CAAQ,WAAA;ALHX;;;;AAAA,iBK0CsB,kBAAA,CACpB,OAAA,EAAS,UAAA,EACT,QAAA,YACC,OAAA,CAAQ,GAAA,SAAY,WAAA;;;;;;;AL7CvB;;;;;iBMIsB,eAAA,CACpB,QAAA,EAAU,OAAA,IACV,MAAA,EAAQ,oBAAA,EACR,WAAA,EAAa,UAAA,EACb,WAAA,cACC,OAAA,CAAQ,sBAAA;;;;;;iBCyyCW,WAAA,CAAY,MAAA,EAAQ,iBAAA,GAAoB,OAAA,CAAQ,iBAAA;APlzCtE;;;;AAAA,iBO00DsB,cAAA,CAAe,MAAA,EAAQ,iBAAA,GAAoB,OAAA;;;;;;;;iBA6BjD,WAAA,CACd,MAAA,EAAQ,IAAA,CAAK,iBAAA,qBACb,UAAA,GAAa,YAAA;;;;;;KC71DH,eAAA;ERZU,oDQcpB,KAAA;EAEA,WAAA,URhBsE;EQkBtE,QAAA,YRlBqE;EQoBrE,OAAA;AAAA;;;;;;;;APrBF;;;;;;;;;AAKA;;;;;AAyCA;;;;;;;;;iBOuGsB,kBAAA,CACpB,OAAA,EAAS,UAAA,EACT,UAAA,EAAY,eAAA,IACZ,OAAA,GAAU,mBAAA,GACT,OAAA"}
|
package/dist/docs/index.js
CHANGED
|
@@ -19,6 +19,7 @@ const SECTION_TYPES = [
|
|
|
19
19
|
"usage",
|
|
20
20
|
"arguments",
|
|
21
21
|
"options",
|
|
22
|
+
"global-options-link",
|
|
22
23
|
"subcommands",
|
|
23
24
|
"examples",
|
|
24
25
|
"notes"
|
|
@@ -567,7 +568,7 @@ function createCommandRenderer(options = {}) {
|
|
|
567
568
|
}
|
|
568
569
|
{
|
|
569
570
|
const globalLink = getGlobalOptionsLink(info);
|
|
570
|
-
if (globalLink) sections.push(globalLink);
|
|
571
|
+
if (globalLink) sections.push(wrapWithMarker("global-options-link", scope, globalLink));
|
|
571
572
|
}
|
|
572
573
|
if (info.subCommands.length > 0) {
|
|
573
574
|
const effectiveAnchors = generateAnchors && includeSubcommandDetails;
|
|
@@ -1401,6 +1402,26 @@ function insertCommandSections(content, commandPath, newSection, specifiedOrder)
|
|
|
1401
1402
|
return content.trimEnd() + "\n" + newSection + "\n";
|
|
1402
1403
|
}
|
|
1403
1404
|
/**
|
|
1405
|
+
* Remove all section markers for a command from content.
|
|
1406
|
+
* Returns the content with all markers for the command removed and excess blank lines cleaned up.
|
|
1407
|
+
*/
|
|
1408
|
+
function removeCommandSections(content, commandPath) {
|
|
1409
|
+
const markers = collectSectionMarkers(content, commandPath);
|
|
1410
|
+
for (const type of markers) {
|
|
1411
|
+
const start = sectionStartMarker(type, commandPath);
|
|
1412
|
+
const end = sectionEndMarker(type, commandPath);
|
|
1413
|
+
let startIndex = content.indexOf(start);
|
|
1414
|
+
while (startIndex !== -1) {
|
|
1415
|
+
const endIndex = content.indexOf(end, startIndex);
|
|
1416
|
+
if (endIndex === -1) break;
|
|
1417
|
+
content = content.slice(0, startIndex) + content.slice(endIndex + end.length);
|
|
1418
|
+
startIndex = content.indexOf(start, startIndex);
|
|
1419
|
+
}
|
|
1420
|
+
}
|
|
1421
|
+
content = content.replace(/\n{3,}/g, "\n\n");
|
|
1422
|
+
return content;
|
|
1423
|
+
}
|
|
1424
|
+
/**
|
|
1404
1425
|
* Extract a marker section from content
|
|
1405
1426
|
* Returns the content between start and end markers (including markers)
|
|
1406
1427
|
*/
|
|
@@ -1965,6 +1986,25 @@ async function generateDoc(config) {
|
|
|
1965
1986
|
}
|
|
1966
1987
|
}
|
|
1967
1988
|
}
|
|
1989
|
+
if (existingContent) {
|
|
1990
|
+
const existingMarkerPaths = collectSectionMarkerPaths(existingContent);
|
|
1991
|
+
const commandPathSet = new Set(commandPaths);
|
|
1992
|
+
if (updateMode) {
|
|
1993
|
+
let removedAny = false;
|
|
1994
|
+
for (const markerPath of existingMarkerPaths) if (!commandPathSet.has(markerPath)) {
|
|
1995
|
+
existingContent = removeCommandSections(existingContent, markerPath);
|
|
1996
|
+
removedAny = true;
|
|
1997
|
+
}
|
|
1998
|
+
if (removedAny) {
|
|
1999
|
+
writeFile(filePath, existingContent);
|
|
2000
|
+
if (fileStatus !== "created") fileStatus = "updated";
|
|
2001
|
+
}
|
|
2002
|
+
} else for (const markerPath of existingMarkerPaths) if (!commandPathSet.has(markerPath)) {
|
|
2003
|
+
hasError = true;
|
|
2004
|
+
fileStatus = "diff";
|
|
2005
|
+
diffs.push(`Found orphaned section markers for deleted command "${formatCommandPath(markerPath)}"`);
|
|
2006
|
+
}
|
|
2007
|
+
}
|
|
1968
2008
|
} else {
|
|
1969
2009
|
const generatedMarkdown = await applyFormatter(generateFileMarkdown(commandPaths, allCommands, render, filePath, fileMap, specifiedCommands, fileConfig, rootDoc?.path, globalOptionDefinitions.size > 0), formatter);
|
|
1970
2010
|
const comparison = compareWithExisting(generatedMarkdown, filePath);
|
|
@@ -2014,8 +2054,11 @@ async function generateDoc(config) {
|
|
|
2014
2054
|
if (headerMarkerResult.wasUpdated) markerUpdated = true;
|
|
2015
2055
|
}
|
|
2016
2056
|
if (!usingPathConfig) {
|
|
2017
|
-
const unexpectedSectionPaths =
|
|
2018
|
-
if (unexpectedSectionPaths.length > 0) {
|
|
2057
|
+
const unexpectedSectionPaths = collectSectionMarkerPaths(content);
|
|
2058
|
+
if (unexpectedSectionPaths.length > 0) if (updateMode) {
|
|
2059
|
+
for (const commandPath of unexpectedSectionPaths) content = removeCommandSections(content, commandPath);
|
|
2060
|
+
markerUpdated = true;
|
|
2061
|
+
} else {
|
|
2019
2062
|
hasError = true;
|
|
2020
2063
|
rootDocDiffs.push(`Found unexpected section markers in rootDoc: ${unexpectedSectionPaths.map((commandPath) => `"${formatCommandPath(commandPath)}"`).join(", ")}.`);
|
|
2021
2064
|
}
|