@ng-doc/builder 22.0.0-beta.2 → 22.1.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/README.md +19 -28
- package/application/index.js +2 -2
- package/application/index.js.map +1 -1
- package/application/schema.json +1 -2
- package/builders.json +23 -13
- package/classes/observable-map.d.ts +1 -0
- package/classes/observable-map.js +14 -3
- package/classes/observable-map.js.map +1 -1
- package/classes/observable-set.js +2 -1
- package/classes/observable-set.js.map +1 -1
- package/dev-server/index.js +5 -3
- package/dev-server/index.js.map +1 -1
- package/engine/builders/api-list/api-list-component.builder.js +4 -4
- package/engine/builders/api-list/api-list-component.builder.js.map +1 -1
- package/engine/builders/api-list/api-page-template.builder.js +2 -2
- package/engine/builders/api-list/api-page-template.builder.js.map +1 -1
- package/engine/builders/global/keywords.builder.d.ts +1 -4
- package/engine/builders/global/keywords.builder.js +5 -9
- package/engine/builders/global/keywords.builder.js.map +1 -1
- package/engine/builders/global/search-indexes.builder.js +1 -1
- package/engine/builders/global/search-indexes.builder.js.map +1 -1
- package/engine/builders/helpers/create-entry-metadata.js +2 -1
- package/engine/builders/helpers/create-entry-metadata.js.map +1 -1
- package/engine/builders/helpers/create-import-path.js.map +1 -1
- package/engine/builders/helpers/get-entry-relative-path.js.map +1 -1
- package/engine/builders/helpers/get-playground-metadata.js +7 -1
- package/engine/builders/helpers/get-playground-metadata.js.map +1 -1
- package/engine/builders/page/demo-assets.builder.js +10 -5
- package/engine/builders/page/demo-assets.builder.js.map +1 -1
- package/engine/builders/page/playground.builder.js +1 -0
- package/engine/builders/page/playground.builder.js.map +1 -1
- package/engine/builders/shared/content.builder.js +5 -3
- package/engine/builders/shared/content.builder.js.map +1 -1
- package/engine/builders/shared/page-component.builder.js +16 -6
- package/engine/builders/shared/page-component.builder.js.map +1 -1
- package/engine/builders/shared/page-wrapper.builder.js +10 -5
- package/engine/builders/shared/page-wrapper.builder.js.map +1 -1
- package/engine/core/operators/distinct-pending.js.map +1 -1
- package/engine/core/operators/factory.js +1 -4
- package/engine/core/operators/factory.js.map +1 -1
- package/engine/core/operators/merge-factory.js +19 -17
- package/engine/core/operators/merge-factory.js.map +1 -1
- package/engine/core/operators/when-builders-done.js.map +1 -1
- package/engine/core/triggers/on-dependencies-change.d.ts +1 -1
- package/engine/core/triggers/on-dependencies-change.js +2 -2
- package/engine/core/triggers/on-dependencies-change.js.map +1 -1
- package/generator/artifacts/index.d.ts +317 -0
- package/generator/bootstrap/bin.d.ts +18 -0
- package/generator/bootstrap/bin.js +7298 -0
- package/generator/bootstrap/candidate-output-committer.d.ts +12 -0
- package/generator/bootstrap/cli.d.ts +42 -0
- package/generator/bootstrap/cli.js +7147 -0
- package/generator/bootstrap/constants.d.ts +4 -0
- package/generator/bootstrap/index.d.ts +111 -0
- package/generator/bootstrap/index.js +5034 -0
- package/generator/bootstrap/prerender-command.d.ts +31 -0
- package/generator/bootstrap/process-tree.d.ts +49 -0
- package/generator/build-metafile.json +12009 -0
- package/generator/build-provenance.json +121 -0
- package/generator/compiler/assemble.d.ts +41 -0
- package/generator/compiler/classify.d.ts +161 -0
- package/generator/compiler/closure-store.d.ts +55 -0
- package/generator/compiler/common.d.ts +32 -0
- package/generator/compiler/describe.d.ts +21 -0
- package/generator/compiler/dry-run.d.ts +108 -0
- package/generator/compiler/fast-start.d.ts +104 -0
- package/generator/compiler/fold.d.ts +116 -0
- package/generator/compiler/index.d.ts +131 -0
- package/generator/compiler/index.js +19009 -0
- package/generator/compiler/link.d.ts +38 -0
- package/generator/compiler/memo.d.ts +44 -0
- package/generator/compiler/plan.d.ts +116 -0
- package/generator/compiler/progress.d.ts +54 -0
- package/generator/compiler/render.d.ts +27 -0
- package/generator/compiler/retention.d.ts +181 -0
- package/generator/compiler/semantic-closure.d.ts +46 -0
- package/generator/compiler/targeted.d.ts +280 -0
- package/generator/content/code-snippet.d.ts +20 -0
- package/generator/content/content-compiler.d.ts +122 -0
- package/generator/content/format-cache.d.ts +108 -0
- package/generator/content/highlight-cache.d.ts +115 -0
- package/generator/content/html-pipeline.d.ts +179 -0
- package/generator/content/html-pool.d.ts +245 -0
- package/generator/content/html-worker.js +2181 -0
- package/generator/content-module-ids.d.ts +8 -0
- package/generator/contracts.d.ts +1102 -0
- package/generator/contracts.js +15 -0
- package/generator/discovery/index.d.ts +79 -0
- package/generator/graph/index.d.ts +211 -0
- package/generator/graph/unit-index.d.ts +216 -0
- package/generator/kernel/canonical.d.ts +57 -0
- package/generator/kernel/flags.d.ts +51 -0
- package/generator/kernel/footprint.d.ts +88 -0
- package/generator/kernel/observations.d.ts +68 -0
- package/generator/kernel/paths.d.ts +22 -0
- package/generator/kernel/runtime-identity.d.ts +11 -0
- package/generator/outputs/index.d.ts +80 -0
- package/generator/package.json +3 -0
- package/generator/progress/ci.d.ts +22 -0
- package/generator/progress/detect.d.ts +60 -0
- package/generator/progress/events.d.ts +126 -0
- package/generator/progress/format.d.ts +83 -0
- package/generator/progress/gate.d.ts +49 -0
- package/generator/progress/host.d.ts +29 -0
- package/generator/progress/lines.d.ts +42 -0
- package/generator/progress/live.d.ts +115 -0
- package/generator/progress/model.d.ts +85 -0
- package/generator/progress/reporter.d.ts +87 -0
- package/generator/progress/settings.d.ts +60 -0
- package/generator/semantic/angular.d.ts +29 -0
- package/generator/semantic/api-enumeration.d.ts +19 -0
- package/generator/semantic/api-summary.d.ts +33 -0
- package/generator/semantic/dependencies.d.ts +20 -0
- package/generator/semantic/derived-classes.d.ts +58 -0
- package/generator/semantic/documentation-cache.d.ts +23 -0
- package/generator/semantic/formatting.d.ts +27 -0
- package/generator/semantic/fragments.d.ts +37 -0
- package/generator/semantic/owned-roots.d.ts +59 -0
- package/generator/semantic/program-builder.d.ts +55 -0
- package/generator/semantic/program-index.d.ts +124 -0
- package/generator/semantic/program-inputs.d.ts +26 -0
- package/generator/semantic/program-observations.d.ts +158 -0
- package/generator/semantic/program-retention.d.ts +147 -0
- package/generator/semantic/program-state.d.ts +196 -0
- package/generator/semantic/program-verify.d.ts +22 -0
- package/generator/semantic/recorder.d.ts +89 -0
- package/generator/semantic/rendering.d.ts +34 -0
- package/generator/semantic/semantic-closure.d.ts +129 -0
- package/generator/semantic/semantic-service.d.ts +186 -0
- package/generator/semantic/type-text.d.ts +5 -0
- package/generator/session/build-session.d.ts +206 -0
- package/generator/session/input-verification.d.ts +38 -0
- package/generator/session/parcel-event-source.d.ts +22 -0
- package/generator/session/progress.d.ts +72 -0
- package/generator/session/unchanged-saves.d.ts +63 -0
- package/generator/session/watch-inputs.d.ts +6 -0
- package/generator/session/watch-signals.d.ts +10 -0
- package/generator/templates/api/base.html.nunj +26 -0
- package/generator/templates/api/class-declaration.html.nunj +59 -0
- package/generator/templates/api/details/class-declaration.html.nunj +47 -0
- package/generator/templates/api/details/enum-declaration.html.nunj +0 -0
- package/generator/templates/api/details/function-declaration.html.nunj +14 -0
- package/generator/templates/api/details/helpers/decorators.html.nunj +14 -0
- package/generator/templates/api/details/helpers/extends.html.nunj +6 -0
- package/generator/templates/api/details/helpers/selectors.html.nunj +12 -0
- package/generator/templates/api/details/helpers/type-parameters.html.nunj +14 -0
- package/generator/templates/api/details/interface-declaration.html.nunj +27 -0
- package/generator/templates/api/details/type-alias-declaration.html.nunj +14 -0
- package/generator/templates/api/details/variable-declaration.html.nunj +0 -0
- package/generator/templates/api/details.html.nunj +9 -0
- package/generator/templates/api/enum-declaration.html.nunj +12 -0
- package/generator/templates/api/function-declaration.html.nunj +35 -0
- package/generator/templates/api/interface-declaration.html.nunj +37 -0
- package/generator/templates/api/type-alias-declaration.html.nunj +16 -0
- package/generator/templates/api/variable-declaration.html.nunj +8 -0
- package/generator/templates/api-header.html.nunj +11 -0
- package/generator/templates/api-list.ts.nunj +22 -0
- package/generator/templates/api-page-content.html.nunj +1 -0
- package/generator/templates/api-scope.ts.nunj +22 -0
- package/generator/templates/category.ts.nunj +22 -0
- package/generator/templates/code.html.nunj +3 -0
- package/generator/templates/context.ts.nunj +55 -0
- package/generator/templates/demo-app.ts.nunj +37 -0
- package/generator/templates/demo-assets.ts.nunj +25 -0
- package/generator/templates/demo-routes.ts.nunj +23 -0
- package/generator/templates/helpers/accessor.html.nunj +76 -0
- package/generator/templates/helpers/accessors.html.nunj +7 -0
- package/generator/templates/helpers/badge.html.nunj +4 -0
- package/generator/templates/helpers/call-signature.html.nunj +70 -0
- package/generator/templates/helpers/code.html.nunj +3 -0
- package/generator/templates/helpers/constructor.html.nunj +32 -0
- package/generator/templates/helpers/declaration-modifiers.html.nunj +45 -0
- package/generator/templates/helpers/decorators.html.nunj +11 -0
- package/generator/templates/helpers/members.html.nunj +29 -0
- package/generator/templates/helpers/method.html.nunj +89 -0
- package/generator/templates/helpers/methods.html.nunj +7 -0
- package/generator/templates/helpers/modifier.html.nunj +4 -0
- package/generator/templates/helpers/no-content.html.nunj +3 -0
- package/generator/templates/helpers/overload.html.nunj +57 -0
- package/generator/templates/helpers/parameters.html.nunj +44 -0
- package/generator/templates/helpers/properties.html.nunj +61 -0
- package/generator/templates/helpers/status.html.nunj +33 -0
- package/generator/templates/helpers/tag.html.nunj +4 -0
- package/generator/templates/helpers/type.html.nunj +11 -0
- package/generator/templates/index.ts.nunj +7 -0
- package/generator/templates/page-header.html.nunj +5 -0
- package/generator/templates/page-wrapper.ts.nunj +69 -0
- package/generator/templates/page.ts.nunj +104 -0
- package/generator/templates/parts/examples.html.nunj +11 -0
- package/generator/templates/parts/member-examples.html.nunj +12 -0
- package/generator/templates/parts/member-remarks.html.nunj +8 -0
- package/generator/templates/parts/page-tags.html.nunj +10 -0
- package/generator/templates/parts/remarks.html.nunj +10 -0
- package/generator/templates/parts/see-also.html.nunj +23 -0
- package/generator/templates/parts/usage-notes.html.nunj +8 -0
- package/generator/templates/playgrounds.ts.nunj +63 -0
- package/generator/templates/routes.ts.nunj +53 -0
- package/generator/templates/symbol/decorators.html.nunj +12 -0
- package/generator/templates/symbol/details.html.nunj +62 -0
- package/generator/templates/symbol/extended-by.html.nunj +17 -0
- package/generator/templates/symbol/header.html.nunj +22 -0
- package/generator/templates/symbol/members.html.nunj +303 -0
- package/generator/templates/symbol/page.html.nunj +76 -0
- package/generator/templates/symbol/see-also.html.nunj +16 -0
- package/generator/vite/angular/ANALOG-LICENSE +21 -0
- package/generator/vite/angular/analog-provenance.json +880 -0
- package/generator/vite/angular/index.d.ts +14 -0
- package/generator/vite/angular/index.js +7300 -0
- package/generator/vite/angular-compatibility.d.ts +6 -0
- package/generator/vite/angular-composition.d.ts +68 -0
- package/generator/vite/angular-version.d.ts +38 -0
- package/generator/vite/application-builder.js +336 -0
- package/generator/vite/application-builder.schema.json +46 -0
- package/generator/vite/application.d.ts +105 -0
- package/generator/vite/assets.d.ts +11 -0
- package/generator/vite/bounded-close.d.ts +33 -0
- package/generator/vite/component-updates.d.ts +21 -0
- package/generator/vite/configuration.d.ts +3 -0
- package/generator/vite/demo-application.d.ts +34 -0
- package/generator/vite/dev-server-builder.js +339 -0
- package/generator/vite/dev-server-builder.schema.json +27 -0
- package/generator/vite/dev-styles.d.ts +65 -0
- package/generator/vite/diagnostics.d.ts +4 -0
- package/generator/vite/external-probes.d.ts +40 -0
- package/generator/vite/host-updates.d.ts +212 -0
- package/generator/vite/index.d.ts +13 -0
- package/generator/vite/index.js +11949 -0
- package/generator/vite/lease.d.ts +6 -0
- package/generator/vite/lifecycle.d.ts +120 -0
- package/generator/vite/mime.d.ts +2 -0
- package/generator/vite/missing-paths.d.ts +44 -0
- package/generator/vite/options.d.ts +87 -0
- package/generator/vite/output-watch.d.ts +41 -0
- package/generator/vite/paths.d.ts +7 -0
- package/generator/vite/plugin.d.ts +3 -0
- package/generator/vite/prerender-entry.js +465 -0
- package/generator/vite/prerender-runtime.d.ts +79 -0
- package/generator/vite/prerender.d.ts +29 -0
- package/generator/vite/production.d.ts +66 -0
- package/generator/vite/progress.d.ts +33 -0
- package/generator/vite/restore-theme.js +13 -0
- package/generator/vite/route-inventory.d.ts +24 -0
- package/generator/vite/ssr-renderer-control.d.ts +1 -0
- package/generator/vite/ssr-renderer-entry.js +444 -0
- package/generator/vite/ssr-renderer-protocol.d.ts +101 -0
- package/generator/vite/ssr-renderer.d.ts +74 -0
- package/generator/vite/theme-index.d.ts +13 -0
- package/generator/vite/tsconfig-paths.d.ts +64 -0
- package/generator/vite/vite-event-source.d.ts +198 -0
- package/generator/vite/vite-version.d.ts +26 -0
- package/generator/vite/watch-inputs.d.ts +39 -0
- package/generator/worker/entry.d.ts +1 -0
- package/generator/worker/entry.js +614 -0
- package/generator/worker/index.d.ts +156 -0
- package/generator/worker/index.js +1030 -0
- package/generator/worker/protocol.d.ts +160 -0
- package/helpers/angular/get-component-decorator.js +6 -6
- package/helpers/angular/get-component-decorator.js.map +1 -1
- package/helpers/angular/get-directive-decorator.js +3 -3
- package/helpers/angular/get-directive-decorator.js.map +1 -1
- package/helpers/angular/get-pipe-decorator.js +3 -3
- package/helpers/angular/get-pipe-decorator.js.map +1 -1
- package/helpers/build-indexes.js +5 -2
- package/helpers/build-indexes.js.map +1 -1
- package/helpers/construct-page-keyword.js +2 -1
- package/helpers/construct-page-keyword.js.map +1 -1
- package/helpers/extract-selectors.d.ts +1 -1
- package/helpers/extract-selectors.js +5 -3
- package/helpers/extract-selectors.js.map +1 -1
- package/helpers/filter-useless-members.d.ts +1 -1
- package/helpers/format-cache.d.ts +34 -0
- package/helpers/format-cache.js +26 -0
- package/helpers/format-cache.js.map +1 -0
- package/helpers/format-code.d.ts +2 -1
- package/helpers/format-code.js +20 -4
- package/helpers/format-code.js.map +1 -1
- package/helpers/import-fresh-esm.js.map +1 -1
- package/helpers/index.d.ts +2 -0
- package/helpers/index.js +2 -0
- package/helpers/index.js.map +1 -1
- package/helpers/keyword-heading-title.d.ts +7 -0
- package/helpers/keyword-heading-title.js +21 -0
- package/helpers/keyword-heading-title.js.map +1 -0
- package/helpers/markdown-to-html.js +3 -3
- package/helpers/markdown-to-html.js.map +1 -1
- package/helpers/navigation-title-order.d.ts +8 -0
- package/helpers/navigation-title-order.js +15 -0
- package/helpers/navigation-title-order.js.map +1 -0
- package/helpers/playground/get-playground-inputs.js +8 -4
- package/helpers/playground/get-playground-inputs.js.map +1 -1
- package/helpers/playground/get-playground-template-inputs.js +2 -1
- package/helpers/playground/get-playground-template-inputs.js.map +1 -1
- package/helpers/presentation.d.ts +7 -7
- package/helpers/presentation.js +23 -23
- package/helpers/presentation.js.map +1 -1
- package/helpers/print.js +32 -5
- package/helpers/print.js.map +1 -1
- package/helpers/process-snippets.d.ts +1 -1
- package/helpers/process-snippets.js +3 -3
- package/helpers/process-snippets.js.map +1 -1
- package/helpers/snippets-from-asset.d.ts +1 -1
- package/helpers/snippets-from-asset.js +2 -2
- package/helpers/snippets-from-asset.js.map +1 -1
- package/helpers/sort-navigation-entities.js +2 -1
- package/helpers/sort-navigation-entities.js.map +1 -1
- package/helpers/stable-generated-id.d.ts +2 -0
- package/helpers/stable-generated-id.js +12 -0
- package/helpers/stable-generated-id.js.map +1 -0
- package/helpers/text-order.d.ts +8 -0
- package/helpers/text-order.js +26 -0
- package/helpers/text-order.js.map +1 -0
- package/helpers/to-template-string.d.ts +5 -1
- package/helpers/to-template-string.js +7 -2
- package/helpers/to-template-string.js.map +1 -1
- package/helpers/typescript/member/get-inherited-parent.d.ts +1 -1
- package/helpers/typescript/member/get-inherited-parent.js +2 -2
- package/helpers/typescript/member/get-inherited-parent.js.map +1 -1
- package/helpers/typescript/node/sort-by-nodes-name.d.ts +4 -2
- package/helpers/typescript/node/sort-by-nodes-name.js +6 -3
- package/helpers/typescript/node/sort-by-nodes-name.js.map +1 -1
- package/helpers/typescript/property/get-property-assignment.js.map +1 -1
- package/interfaces/code-block-options.d.ts +5 -0
- package/interfaces/configuration.d.ts +84 -1
- package/package.json +87 -29
- package/parsers/helpers/number.d.ts +1 -1
- package/parsers/helpers/number.js +2 -2
- package/parsers/helpers/number.js.map +1 -1
- package/parsers/helpers/param-value.d.ts +1 -1
- package/parsers/helpers/param-value.js +2 -2
- package/parsers/helpers/param-value.js.map +1 -1
- package/parsers/helpers/param.js +3 -3
- package/parsers/helpers/param.js.map +1 -1
- package/parsers/parse-code-block-params.d.ts +11 -2
- package/parsers/parse-code-block-params.js +50 -18
- package/parsers/parse-code-block-params.js.map +1 -1
- package/parsers/parse-snippet.js +10 -10
- package/parsers/parse-snippet.js.map +1 -1
- package/schematics/collection.json +34 -23
- package/schematics/migrate-to-vite/analyze.d.ts +76 -0
- package/schematics/migrate-to-vite/analyze.js +859 -0
- package/schematics/migrate-to-vite/analyze.js.map +1 -0
- package/schematics/migrate-to-vite/index.d.ts +9 -0
- package/schematics/migrate-to-vite/index.js +585 -0
- package/schematics/migrate-to-vite/index.js.map +1 -0
- package/schematics/migrate-to-vite/legacy-folder.d.ts +84 -0
- package/schematics/migrate-to-vite/legacy-folder.js +340 -0
- package/schematics/migrate-to-vite/legacy-folder.js.map +1 -0
- package/schematics/migrate-to-vite/report.d.ts +32 -0
- package/schematics/migrate-to-vite/report.js +97 -0
- package/schematics/migrate-to-vite/report.js.map +1 -0
- package/schematics/migrate-to-vite/schema.d.ts +13 -0
- package/schematics/migrate-to-vite/schema.js +3 -0
- package/schematics/migrate-to-vite/schema.js.map +1 -0
- package/schematics/migrate-to-vite/schema.json +31 -0
- package/schematics/migrate-to-vite/setup/dependencies.d.ts +64 -0
- package/schematics/migrate-to-vite/setup/dependencies.js +183 -0
- package/schematics/migrate-to-vite/setup/dependencies.js.map +1 -0
- package/schematics/migrate-to-vite/setup/index.d.ts +6 -0
- package/schematics/migrate-to-vite/setup/index.js +13 -0
- package/schematics/migrate-to-vite/setup/index.js.map +1 -0
- package/schematics/migrate-to-vite/setup/json-file.d.ts +51 -0
- package/schematics/migrate-to-vite/setup/json-file.js +115 -0
- package/schematics/migrate-to-vite/setup/json-file.js.map +1 -0
- package/schematics/migrate-to-vite/setup/source.d.ts +30 -0
- package/schematics/migrate-to-vite/setup/source.js +202 -0
- package/schematics/migrate-to-vite/setup/source.js.map +1 -0
- package/schematics/migrate-to-vite/setup/targets.d.ts +51 -0
- package/schematics/migrate-to-vite/setup/targets.js +48 -0
- package/schematics/migrate-to-vite/setup/targets.js.map +1 -0
- package/schematics/migrate-to-vite/setup/vite-config.d.ts +100 -0
- package/schematics/migrate-to-vite/setup/vite-config.js +175 -0
- package/schematics/migrate-to-vite/setup/vite-config.js.map +1 -0
- package/schematics/migrate-to-vite/setup/workspace.d.ts +105 -0
- package/schematics/migrate-to-vite/setup/workspace.js +245 -0
- package/schematics/migrate-to-vite/setup/workspace.js.map +1 -0
- package/schematics/migrate-to-vite/state.d.ts +65 -0
- package/schematics/migrate-to-vite/state.js +92 -0
- package/schematics/migrate-to-vite/state.js.map +1 -0
- package/schematics/migrate-to-vite/testing/fixtures.d.ts +30 -0
- package/schematics/migrate-to-vite/testing/fixtures.js +306 -0
- package/schematics/migrate-to-vite/testing/fixtures.js.map +1 -0
- package/schematics/migrate-to-vite/update-note.d.ts +6 -0
- package/schematics/migrate-to-vite/update-note.js +23 -0
- package/schematics/migrate-to-vite/update-note.js.map +1 -0
- package/schematics/migration.json +5 -0
- package/schematics/migrations/standalone-pages/index.js +7 -6
- package/schematics/migrations/standalone-pages/index.js.map +1 -1
- package/schematics/vite-setup/index.d.ts +24 -0
- package/schematics/vite-setup/index.js +212 -0
- package/schematics/vite-setup/index.js.map +1 -0
- package/schematics/vite-setup/schema.d.ts +7 -0
- package/schematics/vite-setup/schema.js +3 -0
- package/schematics/vite-setup/schema.js.map +1 -0
- package/schematics/vite-setup/schema.json +19 -0
- package/scripts/restore-theme.js +9 -2
- package/templates/api/class-declaration.html.nunj +5 -3
- package/templates/context.ts.nunj +3 -0
- package/templates/demo-app.ts.nunj +37 -0
- package/templates/demo-routes.ts.nunj +23 -0
- package/templates/helpers/badge.html.nunj +1 -1
- package/templates/helpers/status.html.nunj +4 -8
- package/templates/index.ts.nunj +5 -0
- package/templates/page-wrapper.ts.nunj +30 -2
- package/templates/page.ts.nunj +33 -1
- package/templates/parts/page-tags.html.nunj +1 -1
- package/templates/playgrounds.ts.nunj +8 -9
- package/templates/routes.ts.nunj +10 -1
- package/templates/symbol/decorators.html.nunj +12 -0
- package/templates/symbol/details.html.nunj +62 -0
- package/templates/symbol/extended-by.html.nunj +17 -0
- package/templates/symbol/header.html.nunj +22 -0
- package/templates/symbol/members.html.nunj +303 -0
- package/templates/symbol/page.html.nunj +76 -0
- package/templates/symbol/see-also.html.nunj +16 -0
- package/engine/.cache/apps/ng-doc/docs/api-documentation/auto-generation/ng-doc.page.mjs +0 -20
- package/engine/.cache/apps/ng-doc/docs/api-documentation/documenting-declarations/ng-doc.page.mjs +0 -20
- package/engine/.cache/apps/ng-doc/docs/api-documentation/rendering-api/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/customization/icons/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/customization/layout/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/customization/page-processors/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/customization/page-skeleton/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/customization/search/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/customization/themes/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/develop/ng-doc.page.mjs +0 -36
- package/engine/.cache/apps/ng-doc/docs/getting-started/configuration/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/getting-started/installation/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/getting-started/migrations/ng-doc.page.mjs +0 -18
- package/engine/.cache/apps/ng-doc/docs/getting-started/ssr/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/getting-started/what-is-ng-doc/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/ng-doc.api.mjs +0 -42
- package/engine/.cache/apps/ng-doc/docs/recipes/ignoring-file-lines/ng-doc.page.mjs +0 -18
- package/engine/.cache/apps/ng-doc/docs/recipes/performance/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/writing-content/blockquotes/ng-doc.page.mjs +0 -18
- package/engine/.cache/apps/ng-doc/docs/writing-content/code-blocks/ng-doc.page.mjs +0 -18
- package/engine/.cache/apps/ng-doc/docs/writing-content/demo-and-demo-pane/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/writing-content/images-videos-and-embeds/ng-doc.page.mjs +0 -18
- package/engine/.cache/apps/ng-doc/docs/writing-content/keywords/ng-doc.page.mjs +0 -17
- package/engine/.cache/apps/ng-doc/docs/writing-content/mermaid-diagrams/ng-doc.page.mjs +0 -18
- package/engine/.cache/apps/ng-doc/docs/writing-content/nunjucks/ng-doc.page.mjs +0 -18
- package/engine/.cache/apps/ng-doc/docs/writing-content/pages-and-categories/ng-doc.page.mjs +0 -18
- package/engine/.cache/apps/ng-doc/docs/writing-content/playground/ng-doc.page.mjs +0 -33
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { ts } from 'ts-morph';
|
|
2
|
+
/** Installs the canonical order on `checker`'s `typeToString`; later calls do nothing. */
|
|
3
|
+
export declare function canonicalTypeText(checker: ts.TypeChecker): void;
|
|
4
|
+
/** The members of a union in the canonical order (a copy; the union is not changed). */
|
|
5
|
+
export declare function canonicalUnionMembers(members: readonly ts.Type[], print: (member: ts.Type) => string): ts.Type[];
|
|
@@ -0,0 +1,206 @@
|
|
|
1
|
+
import type { BuildEvent, BuildResult, BuildSession, BuildSessionServices, Diagnostic, FileEventSource, WatchHandle } from '../contracts.js';
|
|
2
|
+
import type { ProgressSink } from '../progress/events.js';
|
|
3
|
+
export interface SessionOptions {
|
|
4
|
+
batchDelayMs?: number;
|
|
5
|
+
maxQueuedBuilds?: number;
|
|
6
|
+
/**
|
|
7
|
+
* Consecutive watch generations that native changes may abort before the next one is allowed to
|
|
8
|
+
* finish and publish. Later changes then form the following generation, so a continuous event
|
|
9
|
+
* stream delays publication by at most one generation instead of starving it. Defaults to 3.
|
|
10
|
+
*/
|
|
11
|
+
maxSupersessions?: number;
|
|
12
|
+
/**
|
|
13
|
+
* Discard watched `update` events whose file bytes equal the content the last committed
|
|
14
|
+
* generation observed, while no active or queued generation has the path in its changes (see
|
|
15
|
+
* UnchangedSaves). Discarded events are reported as an `unchanged` BuildEvent. Defaults to true.
|
|
16
|
+
*/
|
|
17
|
+
skipUnchangedSaves?: boolean;
|
|
18
|
+
/** Fallback for watcher/observer/teardown failures. Its own exceptions are contained. */
|
|
19
|
+
onDiagnostic?: (diagnostic: Diagnostic) => void;
|
|
20
|
+
/**
|
|
21
|
+
* Progress events of every generation, buildOnce included, and of the input check and warm-up
|
|
22
|
+
* outside generations (see `session/progress.ts`). Advisory: results are the same with and
|
|
23
|
+
* without it. A failing consumer is reported once through `onDiagnostic` as the
|
|
24
|
+
* `SESSION_PROGRESS_FAILED` warning and never stops a build or a watch.
|
|
25
|
+
*/
|
|
26
|
+
onProgress?: ProgressSink;
|
|
27
|
+
}
|
|
28
|
+
export interface SessionState {
|
|
29
|
+
disposed: boolean;
|
|
30
|
+
generation: number;
|
|
31
|
+
watching: boolean;
|
|
32
|
+
building: boolean;
|
|
33
|
+
queuedBuilds: number;
|
|
34
|
+
pendingChanges: number;
|
|
35
|
+
/** Results waited for on the watch's pending, queued or running generation (its `initial`). */
|
|
36
|
+
pendingWatchWaiters: number;
|
|
37
|
+
lastGoodRevision?: string;
|
|
38
|
+
/**
|
|
39
|
+
* The warm-up of the compiler's long-lived runtime after a reused startup baseline (see
|
|
40
|
+
* `PrimingCompiler`): `running`, or how it ended. `primed` means the runtime retains a program
|
|
41
|
+
* for the committed snapshot; `stale` means for another revision (the next generation rebuilds).
|
|
42
|
+
*/
|
|
43
|
+
priming?: 'running' | 'primed' | 'stale' | 'skipped' | 'aborted' | 'failed';
|
|
44
|
+
}
|
|
45
|
+
export declare class SessionLifecycleError extends Error {
|
|
46
|
+
readonly diagnostic: Diagnostic;
|
|
47
|
+
constructor(diagnostic: Diagnostic);
|
|
48
|
+
}
|
|
49
|
+
/** A session owns one compiler and committer. Their instances must not be shared across sessions. */
|
|
50
|
+
export declare class GeneratorBuildSession implements BuildSession {
|
|
51
|
+
private readonly services;
|
|
52
|
+
private readonly options;
|
|
53
|
+
private readonly delay;
|
|
54
|
+
private readonly maxQueue;
|
|
55
|
+
private readonly maxSupersessions;
|
|
56
|
+
private readonly queue;
|
|
57
|
+
private generation;
|
|
58
|
+
private active?;
|
|
59
|
+
private watchState?;
|
|
60
|
+
private pumping?;
|
|
61
|
+
private disposing?;
|
|
62
|
+
private disposed;
|
|
63
|
+
private snapshot?;
|
|
64
|
+
private manifest?;
|
|
65
|
+
private baseline?;
|
|
66
|
+
/** Filesystem inputs observed by the generation that produced the committed snapshot. */
|
|
67
|
+
private committedInputs?;
|
|
68
|
+
/**
|
|
69
|
+
* Filesystem inputs observed by the newest generation that failed after the last commit. Its
|
|
70
|
+
* new inputs were never committed, so they are re-observed against what it read instead.
|
|
71
|
+
*/
|
|
72
|
+
private failedInputs?;
|
|
73
|
+
private readonly unchanged?;
|
|
74
|
+
/** The running warm-up (see `prime`); aborted by any job, watch batch, watch stop or dispose. */
|
|
75
|
+
private priming?;
|
|
76
|
+
private primingState?;
|
|
77
|
+
private readonly progress;
|
|
78
|
+
constructor(services: BuildSessionServices, options?: SessionOptions);
|
|
79
|
+
inspect(): SessionState;
|
|
80
|
+
/**
|
|
81
|
+
* The host could not publish a generation this session committed (for example a Vite adapter
|
|
82
|
+
* that failed to install it). Until the next successful generation no watched save is
|
|
83
|
+
* discarded as unchanged, so re-saving a file retries the publication.
|
|
84
|
+
*/
|
|
85
|
+
publicationFailed(): void;
|
|
86
|
+
/**
|
|
87
|
+
* Re-observes inputs that a watch host has only just begun watching: its new physical watch
|
|
88
|
+
* targets and the changes it rejected while the generation that recorded them ran. That
|
|
89
|
+
* generation may have read a path before any watch existed, so a change in between would never
|
|
90
|
+
* be reported. Each path is compared with what the newest settled generation observed (the
|
|
91
|
+
* committed one, or a newer failed one, whose inputs were never committed). Each difference is
|
|
92
|
+
* admitted as an ordinary watcher change, so it runs a `filesystem` generation, which keeps the
|
|
93
|
+
* retained program; when nothing differs no generation runs, and the published generation's
|
|
94
|
+
* reload is not held back by one. Resolves once any change is admitted, never waiting for a
|
|
95
|
+
* generation. A lossy-watcher rescan still re-observes every committed input instead.
|
|
96
|
+
*/
|
|
97
|
+
reconcileInputs(paths: readonly string[]): Promise<void>;
|
|
98
|
+
/**
|
|
99
|
+
* Re-observes every input the committed generation observed, as after a lossy-watcher error:
|
|
100
|
+
* the next watch generation first compares each input with the filesystem and turns every
|
|
101
|
+
* difference into an ordinary change (see `reconcile`). With differences it is a `filesystem`
|
|
102
|
+
* generation: the compiler keeps its retained program only if the program's own sweep of what
|
|
103
|
+
* it observed still holds. Without any it is a `reconcile` generation, which discards the
|
|
104
|
+
* retained program. Either way the commit is the full one, which re-verifies every output. An
|
|
105
|
+
* active watch generation is superseded as by a watched change. Resolves once scheduled,
|
|
106
|
+
* never waiting for a generation; without an active watch there is nothing to reconcile.
|
|
107
|
+
*/
|
|
108
|
+
rescan(): Promise<void>;
|
|
109
|
+
buildOnce(options?: {
|
|
110
|
+
mode?: 'development' | 'production';
|
|
111
|
+
}): Promise<BuildResult>;
|
|
112
|
+
watch(source: FileEventSource, onEvent: (event: BuildEvent) => void): Promise<WatchHandle>;
|
|
113
|
+
dispose(): Promise<void>;
|
|
114
|
+
private assertOpen;
|
|
115
|
+
private capacityError;
|
|
116
|
+
private batch;
|
|
117
|
+
/** Marks the next watch batch to re-observe every committed input first (see `reconcile`). */
|
|
118
|
+
private scheduleRescan;
|
|
119
|
+
private watchWaiters;
|
|
120
|
+
/**
|
|
121
|
+
* A queued native change supersedes a watch snapshot even before the next generation starts.
|
|
122
|
+
* Explicit buildOnce jobs remain independent; the next job still waits for this
|
|
123
|
+
* compiler/committer call to settle, so shared compiler state is never concurrent. After
|
|
124
|
+
* `maxSupersessions` consecutive aborted generations the active one is protected: it finishes
|
|
125
|
+
* and publishes, and the batch runs next, so the newest change is always eventually committed.
|
|
126
|
+
*/
|
|
127
|
+
private supersede;
|
|
128
|
+
/**
|
|
129
|
+
* Screens native changes for unchanged saves. Returns the changes to batch, or `false` when every
|
|
130
|
+
* change was discarded (no generation will run for them). Deferred saves return an empty list:
|
|
131
|
+
* they are decided when the active generation settles.
|
|
132
|
+
*/
|
|
133
|
+
private admit;
|
|
134
|
+
/** Normalized paths in the changes of the active job, every queued job and the pending batch. */
|
|
135
|
+
private busyPaths;
|
|
136
|
+
private releaseDeferred;
|
|
137
|
+
private schedule;
|
|
138
|
+
private flush;
|
|
139
|
+
private enqueue;
|
|
140
|
+
private pump;
|
|
141
|
+
/**
|
|
142
|
+
* Merges the changes a lossy watcher may have missed: every input observed by the committed
|
|
143
|
+
* generation is re-observed and each difference becomes an ordinary change. If re-observation
|
|
144
|
+
* itself fails, every recorded content input is treated as changed.
|
|
145
|
+
*/
|
|
146
|
+
private reconcile;
|
|
147
|
+
private isCurrent;
|
|
148
|
+
private execute;
|
|
149
|
+
/**
|
|
150
|
+
* Makes a committed candidate the session's state: snapshot and manifest (a delta candidate is
|
|
151
|
+
* already private, its unchanged artifacts are the previous snapshot's) and the filesystem
|
|
152
|
+
* inputs it observed.
|
|
153
|
+
*/
|
|
154
|
+
private adopt;
|
|
155
|
+
/**
|
|
156
|
+
* The committed snapshot a watch generation's commit may be a delta against: with
|
|
157
|
+
* `this.manifest`, the pair that one acknowledgement made the session's state (`adopt` sets
|
|
158
|
+
* both). The committer still checks that this is what it last published.
|
|
159
|
+
* Undefined asks for the full commit, which re-verifies every output and so repairs external
|
|
160
|
+
* edits of unchanged ones: for builds outside a watch, for reconciling
|
|
161
|
+
* generations (a watcher rescan or `rescan()`), and for a generation whose compiler
|
|
162
|
+
* found a previously published output missing on disk (`output-missing`), and for every full
|
|
163
|
+
* generation of a compiler that tells full from targeted ones (`targetedResult`): full
|
|
164
|
+
* generations repair. Such a compiler keeps reporting `output-missing` for every published
|
|
165
|
+
* output, not only the recompiled ones.
|
|
166
|
+
*/
|
|
167
|
+
private commitBase;
|
|
168
|
+
/** Reports a delta candidate's outcome to the compiler. A failing hook is only reported. */
|
|
169
|
+
private acknowledge;
|
|
170
|
+
/**
|
|
171
|
+
* A development buildOnce result may replace the post-subscription generation only while it is
|
|
172
|
+
* the newest generation and no watcher event is pending. The caller checks this before and
|
|
173
|
+
* again synchronously after re-observing the inputs.
|
|
174
|
+
*/
|
|
175
|
+
private startupBaseline;
|
|
176
|
+
/**
|
|
177
|
+
* Every recorded filesystem input must re-observe identically after subscription. A change
|
|
178
|
+
* before subscription is found here; a later one is reported by the watcher. A verification
|
|
179
|
+
* error keeps the ordinary generation.
|
|
180
|
+
*/
|
|
181
|
+
private reobserve;
|
|
182
|
+
private failure;
|
|
183
|
+
private cancelled;
|
|
184
|
+
private cancel;
|
|
185
|
+
private stopWatch;
|
|
186
|
+
/**
|
|
187
|
+
* Warms the compiler's long-lived runtime right after a watch reused the startup baseline. The
|
|
188
|
+
* baseline was compiled by a one-shot runtime, or restored by the fast start without building a
|
|
189
|
+
* program, so without this the first edit rebuilds the whole TypeScript program. The request is
|
|
190
|
+
* the one a no-change
|
|
191
|
+
* development generation would send for the committed snapshot; the compiler is deterministic,
|
|
192
|
+
* so its candidate has the committed revision and the runtime's retained program is valid for
|
|
193
|
+
* the first edit's base. Nothing comes back: no generation number is used, and nothing is
|
|
194
|
+
* committed, published, emitted or reported (a failing hook is contained). Any job, watched
|
|
195
|
+
* change, watch stop or dispose aborts it (`stopPriming`).
|
|
196
|
+
*/
|
|
197
|
+
private prime;
|
|
198
|
+
private stopPriming;
|
|
199
|
+
/** Tells the compiler that the watch started or stopped. A failing hook is only reported. */
|
|
200
|
+
private watchRuntime;
|
|
201
|
+
private emit;
|
|
202
|
+
private observerFailed;
|
|
203
|
+
private fallback;
|
|
204
|
+
private cleanup;
|
|
205
|
+
}
|
|
206
|
+
export declare function createBuildSession(services: BuildSessionServices, options?: SessionOptions): GeneratorBuildSession;
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import type { Dependency, FileChange } from '../contracts.js';
|
|
2
|
+
export type PhysicalInput = Extract<Dependency, {
|
|
3
|
+
kind: 'content' | 'existence' | 'glob';
|
|
4
|
+
}>;
|
|
5
|
+
/** The filesystem observations of a compilation; semantic and keyword digests derive from them. */
|
|
6
|
+
export declare function physicalInputs(dependencies: readonly Dependency[]): PhysicalInput[];
|
|
7
|
+
/**
|
|
8
|
+
* Re-observes every recorded filesystem input with the compiler's own dependency refresher.
|
|
9
|
+
*
|
|
10
|
+
* Content and existence observations must match exactly, including observations below the
|
|
11
|
+
* generator-owned roots: a compilation that read its own previous outputs is only current while
|
|
12
|
+
* those bytes are unchanged. Glob membership is compared without owned-root members because
|
|
13
|
+
* semantic source membership excludes generated output by construction and watchers never report
|
|
14
|
+
* owned-root changes. Any read failure or difference reports a change.
|
|
15
|
+
*/
|
|
16
|
+
export declare function inputsUnchanged(inputs: readonly PhysicalInput[], ownedRoots: readonly string[]): Promise<boolean>;
|
|
17
|
+
/**
|
|
18
|
+
* Re-observes recorded filesystem inputs and reports each difference as the file event a watcher
|
|
19
|
+
* would have delivered: a changed digest is an update, a vanished file a delete, an existence
|
|
20
|
+
* flip a create or delete, and glob membership differences creates and deletes. Paths below the
|
|
21
|
+
* generator-owned roots are never reported, exactly as watchers ignore them. A glob that cannot be
|
|
22
|
+
* scanned reports nothing: its members are still individually observed as content inputs.
|
|
23
|
+
*/
|
|
24
|
+
export declare function changedInputs(inputs: readonly PhysicalInput[], ownedRoots: readonly string[]): Promise<FileChange[]>;
|
|
25
|
+
/**
|
|
26
|
+
* Re-observes only the recorded inputs at the given paths. A watch host passes the targets it has
|
|
27
|
+
* just begun watching and the changes it rejected while the generation that recorded them ran:
|
|
28
|
+
* that generation may have read them before any watch could report a change. Differences are
|
|
29
|
+
* reported exactly as `changedInputs` reports them.
|
|
30
|
+
*
|
|
31
|
+
* A path selects every content or existence observation at or below it, and every glob whose root
|
|
32
|
+
* is at, below or above it, so that a membership change is found. A glob records membership only,
|
|
33
|
+
* never content: it vouches for a directory (a glob base), but a file is compared only through its
|
|
34
|
+
* own content or existence observation. A path without one has nothing to compare with (for
|
|
35
|
+
* example a file the generation read but never recorded), so it is reported as changed: an
|
|
36
|
+
* `update` while it exists, otherwise a `delete`. Paths below the owned roots are never reported.
|
|
37
|
+
*/
|
|
38
|
+
export declare function reobservedChanges(inputs: readonly PhysicalInput[], ownedRoots: readonly string[], paths: readonly string[]): Promise<FileChange[]>;
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import * as parcel from '@parcel/watcher';
|
|
2
|
+
import type { FileEventSource } from '../contracts.js';
|
|
3
|
+
/**
|
|
4
|
+
* IDE and OS metadata that is never a generator input but is rewritten constantly: the watched
|
|
5
|
+
* root's JetBrains `.idea/` directory and macOS Finder `.DS_Store` files. Recorded inputs are
|
|
6
|
+
* TypeScript sources, `ng-doc.{page,category,api}.ts` descriptions and the files they include.
|
|
7
|
+
* `.vscode/` is not ignored: VS Code keeps its frequently written state outside the workspace.
|
|
8
|
+
*/
|
|
9
|
+
export declare const METADATA_IGNORE: readonly string[];
|
|
10
|
+
/**
|
|
11
|
+
* The backend a subscription names when its options name none. Without a name, @parcel/watcher on
|
|
12
|
+
* Linux first probes for Watchman: it runs `watchman get-sockname` through `popen`, and when
|
|
13
|
+
* Watchman is missing the reply fails to parse before `pclose`, so the probe's shell is never
|
|
14
|
+
* reaped. The host then keeps a zombie child in its process group until it exits, and a
|
|
15
|
+
* supervisor that waits for that group to empty after `dispose` finds it there. Naming inotify,
|
|
16
|
+
* the backend the probe falls back to, skips the probe. macOS selects FSEvents before any probe.
|
|
17
|
+
* @param platform The platform to choose for.
|
|
18
|
+
* @returns The backend to name, or `undefined` to keep @parcel/watcher's choice.
|
|
19
|
+
*/
|
|
20
|
+
export declare function nativeWatcherBackend(platform?: NodeJS.Platform): parcel.BackendType | undefined;
|
|
21
|
+
/** Each subscription owns a native watcher. The adapter must ignore its generated output roots. */
|
|
22
|
+
export declare function createParcelEventSource(root: string, options?: parcel.Options, subscribe?: typeof parcel.subscribe): FileEventSource;
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
import type { ArtifactSnapshot, BuildResult, CommitResult, CompilationProgressUpdate, Diagnostic, Generation } from '../contracts.js';
|
|
2
|
+
import type { ProgressActivityEvent, ProgressEvent, ProgressSink, ProgressTrigger } from '../progress/events.js';
|
|
3
|
+
/** What a generation reports when it starts. */
|
|
4
|
+
export interface ProgressJob {
|
|
5
|
+
generation: Generation;
|
|
6
|
+
trigger: ProgressTrigger;
|
|
7
|
+
mode: 'development' | 'production';
|
|
8
|
+
/** File changes behind the generation, before a rescan adds what it found. */
|
|
9
|
+
changes: number;
|
|
10
|
+
}
|
|
11
|
+
type Activity = ProgressActivityEvent['activity'];
|
|
12
|
+
/**
|
|
13
|
+
* The session's progress events (`SessionOptions.onProgress`). Advisory only: nothing here reads
|
|
14
|
+
* or changes what a generation compiles, commits or publishes. Without a consumer every call is a
|
|
15
|
+
* single branch. Timings come from the session's own clock, and a failing consumer is reported
|
|
16
|
+
* once as `SESSION_PROGRESS_FAILED` and never stops anything.
|
|
17
|
+
*/
|
|
18
|
+
export declare class SessionProgress {
|
|
19
|
+
private readonly now;
|
|
20
|
+
private readonly sink?;
|
|
21
|
+
private readonly activities;
|
|
22
|
+
constructor(sink: ProgressSink | undefined, report: (diagnostic: Diagnostic) => void, now?: () => number);
|
|
23
|
+
/**
|
|
24
|
+
* A generation started. `isCurrent` gates every later update: once the generation is aborted or
|
|
25
|
+
* superseded, only its one `progress-settled` event follows.
|
|
26
|
+
*/
|
|
27
|
+
start(job: ProgressJob, isCurrent: () => boolean): GenerationProgress | undefined;
|
|
28
|
+
/**
|
|
29
|
+
* Work outside a generation: the input check after a watch starts, and the warm-up. An end may
|
|
30
|
+
* say the work `failed`, or that other work `stopped` it first.
|
|
31
|
+
*/
|
|
32
|
+
activity(activity: Activity, state: 'start' | 'end', outcome?: 'failed' | 'stopped'): void;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* One generation's events: `progress-started`, the compilation's phases (compiler and worker, see
|
|
36
|
+
* `compilation`), the session's commit, then exactly one settle.
|
|
37
|
+
*/
|
|
38
|
+
export declare class GenerationProgress {
|
|
39
|
+
private readonly sink;
|
|
40
|
+
private readonly job;
|
|
41
|
+
private readonly isCurrent;
|
|
42
|
+
private readonly now;
|
|
43
|
+
private seq;
|
|
44
|
+
private readonly startedAt;
|
|
45
|
+
private phases;
|
|
46
|
+
private open?;
|
|
47
|
+
private commit?;
|
|
48
|
+
private settled;
|
|
49
|
+
private pass?;
|
|
50
|
+
private reason?;
|
|
51
|
+
/** The compilation's updates, stamped and gated like the session's own (`compile` context). */
|
|
52
|
+
readonly compilation: (update: CompilationProgressUpdate) => void;
|
|
53
|
+
constructor(sink: (event: ProgressEvent) => void, job: ProgressJob, isCurrent: () => boolean, now: () => number);
|
|
54
|
+
/**
|
|
55
|
+
* The commit starts. A full commit (`full` is the candidate) compares every candidate output, so
|
|
56
|
+
* their count is the total; a delta commit writes an unknown share of them.
|
|
57
|
+
*/
|
|
58
|
+
commitStarted(full?: ArtifactSnapshot): void;
|
|
59
|
+
commitEnded(result: CommitResult): void;
|
|
60
|
+
/** The generation's outcome. `previous` is the last committed snapshot, for a failure's page count. */
|
|
61
|
+
settle(result: BuildResult, previous?: ArtifactSnapshot): void;
|
|
62
|
+
/** Counts never decide an outcome: a result they cannot read is reported without them. */
|
|
63
|
+
private safeCounts;
|
|
64
|
+
/**
|
|
65
|
+
* A phase update from the compilation or the session. The session's clock times it: no clock
|
|
66
|
+
* crosses the worker boundary.
|
|
67
|
+
*/
|
|
68
|
+
private update;
|
|
69
|
+
private close;
|
|
70
|
+
private counts;
|
|
71
|
+
}
|
|
72
|
+
export {};
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
import type { FileChange } from '../contracts.js';
|
|
2
|
+
import type { PhysicalInput } from './input-verification.js';
|
|
3
|
+
/**
|
|
4
|
+
* Bounds on the synchronous reads made to recognise unchanged saves. A file above `maxFileBytes`,
|
|
5
|
+
* and every candidate after a delivered event batch has used up its file or byte budget, is
|
|
6
|
+
* admitted unchecked, exactly as without the filter.
|
|
7
|
+
*/
|
|
8
|
+
export interface UnchangedSaveLimits {
|
|
9
|
+
maxFileBytes: number;
|
|
10
|
+
maxFilesPerBatch: number;
|
|
11
|
+
maxBytesPerBatch: number;
|
|
12
|
+
}
|
|
13
|
+
export declare const UNCHANGED_SAVE_LIMITS: Readonly<UnchangedSaveLimits>;
|
|
14
|
+
export interface ScreenContext {
|
|
15
|
+
/** A generation is running; it may read a path after the committed observation. */
|
|
16
|
+
active: boolean;
|
|
17
|
+
/** The path (normalized) is in the changes of the active, a queued or the pending batch. */
|
|
18
|
+
busy(path: string): boolean;
|
|
19
|
+
}
|
|
20
|
+
export interface ScreenResult {
|
|
21
|
+
passed: FileChange[];
|
|
22
|
+
dropped: FileChange[];
|
|
23
|
+
deferred: number;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Recognises watched saves that change nothing: an `update` whose file bytes equal the content the
|
|
27
|
+
* last committed generation observed for that path, while no active or queued generation has the
|
|
28
|
+
* path in its changes. Such an event would only rerun a full
|
|
29
|
+
* generation (and supersede one in flight) to publish identical output.
|
|
30
|
+
*
|
|
31
|
+
* Exactness:
|
|
32
|
+
* - Creates, deletes and paths without a recorded content digest are always admitted.
|
|
33
|
+
* - Nothing is dropped unless the newest settled (non-cancelled) generation succeeded, so a revert
|
|
34
|
+
* to the committed bytes after a failed generation still regenerates and clears the failure.
|
|
35
|
+
* - A path in the changes of the active, a queued or the pending batch is admitted: an active
|
|
36
|
+
* generation may already have read newer bytes (a revert during a generation still runs).
|
|
37
|
+
* - While any generation is active, a matching save is deferred, not dropped: that generation may
|
|
38
|
+
* read the path after the committed observation (for example during a coalesced A→B→A write).
|
|
39
|
+
* When it settles, deferred saves are screened again against the digests it committed.
|
|
40
|
+
*/
|
|
41
|
+
export declare class UnchangedSaves {
|
|
42
|
+
private readonly limits;
|
|
43
|
+
private readonly digestOf;
|
|
44
|
+
private digests;
|
|
45
|
+
private healthy;
|
|
46
|
+
private readonly waiting;
|
|
47
|
+
constructor(limits?: Readonly<UnchangedSaveLimits>, digestOf?: (file: string, maxBytes: number) => {
|
|
48
|
+
digest: string;
|
|
49
|
+
bytes: number;
|
|
50
|
+
} | undefined);
|
|
51
|
+
/** Records the content observations of a committed generation. */
|
|
52
|
+
committed(inputs: readonly PhysicalInput[]): void;
|
|
53
|
+
/** A non-cancelled generation settled. Only a success keeps unchanged saves droppable. */
|
|
54
|
+
settled(status: 'success' | 'failure'): void;
|
|
55
|
+
/** Recorded digest of a path, for diagnostics and tests. */
|
|
56
|
+
recorded(file: string): string | undefined;
|
|
57
|
+
deferredCount(): number;
|
|
58
|
+
/** Deferred saves, removed from the filter, in arrival order. */
|
|
59
|
+
takeDeferred(): FileChange[];
|
|
60
|
+
clearDeferred(): void;
|
|
61
|
+
reset(): void;
|
|
62
|
+
screen(events: readonly FileChange[], context: ScreenContext): ScreenResult;
|
|
63
|
+
}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import type { WatchInputs } from '../contracts.js';
|
|
2
|
+
/**
|
|
3
|
+
* Projects a complete compiler dependency DTO into host-facing filesystem inputs.
|
|
4
|
+
* It is intentionally pure: session ownership ends at observation, not watching.
|
|
5
|
+
*/
|
|
6
|
+
export declare function projectWatchInputs(dependencies: unknown): WatchInputs;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { Diagnostic } from '../contracts.js';
|
|
2
|
+
/**
|
|
3
|
+
* A file event source reports this warning when its native watcher may have lost events (for
|
|
4
|
+
* example an FSEvents queue overflow: "Events were dropped ... File system must be re-scanned").
|
|
5
|
+
* The watch itself stays alive. The session answers it with a reconciling generation whose
|
|
6
|
+
* changes are re-observed from the inputs of the last committed generation, instead of treating
|
|
7
|
+
* the signal as a fatal watcher error.
|
|
8
|
+
*/
|
|
9
|
+
export declare const WATCHER_RESCAN = "WATCHER_RESCAN";
|
|
10
|
+
export declare function isRescanSignal(diagnostic: Diagnostic): boolean;
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
{% import "helpers/declaration-modifiers.html.nunj" as tagsMacro %}
|
|
2
|
+
{% import "helpers/no-content.html.nunj" as noContentMacro %}
|
|
3
|
+
|
|
4
|
+
{% if not hideDescription %}
|
|
5
|
+
{% set description = docNode | getJsDocDescription %}
|
|
6
|
+
|
|
7
|
+
{{ description if description else noContentMacro.render('No documentation has been provided.') }}
|
|
8
|
+
{% endif %}
|
|
9
|
+
|
|
10
|
+
{% if not hideRemarks %}
|
|
11
|
+
{% include "parts/remarks.html.nunj" %}
|
|
12
|
+
{% endif %}
|
|
13
|
+
|
|
14
|
+
{% if not hideSeeAlso %}
|
|
15
|
+
{% include "parts/see-also.html.nunj" %}
|
|
16
|
+
{% endif %}
|
|
17
|
+
|
|
18
|
+
{% block overview %}{% endblock %}
|
|
19
|
+
|
|
20
|
+
{% if not hideExamples %}
|
|
21
|
+
{% include "parts/examples.html.nunj" %}
|
|
22
|
+
{% endif %}
|
|
23
|
+
|
|
24
|
+
{% if not hideUsageNotes %}
|
|
25
|
+
{% include "parts/usage-notes.html.nunj" %}
|
|
26
|
+
{% endif %}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
{% extends "api/base.html.nunj" %}
|
|
2
|
+
|
|
3
|
+
{% import "helpers/constructor.html.nunj" as constructorMacro %}
|
|
4
|
+
{% import "helpers/methods.html.nunj" as methodsMacro %}
|
|
5
|
+
{% import "helpers/properties.html.nunj" as propertiesMacro %}
|
|
6
|
+
{% import "helpers/accessors.html.nunj" as accessorsMacro %}
|
|
7
|
+
{% import "helpers/modifier.html.nunj" as modifierMacro %}
|
|
8
|
+
|
|
9
|
+
{% block overview %}
|
|
10
|
+
{#- The new engine sets `hideProtectedMembers` for `api.protectedMembers: false`; the legacy engine never does. #}
|
|
11
|
+
{%- set memberScopes = ["public"] if hideProtectedMembers else ["public", "protected"] -%}
|
|
12
|
+
{%- set constructors = declaration.getConstructors() | filterByScope("public") | excludeByJsDocTags('internal') -%}
|
|
13
|
+
{%- set allProperties = declaration | getClassProperties | excludeByJsDocTags('internal') | filterByScope(memberScopes) | filterUselessMembers | sortByNodesName -%}
|
|
14
|
+
{%- set allMethods = declaration | getClassMethods | excludeByJsDocTags('internal') | filterByScope(memberScopes) | filterUselessMembers | sortByNodesName -%}
|
|
15
|
+
{%- set allAccessors = declaration | getClassAccessors | excludeByJsDocTags('internal') | filterByScope(memberScopes) | filterUselessMembers | sortByNodesName -%}
|
|
16
|
+
|
|
17
|
+
{%- set staticProperties = allProperties | filterByStatic(true) -%}
|
|
18
|
+
{%- set staticAccessors = allAccessors | filterByStatic(true) -%}
|
|
19
|
+
{%- set staticMethods = allMethods | filterByStatic(true) -%}
|
|
20
|
+
{%- set properties = allProperties | filterByStatic(false) -%}
|
|
21
|
+
{%- set accessors = allAccessors | filterByStatic(false) -%}
|
|
22
|
+
{%- set getAccessors = declaration.getGetAccessors() | filterByStatic(false) -%}
|
|
23
|
+
{%- set methods = allMethods | filterByStatic(false) -%}
|
|
24
|
+
|
|
25
|
+
{% if constructors.length -%}
|
|
26
|
+
<h2>Constructor</h2>
|
|
27
|
+
{{ constructorMacro.render(constructors[0]) }}
|
|
28
|
+
{%- endif %}
|
|
29
|
+
|
|
30
|
+
{% if staticProperties.length -%}
|
|
31
|
+
<h2>Static Properties</h2>
|
|
32
|
+
{{ propertiesMacro.render(staticProperties, declaration) }}
|
|
33
|
+
{%- endif %}
|
|
34
|
+
|
|
35
|
+
{% if properties.length -%}
|
|
36
|
+
<h2>Properties</h2>
|
|
37
|
+
{{ propertiesMacro.render(properties, declaration) }}
|
|
38
|
+
{%- endif %}
|
|
39
|
+
|
|
40
|
+
{% if staticAccessors.length -%}
|
|
41
|
+
<h2>Static Accessors</h2>
|
|
42
|
+
{{ accessorsMacro.render(staticAccessors, declaration) }}
|
|
43
|
+
{%- endif %}
|
|
44
|
+
|
|
45
|
+
{% if accessors.length -%}
|
|
46
|
+
<h2>Accessors</h2>
|
|
47
|
+
{{ accessorsMacro.render(accessors, declaration) }}
|
|
48
|
+
{%- endif %}
|
|
49
|
+
|
|
50
|
+
{% if staticMethods.length -%}
|
|
51
|
+
<h2>Static Methods</h2>
|
|
52
|
+
{{ methodsMacro.render(staticMethods, declaration) }}
|
|
53
|
+
{%- endif %}
|
|
54
|
+
|
|
55
|
+
{% if methods.length -%}
|
|
56
|
+
<h2>Methods</h2>
|
|
57
|
+
{{ methodsMacro.render(methods, declaration) }}
|
|
58
|
+
{%- endif %}
|
|
59
|
+
{% endblock %}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
{% import "helpers/type.html.nunj" as typeMacro %}
|
|
2
|
+
|
|
3
|
+
{% set typeParameters %}
|
|
4
|
+
{% include "api/details/helpers/type-parameters.html.nunj" %}
|
|
5
|
+
{% endset %}
|
|
6
|
+
{% set hasTypeParameters = typeParameters | trim | length %}
|
|
7
|
+
|
|
8
|
+
{% set decorators %}
|
|
9
|
+
{% include "api/details/helpers/decorators.html.nunj" %}
|
|
10
|
+
{% endset %}
|
|
11
|
+
{% set hasDecorators = decorators | trim | length %}
|
|
12
|
+
|
|
13
|
+
{% set selectors %}
|
|
14
|
+
{% include "api/details/helpers/selectors.html.nunj" %}
|
|
15
|
+
{% endset %}
|
|
16
|
+
{% set hasSelectors = selectors | trim | length %}
|
|
17
|
+
|
|
18
|
+
{% set extends = declaration.getExtends() %}
|
|
19
|
+
{% set implements = declaration.getImplements() %}
|
|
20
|
+
|
|
21
|
+
{% if hasTypeParameters or hasDecorators or hasSelectors or extends or implements.length %}
|
|
22
|
+
<table class="ng-doc-api-table no-padding no-full-width">
|
|
23
|
+
<tbody>
|
|
24
|
+
{{ decorators }}
|
|
25
|
+
{{ typeParameters }}
|
|
26
|
+
{{ selectors }}
|
|
27
|
+
|
|
28
|
+
{% if extends %}
|
|
29
|
+
<tr>
|
|
30
|
+
<td indexable="false">Extends:</td>
|
|
31
|
+
<td>{{ typeMacro.type(extends) }}</td>
|
|
32
|
+
</tr>
|
|
33
|
+
{%- endif %}
|
|
34
|
+
|
|
35
|
+
{% if implements.length %}
|
|
36
|
+
<tr>
|
|
37
|
+
<td indexable="false">Implements:</td>
|
|
38
|
+
<td>
|
|
39
|
+
{%- for i in implements -%}
|
|
40
|
+
{{ typeMacro.type(i) }}
|
|
41
|
+
{%- endfor %}
|
|
42
|
+
</td>
|
|
43
|
+
</tr>
|
|
44
|
+
{%- endif %}
|
|
45
|
+
</tbody>
|
|
46
|
+
</table>
|
|
47
|
+
{% endif %}
|
|
File without changes
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
{% import "helpers/type.html.nunj" as typeMacro %}
|
|
2
|
+
|
|
3
|
+
{% set typeParameters %}
|
|
4
|
+
{% include "api/details/helpers/type-parameters.html.nunj" %}
|
|
5
|
+
{% endset %}
|
|
6
|
+
{% set hasTypeParameters = typeParameters | trim | length %}
|
|
7
|
+
|
|
8
|
+
{% if hasTypeParameters %}
|
|
9
|
+
<table class="ng-doc-api-table no-padding no-full-width">
|
|
10
|
+
<tbody>
|
|
11
|
+
{{ typeParameters }}
|
|
12
|
+
</tbody>
|
|
13
|
+
</table>
|
|
14
|
+
{% endif %}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
{% import "helpers/type.html.nunj" as typeMacro %}
|
|
2
|
+
|
|
3
|
+
{% set decorators = declaration.getDecorators() %}
|
|
4
|
+
|
|
5
|
+
{% if decorators.length %}
|
|
6
|
+
<tr>
|
|
7
|
+
<td indexable="false">Decorators:</td>
|
|
8
|
+
<td indexable="false">
|
|
9
|
+
{% for decorator in decorators %}
|
|
10
|
+
{{ typeMacro.render( '@' + decorator.getName()) }}
|
|
11
|
+
{%- endfor %}
|
|
12
|
+
</td>
|
|
13
|
+
</tr>
|
|
14
|
+
{% endif %}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
{% import "helpers/type.html.nunj" as typeMacro %}
|
|
2
|
+
|
|
3
|
+
{% set typeParameters = declaration.getTypeParameters() %}
|
|
4
|
+
|
|
5
|
+
{% if typeParameters.length %}
|
|
6
|
+
<tr>
|
|
7
|
+
<td indexable="false">Generic types:</td>
|
|
8
|
+
<td>
|
|
9
|
+
{% for typeParameter in typeParameters %}
|
|
10
|
+
{{ typeMacro.type(typeParameter) }}
|
|
11
|
+
{%- endfor %}
|
|
12
|
+
</td>
|
|
13
|
+
</tr>
|
|
14
|
+
{% endif %}
|