@endora-commerce/cli 0.100.0
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/LICENSE +21 -0
- package/README.md +37 -0
- package/dist/bin/endora.d.ts +28 -0
- package/dist/bin/endora.d.ts.map +1 -0
- package/dist/bin/endora.js +926 -0
- package/dist/bin/endora.js.map +1 -0
- package/dist/check/estate.d.ts +189 -0
- package/dist/check/estate.d.ts.map +1 -0
- package/dist/check/estate.js +1037 -0
- package/dist/check/estate.js.map +1 -0
- package/dist/check/hosts.d.ts +25 -0
- package/dist/check/hosts.d.ts.map +1 -0
- package/dist/check/hosts.js +1347 -0
- package/dist/check/hosts.js.map +1 -0
- package/dist/check/index.d.ts +60 -0
- package/dist/check/index.d.ts.map +1 -0
- package/dist/check/index.js +111 -0
- package/dist/check/index.js.map +1 -0
- package/dist/check/layout.d.ts +136 -0
- package/dist/check/layout.d.ts.map +1 -0
- package/dist/check/layout.js +262 -0
- package/dist/check/layout.js.map +1 -0
- package/dist/check/ledger.d.ts +98 -0
- package/dist/check/ledger.d.ts.map +1 -0
- package/dist/check/ledger.js +173 -0
- package/dist/check/ledger.js.map +1 -0
- package/dist/check/peer-owners.d.ts +116 -0
- package/dist/check/peer-owners.d.ts.map +1 -0
- package/dist/check/peer-owners.js +225 -0
- package/dist/check/peer-owners.js.map +1 -0
- package/dist/check/report.d.ts +33 -0
- package/dist/check/report.d.ts.map +1 -0
- package/dist/check/report.js +107 -0
- package/dist/check/report.js.map +1 -0
- package/dist/check/run.d.ts +147 -0
- package/dist/check/run.d.ts.map +1 -0
- package/dist/check/run.js +111 -0
- package/dist/check/run.js.map +1 -0
- package/dist/checks.d.ts +17 -0
- package/dist/checks.d.ts.map +1 -0
- package/dist/checks.js +17 -0
- package/dist/checks.js.map +1 -0
- package/dist/dev/index.d.ts +83 -0
- package/dist/dev/index.d.ts.map +1 -0
- package/dist/dev/index.js +298 -0
- package/dist/dev/index.js.map +1 -0
- package/dist/generate/divergence.d.ts +38 -0
- package/dist/generate/divergence.d.ts.map +1 -0
- package/dist/generate/divergence.js +237 -0
- package/dist/generate/divergence.js.map +1 -0
- package/dist/generate/index.d.ts +90 -0
- package/dist/generate/index.d.ts.map +1 -0
- package/dist/generate/index.js +369 -0
- package/dist/generate/index.js.map +1 -0
- package/dist/index.d.ts +23 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +35 -0
- package/dist/index.js.map +1 -0
- package/dist/inputs/declaration.d.ts +18 -0
- package/dist/inputs/declaration.d.ts.map +1 -0
- package/dist/inputs/declaration.js +64 -0
- package/dist/inputs/declaration.js.map +1 -0
- package/dist/inputs/env-file.d.ts +73 -0
- package/dist/inputs/env-file.d.ts.map +1 -0
- package/dist/inputs/env-file.js +134 -0
- package/dist/inputs/env-file.js.map +1 -0
- package/dist/inputs/prompt.d.ts +21 -0
- package/dist/inputs/prompt.d.ts.map +1 -0
- package/dist/inputs/prompt.js +59 -0
- package/dist/inputs/prompt.js.map +1 -0
- package/dist/inputs/resolve.d.ts +163 -0
- package/dist/inputs/resolve.d.ts.map +1 -0
- package/dist/inputs/resolve.js +290 -0
- package/dist/inputs/resolve.js.map +1 -0
- package/dist/install/host.d.ts +27 -0
- package/dist/install/host.d.ts.map +1 -0
- package/dist/install/host.js +90 -0
- package/dist/install/host.js.map +1 -0
- package/dist/install/index.d.ts +173 -0
- package/dist/install/index.d.ts.map +1 -0
- package/dist/install/index.js +793 -0
- package/dist/install/index.js.map +1 -0
- package/dist/install/wizard.d.ts +144 -0
- package/dist/install/wizard.d.ts.map +1 -0
- package/dist/install/wizard.js +362 -0
- package/dist/install/wizard.js.map +1 -0
- package/dist/lib/admin-artefacts.d.ts +70 -0
- package/dist/lib/admin-artefacts.d.ts.map +1 -0
- package/dist/lib/admin-artefacts.js +354 -0
- package/dist/lib/admin-artefacts.js.map +1 -0
- package/dist/lib/admin-surfaces.d.ts +298 -0
- package/dist/lib/admin-surfaces.d.ts.map +1 -0
- package/dist/lib/admin-surfaces.js +669 -0
- package/dist/lib/admin-surfaces.js.map +1 -0
- package/dist/lib/delegated-composer.d.ts +85 -0
- package/dist/lib/delegated-composer.d.ts.map +1 -0
- package/dist/lib/delegated-composer.js +241 -0
- package/dist/lib/delegated-composer.js.map +1 -0
- package/dist/lib/divergence-artefacts.d.ts +305 -0
- package/dist/lib/divergence-artefacts.d.ts.map +1 -0
- package/dist/lib/divergence-artefacts.js +828 -0
- package/dist/lib/divergence-artefacts.js.map +1 -0
- package/dist/lib/divergence.d.ts +337 -0
- package/dist/lib/divergence.d.ts.map +1 -0
- package/dist/lib/divergence.js +1005 -0
- package/dist/lib/divergence.js.map +1 -0
- package/dist/lib/docs-artefacts.d.ts +395 -0
- package/dist/lib/docs-artefacts.d.ts.map +1 -0
- package/dist/lib/docs-artefacts.js +781 -0
- package/dist/lib/docs-artefacts.js.map +1 -0
- package/dist/lib/emitted-exports.d.ts +21 -0
- package/dist/lib/emitted-exports.d.ts.map +1 -0
- package/dist/lib/emitted-exports.js +96 -0
- package/dist/lib/emitted-exports.js.map +1 -0
- package/dist/lib/emitted-freshness.d.ts +112 -0
- package/dist/lib/emitted-freshness.d.ts.map +1 -0
- package/dist/lib/emitted-freshness.js +288 -0
- package/dist/lib/emitted-freshness.js.map +1 -0
- package/dist/lib/entity-index-artefact.d.ts +95 -0
- package/dist/lib/entity-index-artefact.d.ts.map +1 -0
- package/dist/lib/entity-index-artefact.js +210 -0
- package/dist/lib/entity-index-artefact.js.map +1 -0
- package/dist/lib/instance-build-inputs.d.ts +108 -0
- package/dist/lib/instance-build-inputs.d.ts.map +1 -0
- package/dist/lib/instance-build-inputs.js +165 -0
- package/dist/lib/instance-build-inputs.js.map +1 -0
- package/dist/lib/module-docs.d.ts +473 -0
- package/dist/lib/module-docs.d.ts.map +1 -0
- package/dist/lib/module-docs.js +711 -0
- package/dist/lib/module-docs.js.map +1 -0
- package/dist/lib/module-package-subpaths.d.ts +56 -0
- package/dist/lib/module-package-subpaths.d.ts.map +1 -0
- package/dist/lib/module-package-subpaths.js +223 -0
- package/dist/lib/module-package-subpaths.js.map +1 -0
- package/dist/lib/module-packages.d.ts +200 -0
- package/dist/lib/module-packages.d.ts.map +1 -0
- package/dist/lib/module-packages.js +580 -0
- package/dist/lib/module-packages.js.map +1 -0
- package/dist/lib/module-population.d.ts +129 -0
- package/dist/lib/module-population.d.ts.map +1 -0
- package/dist/lib/module-population.js +172 -0
- package/dist/lib/module-population.js.map +1 -0
- package/dist/lib/module-roots.d.ts +337 -0
- package/dist/lib/module-roots.d.ts.map +1 -0
- package/dist/lib/module-roots.js +586 -0
- package/dist/lib/module-roots.js.map +1 -0
- package/dist/lib/nested-checkouts.d.ts +33 -0
- package/dist/lib/nested-checkouts.d.ts.map +1 -0
- package/dist/lib/nested-checkouts.js +160 -0
- package/dist/lib/nested-checkouts.js.map +1 -0
- package/dist/lib/platform-root.d.ts +43 -0
- package/dist/lib/platform-root.d.ts.map +1 -0
- package/dist/lib/platform-root.js +134 -0
- package/dist/lib/platform-root.js.map +1 -0
- package/dist/lib/platform-surface.d.ts +235 -0
- package/dist/lib/platform-surface.d.ts.map +1 -0
- package/dist/lib/platform-surface.js +393 -0
- package/dist/lib/platform-surface.js.map +1 -0
- package/dist/lib/port-registrations.d.ts +223 -0
- package/dist/lib/port-registrations.d.ts.map +1 -0
- package/dist/lib/port-registrations.js +532 -0
- package/dist/lib/port-registrations.js.map +1 -0
- package/dist/lib/read-size.d.ts +154 -0
- package/dist/lib/read-size.d.ts.map +1 -0
- package/dist/lib/read-size.js +182 -0
- package/dist/lib/read-size.js.map +1 -0
- package/dist/lib/registration-owners.d.ts +79 -0
- package/dist/lib/registration-owners.d.ts.map +1 -0
- package/dist/lib/registration-owners.js +77 -0
- package/dist/lib/registration-owners.js.map +1 -0
- package/dist/lib/release-index.d.ts +53 -0
- package/dist/lib/release-index.d.ts.map +1 -0
- package/dist/lib/release-index.js +162 -0
- package/dist/lib/release-index.js.map +1 -0
- package/dist/lib/repeating-timers.d.ts +79 -0
- package/dist/lib/repeating-timers.d.ts.map +1 -0
- package/dist/lib/repeating-timers.js +189 -0
- package/dist/lib/repeating-timers.js.map +1 -0
- package/dist/lib/source-text.d.ts +34 -0
- package/dist/lib/source-text.d.ts.map +1 -0
- package/dist/lib/source-text.js +80 -0
- package/dist/lib/source-text.js.map +1 -0
- package/dist/lib/specifiers.d.ts +20 -0
- package/dist/lib/specifiers.d.ts.map +1 -0
- package/dist/lib/specifiers.js +130 -0
- package/dist/lib/specifiers.js.map +1 -0
- package/dist/lib/sql-tables.d.ts +166 -0
- package/dist/lib/sql-tables.d.ts.map +1 -0
- package/dist/lib/sql-tables.js +464 -0
- package/dist/lib/sql-tables.js.map +1 -0
- package/dist/lib/switchable-modules.d.ts +54 -0
- package/dist/lib/switchable-modules.d.ts.map +1 -0
- package/dist/lib/switchable-modules.js +104 -0
- package/dist/lib/switchable-modules.js.map +1 -0
- package/dist/lib/tailwind-sources.d.ts +136 -0
- package/dist/lib/tailwind-sources.d.ts.map +1 -0
- package/dist/lib/tailwind-sources.js +307 -0
- package/dist/lib/tailwind-sources.js.map +1 -0
- package/dist/lib/ui-layer.d.ts +54 -0
- package/dist/lib/ui-layer.d.ts.map +1 -0
- package/dist/lib/ui-layer.js +57 -0
- package/dist/lib/ui-layer.js.map +1 -0
- package/dist/lib/workspace-packages.d.ts +186 -0
- package/dist/lib/workspace-packages.d.ts.map +1 -0
- package/dist/lib/workspace-packages.js +351 -0
- package/dist/lib/workspace-packages.js.map +1 -0
- package/dist/new-instance/deploy.d.ts +211 -0
- package/dist/new-instance/deploy.d.ts.map +1 -0
- package/dist/new-instance/deploy.js +1381 -0
- package/dist/new-instance/deploy.js.map +1 -0
- package/dist/new-instance/docs-toolchain.d.ts +66 -0
- package/dist/new-instance/docs-toolchain.d.ts.map +1 -0
- package/dist/new-instance/docs-toolchain.js +69 -0
- package/dist/new-instance/docs-toolchain.js.map +1 -0
- package/dist/new-instance/host.d.ts +124 -0
- package/dist/new-instance/host.d.ts.map +1 -0
- package/dist/new-instance/host.js +276 -0
- package/dist/new-instance/host.js.map +1 -0
- package/dist/new-instance/index.d.ts +118 -0
- package/dist/new-instance/index.d.ts.map +1 -0
- package/dist/new-instance/index.js +567 -0
- package/dist/new-instance/index.js.map +1 -0
- package/dist/new-instance/modules.d.ts +188 -0
- package/dist/new-instance/modules.d.ts.map +1 -0
- package/dist/new-instance/modules.js +392 -0
- package/dist/new-instance/modules.js.map +1 -0
- package/dist/new-instance/template.d.ts +505 -0
- package/dist/new-instance/template.d.ts.map +1 -0
- package/dist/new-instance/template.js +1886 -0
- package/dist/new-instance/template.js.map +1 -0
- package/dist/new-module/emit.d.ts +67 -0
- package/dist/new-module/emit.d.ts.map +1 -0
- package/dist/new-module/emit.js +1393 -0
- package/dist/new-module/emit.js.map +1 -0
- package/dist/new-module/host.d.ts +67 -0
- package/dist/new-module/host.d.ts.map +1 -0
- package/dist/new-module/host.js +224 -0
- package/dist/new-module/host.js.map +1 -0
- package/dist/new-module/index.d.ts +32 -0
- package/dist/new-module/index.d.ts.map +1 -0
- package/dist/new-module/index.js +193 -0
- package/dist/new-module/index.js.map +1 -0
- package/dist/new-module/spec.d.ts +188 -0
- package/dist/new-module/spec.d.ts.map +1 -0
- package/dist/new-module/spec.js +404 -0
- package/dist/new-module/spec.js.map +1 -0
- package/dist/new-module/text.d.ts +15 -0
- package/dist/new-module/text.d.ts.map +1 -0
- package/dist/new-module/text.js +22 -0
- package/dist/new-module/text.js.map +1 -0
- package/dist/new-storefront/dockerfile.d.ts +20 -0
- package/dist/new-storefront/dockerfile.d.ts.map +1 -0
- package/dist/new-storefront/dockerfile.js +131 -0
- package/dist/new-storefront/dockerfile.js.map +1 -0
- package/dist/new-storefront/gitignore.d.ts +23 -0
- package/dist/new-storefront/gitignore.d.ts.map +1 -0
- package/dist/new-storefront/gitignore.js +39 -0
- package/dist/new-storefront/gitignore.js.map +1 -0
- package/dist/new-storefront/index.d.ts +93 -0
- package/dist/new-storefront/index.d.ts.map +1 -0
- package/dist/new-storefront/index.js +329 -0
- package/dist/new-storefront/index.js.map +1 -0
- package/dist/new-storefront/npmrc.d.ts +98 -0
- package/dist/new-storefront/npmrc.d.ts.map +1 -0
- package/dist/new-storefront/npmrc.js +217 -0
- package/dist/new-storefront/npmrc.js.map +1 -0
- package/dist/new-storefront/reference.d.ts +189 -0
- package/dist/new-storefront/reference.d.ts.map +1 -0
- package/dist/new-storefront/reference.js +430 -0
- package/dist/new-storefront/reference.js.map +1 -0
- package/dist/new-storefront/rewrite.d.ts +171 -0
- package/dist/new-storefront/rewrite.d.ts.map +1 -0
- package/dist/new-storefront/rewrite.js +701 -0
- package/dist/new-storefront/rewrite.js.map +1 -0
- package/dist/release-index.json +284 -0
- package/dist/rules/action-route-permissions.d.ts +141 -0
- package/dist/rules/action-route-permissions.d.ts.map +1 -0
- package/dist/rules/action-route-permissions.js +556 -0
- package/dist/rules/action-route-permissions.js.map +1 -0
- package/dist/rules/bundle-pairing.d.ts +74 -0
- package/dist/rules/bundle-pairing.d.ts.map +1 -0
- package/dist/rules/bundle-pairing.js +281 -0
- package/dist/rules/bundle-pairing.js.map +1 -0
- package/dist/rules/channel-resolution.d.ts +17 -0
- package/dist/rules/channel-resolution.d.ts.map +1 -0
- package/dist/rules/channel-resolution.js +382 -0
- package/dist/rules/channel-resolution.js.map +1 -0
- package/dist/rules/command-coverage.d.ts +210 -0
- package/dist/rules/command-coverage.d.ts.map +1 -0
- package/dist/rules/command-coverage.js +714 -0
- package/dist/rules/command-coverage.js.map +1 -0
- package/dist/rules/container-imports.d.ts +60 -0
- package/dist/rules/container-imports.d.ts.map +1 -0
- package/dist/rules/container-imports.js +158 -0
- package/dist/rules/container-imports.js.map +1 -0
- package/dist/rules/default-language-prose.d.ts +212 -0
- package/dist/rules/default-language-prose.d.ts.map +1 -0
- package/dist/rules/default-language-prose.js +710 -0
- package/dist/rules/default-language-prose.js.map +1 -0
- package/dist/rules/diacritic-folds.d.ts +238 -0
- package/dist/rules/diacritic-folds.d.ts.map +1 -0
- package/dist/rules/diacritic-folds.js +681 -0
- package/dist/rules/diacritic-folds.js.map +1 -0
- package/dist/rules/entity-tenant-classification.d.ts +171 -0
- package/dist/rules/entity-tenant-classification.d.ts.map +1 -0
- package/dist/rules/entity-tenant-classification.js +323 -0
- package/dist/rules/entity-tenant-classification.js.map +1 -0
- package/dist/rules/entry-presence.d.ts +142 -0
- package/dist/rules/entry-presence.d.ts.map +1 -0
- package/dist/rules/entry-presence.js +339 -0
- package/dist/rules/entry-presence.js.map +1 -0
- package/dist/rules/entry-scope.d.ts +91 -0
- package/dist/rules/entry-scope.d.ts.map +1 -0
- package/dist/rules/entry-scope.js +404 -0
- package/dist/rules/entry-scope.js.map +1 -0
- package/dist/rules/env-inputs.d.ts +222 -0
- package/dist/rules/env-inputs.d.ts.map +1 -0
- package/dist/rules/env-inputs.js +951 -0
- package/dist/rules/env-inputs.js.map +1 -0
- package/dist/rules/kernel-boundary.d.ts +37 -0
- package/dist/rules/kernel-boundary.d.ts.map +1 -0
- package/dist/rules/kernel-boundary.js +195 -0
- package/dist/rules/kernel-boundary.js.map +1 -0
- package/dist/rules/nul-bytes.d.ts +233 -0
- package/dist/rules/nul-bytes.d.ts.map +1 -0
- package/dist/rules/nul-bytes.js +332 -0
- package/dist/rules/nul-bytes.js.map +1 -0
- package/dist/rules/platform-surface.d.ts +479 -0
- package/dist/rules/platform-surface.d.ts.map +1 -0
- package/dist/rules/platform-surface.js +749 -0
- package/dist/rules/platform-surface.js.map +1 -0
- package/dist/rules/port-catches.d.ts +225 -0
- package/dist/rules/port-catches.d.ts.map +1 -0
- package/dist/rules/port-catches.js +1374 -0
- package/dist/rules/port-catches.js.map +1 -0
- package/dist/rules/port-shape.d.ts +213 -0
- package/dist/rules/port-shape.d.ts.map +1 -0
- package/dist/rules/port-shape.js +670 -0
- package/dist/rules/port-shape.js.map +1 -0
- package/dist/rules/queue-names.d.ts +108 -0
- package/dist/rules/queue-names.d.ts.map +1 -0
- package/dist/rules/queue-names.js +395 -0
- package/dist/rules/queue-names.js.map +1 -0
- package/dist/rules/singleton-identity.d.ts +205 -0
- package/dist/rules/singleton-identity.d.ts.map +1 -0
- package/dist/rules/singleton-identity.js +830 -0
- package/dist/rules/singleton-identity.js.map +1 -0
- package/dist/rules/subscribe-seam.d.ts +121 -0
- package/dist/rules/subscribe-seam.d.ts.map +1 -0
- package/dist/rules/subscribe-seam.js +594 -0
- package/dist/rules/subscribe-seam.js.map +1 -0
- package/dist/rules/transaction-context.d.ts +40 -0
- package/dist/rules/transaction-context.d.ts.map +1 -0
- package/dist/rules/transaction-context.js +294 -0
- package/dist/rules/transaction-context.js.map +1 -0
- package/package.json +59 -0
|
@@ -0,0 +1,473 @@
|
|
|
1
|
+
import { type WorkspaceMember } from './workspace-packages.js';
|
|
2
|
+
/**
|
|
3
|
+
* The directory under the site's content root that holds a module's pages.
|
|
4
|
+
*
|
|
5
|
+
* The one name this feature owns rather than derives. It is declared here so
|
|
6
|
+
* that the generator and the check cannot come to disagree about it, and so a
|
|
7
|
+
* reader looking for "where does `modules/` come from" finds one answer.
|
|
8
|
+
*/
|
|
9
|
+
export declare const MODULES_CATEGORY = "modules";
|
|
10
|
+
/** The page every reader of a module's category lands on. */
|
|
11
|
+
export declare const CATEGORY_INDEX = "index";
|
|
12
|
+
/**
|
|
13
|
+
* The generated sidebar fragment, at the site's root beside `sidebars.js`.
|
|
14
|
+
*
|
|
15
|
+
* Named here rather than in the generator so that the generator, `overlay:check`
|
|
16
|
+
* and `check:module-docs` cannot come to disagree about which file they mean.
|
|
17
|
+
*/
|
|
18
|
+
export declare const DOCS_SIDEBAR_ARTEFACT = "sidebars.modules.generated.js";
|
|
19
|
+
/** The generated module map, inside the modules category it indexes. */
|
|
20
|
+
export declare const MODULE_MAP_ARTEFACT = "module-map.generated.md";
|
|
21
|
+
/**
|
|
22
|
+
* The category holding one generated reference page per module (Phase 3,
|
|
23
|
+
* FR-022/FR-024).
|
|
24
|
+
*
|
|
25
|
+
* A category of its own, **outside** {@link MODULES_CATEGORY}, and the
|
|
26
|
+
* separation is the design rather than a filing preference. Three things follow
|
|
27
|
+
* from it, none of which would if the pages sat beside the prose:
|
|
28
|
+
*
|
|
29
|
+
* * **a generated page can never collide with a hand-written one.** A module's
|
|
30
|
+
* prose page is `modules/<slug>`, its reference page `module-reference/<slug>`.
|
|
31
|
+
* There is no name a page author can choose that takes an address the
|
|
32
|
+
* generator writes, and no rule anybody has to remember;
|
|
33
|
+
* * **the attribution walk's population does not move.** `undocumented-module`
|
|
34
|
+
* asks whether anybody *wrote* about a module, and a generated table is not
|
|
35
|
+
* an answer to it — a reference page inside the modules category would have
|
|
36
|
+
* made every registered module documented and retired that whole ledger in
|
|
37
|
+
* the merge request that added the generator;
|
|
38
|
+
* * **it is committed on ordinary terms.** `docs/docs/modules/**` is
|
|
39
|
+
* git-ignored, because the module-owned pages are copied there at build
|
|
40
|
+
* time, so a committed artefact under that tree would need `git add -f` for
|
|
41
|
+
* ever after.
|
|
42
|
+
*
|
|
43
|
+
* The pages are still *reached* from the Modules category: the generated
|
|
44
|
+
* sidebar fragment names each module's reference page beside its prose, so a
|
|
45
|
+
* reader never has to know that the two live in different directories.
|
|
46
|
+
*/
|
|
47
|
+
export declare const MODULE_REFERENCE_CATEGORY = "module-reference";
|
|
48
|
+
/**
|
|
49
|
+
* The documentation slug that names a module — {@link slugNamesModule}'s
|
|
50
|
+
* inverse, and the one place that choice is made.
|
|
51
|
+
*
|
|
52
|
+
* A slug is hyphenated where an id is snake_case, and a **leading underscore is
|
|
53
|
+
* dropped**: Docusaurus excludes an underscore-prefixed file from routing by
|
|
54
|
+
* design, so `_i18n` is documented at `i18n` and `_lifecycle` at `lifecycle`
|
|
55
|
+
* (D-200). Both transformations are {@link slugNamesModule}'s applied the other
|
|
56
|
+
* way round, so a page this names is a page that derivation attributes back —
|
|
57
|
+
* asserted as a round trip over every registered id rather than left to the two
|
|
58
|
+
* staying in step by inspection.
|
|
59
|
+
*/
|
|
60
|
+
export declare function slugForModule(moduleId: string): string;
|
|
61
|
+
/** Extensions Docusaurus reads as a documentation page. */
|
|
62
|
+
export declare const PAGE_EXTENSIONS: readonly string[];
|
|
63
|
+
/** Raised when the documentation layout cannot be resolved; a caller exits 2. */
|
|
64
|
+
export declare class DocsLayoutUnresolvableError extends Error {
|
|
65
|
+
readonly name = "DocsLayoutUnresolvableError";
|
|
66
|
+
}
|
|
67
|
+
/** Where the documentation site is and what it holds. */
|
|
68
|
+
export interface DocsLayout {
|
|
69
|
+
/** The workspace member that is the Docusaurus site. */
|
|
70
|
+
readonly member: WorkspaceMember;
|
|
71
|
+
/** Absolute path of the site's docs content root — `docs/docs`. */
|
|
72
|
+
readonly contentRoot: string;
|
|
73
|
+
/** Absolute path of `<contentRoot>/modules`. */
|
|
74
|
+
readonly modulesRoot: string;
|
|
75
|
+
/** Absolute path of the site's `sidebars.js`. */
|
|
76
|
+
readonly sidebarPath: string;
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* The docs content root the config declares, or Docusaurus's own default.
|
|
80
|
+
*
|
|
81
|
+
* Read as a literal `path:` inside the docs preset options. A computed value is
|
|
82
|
+
* not followed — it is reported as absent, which lands on the default, and the
|
|
83
|
+
* bound is stated here rather than discovered later.
|
|
84
|
+
*/
|
|
85
|
+
export declare function contentPathOf(configText: string): string;
|
|
86
|
+
/**
|
|
87
|
+
* Where the site is, from this repository's own workspace declaration.
|
|
88
|
+
*
|
|
89
|
+
* Zero members holding a Docusaurus config and more than one are both
|
|
90
|
+
* refusals, for `lib/module-roots.ts`' reason: an ambiguous root narrows the
|
|
91
|
+
* walk to whichever sorted first and says nothing about having done so.
|
|
92
|
+
*/
|
|
93
|
+
export declare function resolveDocsLayout(repoRoot: string): DocsLayout;
|
|
94
|
+
/** Docusaurus front matter, as much of it as this feature reads. */
|
|
95
|
+
export interface FrontMatter {
|
|
96
|
+
readonly title: string | null;
|
|
97
|
+
readonly sidebarLabel: string | null;
|
|
98
|
+
readonly sidebarPosition: number | null;
|
|
99
|
+
readonly description: string | null;
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* The leading `---`-delimited block, read as top-level `key: value` lines.
|
|
103
|
+
*
|
|
104
|
+
* Deliberately not a YAML parser: a direct dependency on one would be a new
|
|
105
|
+
* runtime edge in the package that runs the check estate (`plan.md` §
|
|
106
|
+
* Complexity Tracking), and the four fields this feature reads are scalars. The
|
|
107
|
+
* bound is that a nested or multi-line value is read as its first line, which is
|
|
108
|
+
* stated rather than discovered later.
|
|
109
|
+
*/
|
|
110
|
+
export declare function parseFrontMatter(source: string): FrontMatter;
|
|
111
|
+
/** One documentation page under the modules category. */
|
|
112
|
+
export interface DocPage {
|
|
113
|
+
/**
|
|
114
|
+
* The page's Docusaurus doc id — `modules/catalog/attributes`. The site's own
|
|
115
|
+
* identity for it, and what a sidebar entry names.
|
|
116
|
+
*/
|
|
117
|
+
readonly docId: string;
|
|
118
|
+
/** Absolute path of the file. */
|
|
119
|
+
readonly path: string;
|
|
120
|
+
/**
|
|
121
|
+
* The file's path relative to the modules category — `catalog/attributes.md`.
|
|
122
|
+
*
|
|
123
|
+
* Carried beside the doc id because a **link** and an **id** are not the same
|
|
124
|
+
* string: `assets-library/index` is the doc id and `/modules/assets-library/`
|
|
125
|
+
* is the route, so a markdown link written from the id 404s under
|
|
126
|
+
* `onBrokenLinks: 'throw'`. Docusaurus resolves a link that names the `.md`
|
|
127
|
+
* file to that file's permalink, whatever the permalink turns out to be, so
|
|
128
|
+
* the file path is the spelling that cannot go wrong.
|
|
129
|
+
*/
|
|
130
|
+
readonly relativePath: string;
|
|
131
|
+
/**
|
|
132
|
+
* The module slug this page sits under: its own basename for a top-level
|
|
133
|
+
* page, its directory's name for a page inside one.
|
|
134
|
+
*/
|
|
135
|
+
readonly slug: string;
|
|
136
|
+
/** True when the page is the one a reader of this slug lands on. */
|
|
137
|
+
readonly isEntry: boolean;
|
|
138
|
+
/** True when the page sits inside a directory of its own slug's name. */
|
|
139
|
+
readonly inDirectory: boolean;
|
|
140
|
+
readonly frontMatter: FrontMatter;
|
|
141
|
+
/** Which tree the walk found it in — see {@link DocPageOrigin}. */
|
|
142
|
+
readonly origin: DocPageOrigin;
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
* A module's own position in the Modules category, or `null` for alphabetical.
|
|
146
|
+
*
|
|
147
|
+
* Read from the entry page's `sidebar_position` **only when that page is not a
|
|
148
|
+
* directory index**, and the distinction is Docusaurus's own rather than this
|
|
149
|
+
* feature's: `sidebar_position` orders a page among its *siblings*, so an
|
|
150
|
+
* `index.md`'s is its place inside its own directory and says nothing about
|
|
151
|
+
* where its module belongs among 65 others. Every such value in the tree today
|
|
152
|
+
* is `1` — an intra-directory ordering that has been inert under a manual
|
|
153
|
+
* sidebar — and reading it would have hoisted five modules to the top of the
|
|
154
|
+
* category for a reason nobody wrote.
|
|
155
|
+
*/
|
|
156
|
+
export declare function categoryPositionOf(entry: DocPage): number | null;
|
|
157
|
+
/**
|
|
158
|
+
* Where a page came from, which is not the same question as which module it
|
|
159
|
+
* documents.
|
|
160
|
+
*
|
|
161
|
+
* `'site'` is a page in the documentation site's own tree — the state every
|
|
162
|
+
* page was in through Phase 1 and the state `_lifecycle`'s page is still in,
|
|
163
|
+
* because its manifest resolves inside the platform package's **build output**
|
|
164
|
+
* and documentation is not a compiled asset (`scripts/lib/runtime-assets.mjs`).
|
|
165
|
+
* `'module'` is a page a module ships in its own `docs/` layer.
|
|
166
|
+
*
|
|
167
|
+
* Attribution is the *slug's* answer and stays so; this is the *shipper's*.
|
|
168
|
+
* They are kept apart because they can disagree, and a module publishing under
|
|
169
|
+
* a sibling's slug is a finding rather than a silent re-attribution.
|
|
170
|
+
*/
|
|
171
|
+
export interface DocPageOrigin {
|
|
172
|
+
readonly kind: 'site' | 'module';
|
|
173
|
+
/** The module that ships the page, or `null` for a page in the site's tree. */
|
|
174
|
+
readonly moduleId: string | null;
|
|
175
|
+
/** The directory the walk that produced the page was rooted at. */
|
|
176
|
+
readonly root: string;
|
|
177
|
+
}
|
|
178
|
+
/** A module's own documentation layer, resolved. */
|
|
179
|
+
export interface ModuleDocsSource {
|
|
180
|
+
readonly moduleId: string;
|
|
181
|
+
/** Absolute path of `dirname(manifestPath)/<docs.dir>`. */
|
|
182
|
+
readonly root: string;
|
|
183
|
+
}
|
|
184
|
+
/**
|
|
185
|
+
* Every page one fragment of the modules category holds, sorted by doc id.
|
|
186
|
+
*
|
|
187
|
+
* The **fragment** is the unit, and that is the mechanism rather than an
|
|
188
|
+
* implementation detail: a module's `docs/` directory is its own fragment of
|
|
189
|
+
* this category, laid out exactly as the category lays it out, so one walk
|
|
190
|
+
* reads the site's tree and a module's alike and the two produce identical doc
|
|
191
|
+
* ids for the same page. It is what makes the Phase 2 move invisible — no URL
|
|
192
|
+
* changes, no doc id changes, and no ledger key keyed on `(module id, page
|
|
193
|
+
* slug)` goes stale (`contracts/docs-registry.md` R4.1).
|
|
194
|
+
*
|
|
195
|
+
* It also lets a module own **more than one slug** (`organizations` ships both
|
|
196
|
+
* `organizations.md` and `organization-hierarchy.md`) and publish under a slug
|
|
197
|
+
* that is not its id (`_i18n` ships `admin-i18n.md`), neither of which a
|
|
198
|
+
* one-directory-per-module rule can express without renaming a public URL —
|
|
199
|
+
* which is `spec.md` Q2 and nobody's to decide here.
|
|
200
|
+
*/
|
|
201
|
+
export declare function collectPagesUnder(root: string, origin: DocPageOrigin): DocPage[];
|
|
202
|
+
/**
|
|
203
|
+
* Every page the site's own tree holds, sorted by doc id.
|
|
204
|
+
*
|
|
205
|
+
* `copies` is the set of absolute paths the collection step writes into this
|
|
206
|
+
* tree, and it is excluded rather than judged. The copies are **not committed**
|
|
207
|
+
* — one editable page and one that looks editable and is not is the state this
|
|
208
|
+
* feature exists to end — but a developer who has run the docs build has them
|
|
209
|
+
* on disk, and a walk that counted them would report every module's page as
|
|
210
|
+
* claimed by two sources: a finding about the copy step dressed as one about
|
|
211
|
+
* the tree.
|
|
212
|
+
*
|
|
213
|
+
* Passing an empty set is the fresh-checkout state and reads the tree as it is.
|
|
214
|
+
*/
|
|
215
|
+
export declare function collectDocPages(modulesRoot: string, copies?: ReadonlySet<string>): DocPage[];
|
|
216
|
+
/** Every page the modules ship, sorted by doc id. */
|
|
217
|
+
export declare function collectModuleDocPages(sources: readonly ModuleDocsSource[]): DocPage[];
|
|
218
|
+
/**
|
|
219
|
+
* Two pages claiming one doc id — the site's tree and a module's, or two
|
|
220
|
+
* modules'.
|
|
221
|
+
*
|
|
222
|
+
* A **mixed** tree is the supported state (`plan.md` § Phasing: the check
|
|
223
|
+
* accepts a page in the site tree and a page in a package on the same terms),
|
|
224
|
+
* so a batch that has moved half the pages is not a defect. Two sources for one
|
|
225
|
+
* id is, and it is not a silent one: the copy would write one over the other
|
|
226
|
+
* and whichever ran second would win, which is a build whose output depends on
|
|
227
|
+
* a directory read order.
|
|
228
|
+
*/
|
|
229
|
+
export declare function duplicateDocIds(pages: readonly DocPage[]): {
|
|
230
|
+
docId: string;
|
|
231
|
+
paths: string[];
|
|
232
|
+
}[];
|
|
233
|
+
/**
|
|
234
|
+
* Does this slug name this module? — **D-200**, and the one place the rule
|
|
235
|
+
* lives.
|
|
236
|
+
*
|
|
237
|
+
* Two steps, and both are derivations rather than a table:
|
|
238
|
+
*
|
|
239
|
+
* * a URL segment is conventionally hyphenated and a module id is
|
|
240
|
+
* snake_case, so one is folded into the other;
|
|
241
|
+
* * a **leading underscore is stripped**, because an infrastructure module's
|
|
242
|
+
* id carries one and a documentation page's file name may not:
|
|
243
|
+
* **Docusaurus excludes an underscore-prefixed file from routing by
|
|
244
|
+
* design** — it becomes a *partial* for import into another page, generates
|
|
245
|
+
* no route, and cannot be found from `sidebars.js` at all. So `_i18n` is
|
|
246
|
+
* documented at `i18n` and `_lifecycle` at `lifecycle`.
|
|
247
|
+
*
|
|
248
|
+
* The underscore stays where it means something — in the module id, where
|
|
249
|
+
* `check:naming` enforces the convention — instead of leaking into a public URL.
|
|
250
|
+
* The rule covers every future infrastructure module with nothing to add, which
|
|
251
|
+
* is what retired the alias table Phase 1 shipped: a four-entry table of
|
|
252
|
+
* hand-declared attributions, in the feature whose whole subject is that three
|
|
253
|
+
* hand-maintained lists disagreed with one population and with each other.
|
|
254
|
+
*
|
|
255
|
+
* It is not a heuristic that guesses. Only these two transformations are
|
|
256
|
+
* applied, and the result must equal a registered id exactly.
|
|
257
|
+
*/
|
|
258
|
+
export declare function slugNamesModule(slug: string, moduleId: string): boolean;
|
|
259
|
+
/**
|
|
260
|
+
* The module a slug names, or `null`, over the registered set.
|
|
261
|
+
*
|
|
262
|
+
* {@link slugNamesModule} in the direction a walk needs it: the candidates are
|
|
263
|
+
* derived from the slug rather than by scanning every registered id, so the
|
|
264
|
+
* cost does not grow with the platform.
|
|
265
|
+
*/
|
|
266
|
+
export declare function moduleOfSlug(slug: string, registered: ReadonlySet<string>): string | null;
|
|
267
|
+
/** One module's documentation, as the site holds it today. */
|
|
268
|
+
export interface ModuleDocs {
|
|
269
|
+
readonly moduleId: string;
|
|
270
|
+
/** The slug its pages sit under. */
|
|
271
|
+
readonly slug: string;
|
|
272
|
+
/** The page a reader lands on. */
|
|
273
|
+
readonly entry: DocPage;
|
|
274
|
+
/** Sub-pages, sorted by their own position then label. */
|
|
275
|
+
readonly children: readonly DocPage[];
|
|
276
|
+
}
|
|
277
|
+
/** The label a navigation entry carries, from the page's own front matter. */
|
|
278
|
+
export declare function labelOf(page: DocPage, fallback: string): string;
|
|
279
|
+
/** Ordering: a declared `sidebar_position` first, then alphabetical by label. */
|
|
280
|
+
export declare function comparePages(a: {
|
|
281
|
+
position: number | null;
|
|
282
|
+
label: string;
|
|
283
|
+
}, b: {
|
|
284
|
+
position: number | null;
|
|
285
|
+
label: string;
|
|
286
|
+
}): number;
|
|
287
|
+
/** What the walk produced, split into what it could place and what it could not. */
|
|
288
|
+
export interface DocsAttribution {
|
|
289
|
+
/** One entry per module that has documentation, sorted by module id. */
|
|
290
|
+
readonly documented: readonly ModuleDocs[];
|
|
291
|
+
/** Registered modules no page documents, sorted. */
|
|
292
|
+
readonly undocumented: readonly string[];
|
|
293
|
+
/**
|
|
294
|
+
* Pages with no shipper whose slug names no registered module.
|
|
295
|
+
*
|
|
296
|
+
* A page in the **site's own tree** only. A page a module ships has a
|
|
297
|
+
* shipper, so it is attributed whatever its slug says; where its slug names a
|
|
298
|
+
* *different* module that is {@link DocsAttribution.misowned}, and where it
|
|
299
|
+
* names none it is simply a second slug that module owns.
|
|
300
|
+
*/
|
|
301
|
+
readonly unlocated: readonly DocPage[];
|
|
302
|
+
/**
|
|
303
|
+
* Pages a module ships under a **different** registered module's slug.
|
|
304
|
+
*
|
|
305
|
+
* Shipper and subject are two questions (see {@link DocPageOrigin}) and this
|
|
306
|
+
* is the state where they disagree. It is Constitution I applied to prose,
|
|
307
|
+
* and the same shape `check:admin-zones` refuses as `foreign-module-id`: a
|
|
308
|
+
* module publishing under a sibling's slug takes an address the sibling owns,
|
|
309
|
+
* and if the sibling ever ships that page too the copy step has two sources
|
|
310
|
+
* for one target. The page stays attributed to its **shipper** — the module's
|
|
311
|
+
* own declaration outranks a derivation from a file name — and the
|
|
312
|
+
* disagreement is reported rather than resolved.
|
|
313
|
+
*/
|
|
314
|
+
readonly misowned: readonly {
|
|
315
|
+
page: DocPage;
|
|
316
|
+
namesModule: string;
|
|
317
|
+
}[];
|
|
318
|
+
/**
|
|
319
|
+
* Pages Docusaurus will not route: a path segment beginning with `_`.
|
|
320
|
+
*
|
|
321
|
+
* An underscore-prefixed file is a **partial** by design — intended for
|
|
322
|
+
* import into another page, generating no route, and unfindable from
|
|
323
|
+
* `sidebars.js`. D-200 is what keeps a module id's leading underscore out of
|
|
324
|
+
* its slug; this is the refusal that makes the rule hold for a page nobody
|
|
325
|
+
* ran that derivation over.
|
|
326
|
+
*/
|
|
327
|
+
readonly unroutable: readonly DocPage[];
|
|
328
|
+
/** Every page the walk opened. */
|
|
329
|
+
readonly pages: readonly DocPage[];
|
|
330
|
+
}
|
|
331
|
+
/**
|
|
332
|
+
* Place every page against the registered module set.
|
|
333
|
+
*
|
|
334
|
+
* Pure over the two inputs, so a red proof enters where a real run enters
|
|
335
|
+
* (issue #130): the pages a walk produced and the ids the index registers.
|
|
336
|
+
*/
|
|
337
|
+
export declare function attributeDocs(pages: readonly DocPage[], registered: readonly string[]): DocsAttribution;
|
|
338
|
+
/**
|
|
339
|
+
* Where a module ships its own documentation, or `null` when it declares none.
|
|
340
|
+
*
|
|
341
|
+
* The anchor is `dirname(manifestPath)` — the same one the `_i18n` boot
|
|
342
|
+
* reconciler joins `bundlesDir` to, which `resolveManifestPath` already makes
|
|
343
|
+
* correct for a core-relative module, a workspace package and an installed
|
|
344
|
+
* package alike (`contracts/module-documentation-layer.md` R2.2). Nothing in a
|
|
345
|
+
* module names a package, a repository root or a build directory to find its own
|
|
346
|
+
* pages; the platform supplies the anchor.
|
|
347
|
+
*
|
|
348
|
+
* `false` and absent are **not** the same state and this returns the same
|
|
349
|
+
* `null` for both deliberately: the distinction is the *manifest's*, and the
|
|
350
|
+
* consumer that needs it (`undocumented-module`) reads the declaration itself.
|
|
351
|
+
*/
|
|
352
|
+
export declare function declaredDocsDirectory(manifestPath: string, declaration: {
|
|
353
|
+
dir: string;
|
|
354
|
+
} | false | undefined): string | null;
|
|
355
|
+
/** True when `path` is a directory that exists. */
|
|
356
|
+
export declare function isDirectory(path: string): boolean;
|
|
357
|
+
/** Raised when a module declares a documentation directory that is not there. */
|
|
358
|
+
export declare class DeclaredDocsDirectoryMissingError extends Error {
|
|
359
|
+
readonly name = "DeclaredDocsDirectoryMissingError";
|
|
360
|
+
}
|
|
361
|
+
/** One module, as a caller of {@link moduleDocsSources} describes it. */
|
|
362
|
+
export interface ModuleDocsDeclarant {
|
|
363
|
+
readonly moduleId: string;
|
|
364
|
+
/** The module's entry in the generated manifest index. */
|
|
365
|
+
readonly manifestPath: string;
|
|
366
|
+
/** What the manifest declares — `{ dir }`, `false`, or absent. */
|
|
367
|
+
readonly declaration: {
|
|
368
|
+
dir: string;
|
|
369
|
+
} | false | undefined;
|
|
370
|
+
}
|
|
371
|
+
/**
|
|
372
|
+
* Where every module that declares documentation keeps it.
|
|
373
|
+
*
|
|
374
|
+
* **A declared directory that is not on disk is a refusal, naming the module**
|
|
375
|
+
* (FR-017, `module-documentation-layer.md` R2.4). It must not read as "this
|
|
376
|
+
* module ships no documentation", and the reason is a measured one rather than
|
|
377
|
+
* a stylistic preference: `backend/src/manifest-locations.ts`' header records
|
|
378
|
+
* that the `_i18n` boot reconciler *logs and skips* an absent bundles
|
|
379
|
+
* directory, so a packaged module would have rendered every command-palette
|
|
380
|
+
* entry as its raw i18n key with no error anywhere. The distinction between
|
|
381
|
+
* *declared and absent* and *not declared* is the whole of that repair.
|
|
382
|
+
*/
|
|
383
|
+
export declare function moduleDocsSources(modules: readonly ModuleDocsDeclarant[]): readonly ModuleDocsSource[];
|
|
384
|
+
/**
|
|
385
|
+
* Where the site keeps the copy of a page a module ships.
|
|
386
|
+
*
|
|
387
|
+
* The module's fragment lands at the same relative path inside the category, so
|
|
388
|
+
* the copy preserves the page's doc id, its permalink and every relative link
|
|
389
|
+
* written against it (`module-documentation-layer.md` R5.2).
|
|
390
|
+
*/
|
|
391
|
+
export declare function copyTargetOf(page: DocPage, modulesRoot: string): string;
|
|
392
|
+
/** One relative markdown link, as written. */
|
|
393
|
+
export interface RelativeLink {
|
|
394
|
+
/** The target exactly as the page spells it — `./payments.md`, `../catalog.md`. */
|
|
395
|
+
readonly target: string;
|
|
396
|
+
/** The doc id the target resolves to, or `null` when it leaves the category. */
|
|
397
|
+
readonly docId: string | null;
|
|
398
|
+
/**
|
|
399
|
+
* The target climbs **above** the modules category — `../architecture/…`
|
|
400
|
+
* written on a page sitting at the category root.
|
|
401
|
+
*
|
|
402
|
+
* `docId === null` alone does not say this, and the difference is a finding.
|
|
403
|
+
* Two states arrive at a null doc id: a link that **leaves** the category,
|
|
404
|
+
* which names a page only the host repository's own site tree has and which
|
|
405
|
+
* no reader's instance can resolve whatever module set they installed; and a
|
|
406
|
+
* link that resolves to the category **root** itself, which every instance
|
|
407
|
+
* has because the generator writes it. Collapsing the two would let a
|
|
408
|
+
* consumer report the second as the first, so the resolution says what it saw
|
|
409
|
+
* rather than leaving a reader to infer it from an absence.
|
|
410
|
+
*/
|
|
411
|
+
readonly leavesCategory: boolean;
|
|
412
|
+
}
|
|
413
|
+
/**
|
|
414
|
+
* Every relative markdown link a page writes, resolved to a doc id.
|
|
415
|
+
*
|
|
416
|
+
* Read as `](…)` with a `./` or `../` prefix, in the literal-text discipline
|
|
417
|
+
* the rest of the estate uses. The bounds are stated here rather than
|
|
418
|
+
* discovered later (`docs-registry.md` R3.10): a link built by an MDX
|
|
419
|
+
* expression or a component is invisible, a raw `<a href>` is invisible, and a
|
|
420
|
+
* `@site/`-prefixed absolute link is not a relative sibling link and is outside
|
|
421
|
+
* the population by construction.
|
|
422
|
+
*
|
|
423
|
+
* An anchor or a query is stripped, and a target that resolves outside the
|
|
424
|
+
* modules category resolves to `null` — a link into `../operations/runbooks/…`
|
|
425
|
+
* is a link to the site, not to a sibling module. Such a link carries
|
|
426
|
+
* `leavesCategory: true`, which is what lets a consumer tell it apart from a
|
|
427
|
+
* link to the category root; see {@link RelativeLink}.
|
|
428
|
+
*/
|
|
429
|
+
export declare function relativeLinksIn(page: DocPage, source: string): RelativeLink[];
|
|
430
|
+
/**
|
|
431
|
+
* What a manifest's **source text** declares for `docs`.
|
|
432
|
+
*
|
|
433
|
+
* The generator reads the tree and the check reads the emitted manifest, so the
|
|
434
|
+
* two answer this question from two different artefacts — which is the estate's
|
|
435
|
+
* independent-author pattern rather than a duplication: a generator that
|
|
436
|
+
* imported the index it is about to render would be reading its own previous
|
|
437
|
+
* answer.
|
|
438
|
+
*
|
|
439
|
+
* `'unreadable'` is a **finding and never a skip** (issue #113). A computed
|
|
440
|
+
* `dir` is a directory this walk cannot place, and treating it as "declares
|
|
441
|
+
* nothing" is the direction that agrees with the defect — the module's pages
|
|
442
|
+
* would simply not be collected, with no error anywhere, which is the failure
|
|
443
|
+
* `manifest-locations.ts` was written to end.
|
|
444
|
+
*/
|
|
445
|
+
export declare function docsDeclarationIn(source: string): {
|
|
446
|
+
dir: string;
|
|
447
|
+
} | false | undefined | 'unreadable';
|
|
448
|
+
/**
|
|
449
|
+
* The `docs` declaration of every module the generated index registers.
|
|
450
|
+
*
|
|
451
|
+
* The index is **imported**, because a module package resolves through its own
|
|
452
|
+
* `exports` map at its build output and the declaration a running platform sees
|
|
453
|
+
* is the emitted one. Every reader that needs "where does each module keep its
|
|
454
|
+
* pages" starts here, so the population is derived once: two walks over one
|
|
455
|
+
* population are two answers waiting to disagree, which is the state this whole
|
|
456
|
+
* feature ends.
|
|
457
|
+
*/
|
|
458
|
+
export declare function moduleDocsDeclarantsFrom(manifestIndexPath: string): Promise<ModuleDocsDeclarant[]>;
|
|
459
|
+
/**
|
|
460
|
+
* Every page a module owns, and where the site keeps its copy.
|
|
461
|
+
*
|
|
462
|
+
* `copies` is the set every walk over the site's tree has to leave alone: the
|
|
463
|
+
* copies are not committed, so a fresh checkout has none and a developer who
|
|
464
|
+
* has run the site build has all of them — and a population that counted them
|
|
465
|
+
* would be a different size on the two machines.
|
|
466
|
+
*/
|
|
467
|
+
export declare function resolveModuleDocs(repoRoot: string, manifestIndexPath: string): Promise<{
|
|
468
|
+
readonly docs: DocsLayout;
|
|
469
|
+
readonly sources: readonly ModuleDocsSource[];
|
|
470
|
+
readonly modulePages: readonly DocPage[];
|
|
471
|
+
readonly copies: ReadonlySet<string>;
|
|
472
|
+
}>;
|
|
473
|
+
//# sourceMappingURL=module-docs.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"module-docs.d.ts","sourceRoot":"","sources":["../../src/lib/module-docs.ts"],"names":[],"mappings":"AAyEA,OAAO,EAAqC,KAAK,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAElG;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,YAAY,CAAC;AAE1C,6DAA6D;AAC7D,eAAO,MAAM,cAAc,UAAU,CAAC;AAEtC;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,kCAAkC,CAAC;AAErE,wEAAwE;AACxE,eAAO,MAAM,mBAAmB,4BAA4B,CAAC;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,yBAAyB,qBAAqB,CAAC;AAE5D;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEtD;AAED,2DAA2D;AAC3D,eAAO,MAAM,eAAe,EAAE,SAAS,MAAM,EAAoB,CAAC;AAElE,iFAAiF;AACjF,qBAAa,2BAA4B,SAAQ,KAAK;IACpD,SAAkB,IAAI,iCAAiC;CACxD;AAED,yDAAyD;AACzD,MAAM,WAAW,UAAU;IACzB,wDAAwD;IACxD,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAC;IACjC,mEAAmE;IACnE,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,gDAAgD;IAChD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,iDAAiD;IACjD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAUD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAGxD;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,UAAU,CAgC9D;AAED,oEAAoE;AACpE,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CACrC;AAqBD;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,WAAW,CAqB5D;AAED,yDAAyD;AACzD,MAAM,WAAW,OAAO;IACtB;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,iCAAiC;IACjC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;;;;;;;OASG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,oEAAoE;IACpE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,yEAAyE;IACzE,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAC9B,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,mEAAmE;IACnE,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC;CAChC;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,CAEhE;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IACjC,+EAA+E;IAC/E,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,mEAAmE;IACnE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,oDAAoD;AACpD,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,2DAA2D;IAC3D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,GAAG,OAAO,EAAE,CAkDhF;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,eAAe,CAC7B,WAAW,EAAE,MAAM,EACnB,MAAM,GAAE,WAAW,CAAC,MAAM,CAAa,GACtC,OAAO,EAAE,CAMX;AAED,qDAAqD;AACrD,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,SAAS,gBAAgB,EAAE,GAAG,OAAO,EAAE,CAUrF;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,SAAS,OAAO,EAAE,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CAAE,EAAE,CAW/F;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAGvE;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,GAAG,IAAI,CAKzF;AAED,8DAA8D;AAC9D,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,oCAAoC;IACpC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,kCAAkC;IAClC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,0DAA0D;IAC1D,QAAQ,CAAC,QAAQ,EAAE,SAAS,OAAO,EAAE,CAAC;CACvC;AAED,8EAA8E;AAC9E,wBAAgB,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAE/D;AAED,iFAAiF;AACjF,wBAAgB,YAAY,CAC1B,CAAC,EAAE;IAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,EAC7C,CAAC,EAAE;IAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAC5C,MAAM,CAOR;AAED,oFAAoF;AACpF,MAAM,WAAW,eAAe;IAC9B,wEAAwE;IACxE,QAAQ,CAAC,UAAU,EAAE,SAAS,UAAU,EAAE,CAAC;IAC3C,oDAAoD;IACpD,QAAQ,CAAC,YAAY,EAAE,SAAS,MAAM,EAAE,CAAC;IACzC;;;;;;;OAOG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,OAAO,EAAE,CAAC;IACvC;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,QAAQ,EAAE,SAAS;QAAE,IAAI,EAAE,OAAO,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACrE;;;;;;;;OAQG;IACH,QAAQ,CAAC,UAAU,EAAE,SAAS,OAAO,EAAE,CAAC;IACxC,kCAAkC;IAClC,QAAQ,CAAC,KAAK,EAAE,SAAS,OAAO,EAAE,CAAC;CACpC;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAC3B,KAAK,EAAE,SAAS,OAAO,EAAE,EACzB,UAAU,EAAE,SAAS,MAAM,EAAE,GAC5B,eAAe,CAsEjB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,qBAAqB,CACnC,YAAY,EAAE,MAAM,EACpB,WAAW,EAAE;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,GAAG,KAAK,GAAG,SAAS,GAC/C,MAAM,GAAG,IAAI,CAGf;AAED,mDAAmD;AACnD,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAMjD;AAED,iFAAiF;AACjF,qBAAa,iCAAkC,SAAQ,KAAK;IAC1D,SAAkB,IAAI,uCAAuC;CAC9D;AAED,yEAAyE;AACzE,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,0DAA0D;IAC1D,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,kEAAkE;IAClE,QAAQ,CAAC,WAAW,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,KAAK,GAAG,SAAS,CAAC;CAC3D;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE,SAAS,mBAAmB,EAAE,GACtC,SAAS,gBAAgB,EAAE,CAqB7B;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAEvE;AAED,8CAA8C;AAC9C,MAAM,WAAW,YAAY;IAC3B,mFAAmF;IACnF,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,gFAAgF;IAChF,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC;CAClC;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,YAAY,EAAE,CAqC7E;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,GAAG,KAAK,GAAG,SAAS,GAAG,YAAY,CAOpG;AAED;;;;;;;;;GASG;AACH,wBAAsB,wBAAwB,CAC5C,iBAAiB,EAAE,MAAM,GACxB,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAkBhC;AAED;;;;;;;GAOG;AACH,wBAAsB,iBAAiB,CACrC,QAAQ,EAAE,MAAM,EAChB,iBAAiB,EAAE,MAAM,GACxB,OAAO,CAAC;IACT,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,SAAS,gBAAgB,EAAE,CAAC;IAC9C,QAAQ,CAAC,WAAW,EAAE,SAAS,OAAO,EAAE,CAAC;IACzC,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;CACtC,CAAC,CAUD"}
|