@ng-doc/builder 22.0.0-beta.1 → 22.0.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 +7 -2
- package/application/index.js.map +1 -1
- package/application/schema.json +11 -4
- 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/build-ng-doc.js +1 -16
- package/engine/build-ng-doc.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/page/demo-assets.builder.js +8 -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 +3 -3
- package/engine/builders/shared/content.builder.js.map +1 -1
- package/engine/builders/shared/entry.builder.js +1 -13
- package/engine/builders/shared/entry.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 +8 -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/entries-emitter.js +2 -6
- package/engine/core/operators/entries-emitter.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/stores/index.d.ts +0 -1
- package/engine/core/stores/index.js +0 -1
- package/engine/core/stores/index.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/engine/core/watcher/watch.js +19 -1
- package/engine/core/watcher/watch.js.map +1 -1
- package/engine/variables.d.ts +1 -0
- package/engine/variables.js +1 -0
- package/engine/variables.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 +7274 -0
- package/generator/bootstrap/candidate-output-committer.d.ts +12 -0
- package/generator/bootstrap/cli.d.ts +42 -0
- package/generator/bootstrap/cli.js +7123 -0
- package/generator/bootstrap/constants.d.ts +4 -0
- package/generator/bootstrap/index.d.ts +111 -0
- package/generator/bootstrap/index.js +5020 -0
- package/generator/bootstrap/prerender-command.d.ts +31 -0
- package/generator/bootstrap/process-tree.d.ts +49 -0
- package/generator/build-metafile.json +11701 -0
- package/generator/build-provenance.json +119 -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 +111 -0
- package/generator/compiler/index.js +17759 -0
- package/generator/compiler/link.d.ts +38 -0
- package/generator/compiler/memo.d.ts +44 -0
- package/generator/compiler/plan.d.ts +92 -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/content-compiler.d.ts +118 -0
- package/generator/content/highlight-cache.d.ts +139 -0
- package/generator/content/html-pipeline.d.ts +170 -0
- package/generator/content/html-pool.d.ts +239 -0
- package/generator/content/html-worker.js +1598 -0
- package/generator/content-module-ids.d.ts +8 -0
- package/generator/contracts.d.ts +1063 -0
- package/generator/contracts.js +15 -0
- package/generator/discovery/index.d.ts +77 -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 +49 -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 +67 -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 +9 -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/fragments.d.ts +28 -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 +57 -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-assets.ts.nunj +25 -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 +2 -0
- package/generator/templates/page-header.html.nunj +5 -0
- package/generator/templates/page-wrapper.ts.nunj +64 -0
- package/generator/templates/page.ts.nunj +97 -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 +49 -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 +301 -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 +331 -0
- package/generator/vite/application-builder.schema.json +46 -0
- package/generator/vite/application.d.ts +91 -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/dev-server-builder.js +334 -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 +145 -0
- package/generator/vite/index.d.ts +13 -0
- package/generator/vite/index.js +11589 -0
- package/generator/vite/lease.d.ts +6 -0
- package/generator/vite/lifecycle.d.ts +119 -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 +395 -0
- package/generator/vite/prerender-runtime.d.ts +66 -0
- package/generator/vite/prerender.d.ts +27 -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-code.d.ts +2 -1
- package/helpers/format-code.js +13 -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/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/schema.d.ts +1 -0
- package/package.json +87 -30
- 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 +1 -1
- package/parsers/parse-code-block-params.js +22 -16
- 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 +816 -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 +100 -0
- package/schematics/migrate-to-vite/setup/workspace.js +225 -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 +18 -0
- package/schematics/migrate-to-vite/testing/fixtures.js +279 -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 +20 -0
- package/schematics/vite-setup/index.js +206 -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/context.ts.nunj +3 -0
- package/templates/helpers/badge.html.nunj +1 -1
- package/templates/helpers/status.html.nunj +4 -8
- package/templates/page-wrapper.ts.nunj +24 -1
- package/templates/page.ts.nunj +25 -0
- package/templates/parts/page-tags.html.nunj +1 -1
- package/templates/playgrounds.ts.nunj +8 -9
- package/templates/routes.ts.nunj +6 -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 +301 -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
- package/engine/core/stores/entry-status.d.ts +0 -23
- package/engine/core/stores/entry-status.js +0 -36
- package/engine/core/stores/entry-status.js.map +0 -1
package/package.json
CHANGED
|
@@ -1,6 +1,26 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ng-doc/builder",
|
|
3
|
-
"version": "22.0.0
|
|
3
|
+
"version": "22.0.0",
|
|
4
|
+
"description": "Generates an NgDoc documentation site from your Markdown pages and TypeScript code.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"angular",
|
|
7
|
+
"documentation",
|
|
8
|
+
"generator",
|
|
9
|
+
"builder",
|
|
10
|
+
"guides",
|
|
11
|
+
"api",
|
|
12
|
+
"demo",
|
|
13
|
+
"ng-doc"
|
|
14
|
+
],
|
|
15
|
+
"homepage": "https://ng-doc.com",
|
|
16
|
+
"bugs": {
|
|
17
|
+
"url": "https://github.com/ng-doc/ng-doc/issues"
|
|
18
|
+
},
|
|
19
|
+
"repository": {
|
|
20
|
+
"type": "git",
|
|
21
|
+
"url": "git+https://github.com/ng-doc/ng-doc.git"
|
|
22
|
+
},
|
|
23
|
+
"license": "MIT",
|
|
4
24
|
"type": "commonjs",
|
|
5
25
|
"builders": "./builders.json",
|
|
6
26
|
"schematics": "./schematics/collection.json",
|
|
@@ -11,13 +31,12 @@
|
|
|
11
31
|
]
|
|
12
32
|
},
|
|
13
33
|
"dependencies": {
|
|
14
|
-
"@ng-doc/core": "22.0.0
|
|
15
|
-
"@ng-doc/utils": "22.0.0
|
|
16
|
-
"@angular-devkit/architect": ">=0.
|
|
17
|
-
"
|
|
18
|
-
"minimatch": "9.0.1",
|
|
34
|
+
"@ng-doc/core": "22.0.0",
|
|
35
|
+
"@ng-doc/utils": "22.0.0",
|
|
36
|
+
"@angular-devkit/architect": ">=0.2200.0 <0.2300.0",
|
|
37
|
+
"minimatch": "9.0.9",
|
|
19
38
|
"rxjs": "^7.0.0",
|
|
20
|
-
"ts-morph": "
|
|
39
|
+
"ts-morph": "28.0.0",
|
|
21
40
|
"nunjucks": "3.2.4",
|
|
22
41
|
"@orama/orama": "2.0.17",
|
|
23
42
|
"@orama/plugin-parsedoc": "2.0.17",
|
|
@@ -32,39 +51,77 @@
|
|
|
32
51
|
"cosmiconfig-typescript-loader": "5.0.0",
|
|
33
52
|
"find-cache-dir": "3.3.2",
|
|
34
53
|
"tslib": "^2.6.2",
|
|
35
|
-
"ng-morph": "
|
|
54
|
+
"ng-morph": "4.9.0",
|
|
55
|
+
"jsonc-parser": "3.3.1",
|
|
36
56
|
"parsimmon": "^1.18.1",
|
|
37
57
|
"@parcel/watcher": "^2.5.0",
|
|
38
|
-
"@microsoft/tsdoc": "0.15.1"
|
|
58
|
+
"@microsoft/tsdoc": "0.15.1",
|
|
59
|
+
"@shikijs/rehype": "1.10.3",
|
|
60
|
+
"css-what": "6.1.0",
|
|
61
|
+
"github-slugger": "2.0.0",
|
|
62
|
+
"hast-util-has-property": "3.0.0",
|
|
63
|
+
"hast-util-heading-rank": "3.0.0",
|
|
64
|
+
"hast-util-is-element": "3.0.0",
|
|
65
|
+
"hast-util-to-string": "3.0.0",
|
|
66
|
+
"posthtml-render": "3.0.0",
|
|
67
|
+
"rehype": "13.0.1",
|
|
68
|
+
"rehype-minify-whitespace": "6.0.0",
|
|
69
|
+
"rehype-parse": "9.0.0",
|
|
70
|
+
"rehype-stringify": "10.0.1",
|
|
71
|
+
"stringify-entities": "4.0.4",
|
|
72
|
+
"typescript": "6.0.3",
|
|
73
|
+
"unified": "11.0.5",
|
|
74
|
+
"unist-util-filter": "5.0.1",
|
|
75
|
+
"unist-util-visit": "5.0.0",
|
|
76
|
+
"unist-util-visit-parents": "6.0.2",
|
|
77
|
+
"@angular-devkit/core": ">=22.0.0 <23.0.0",
|
|
78
|
+
"magic-string": "0.30.21",
|
|
79
|
+
"obug": "2.1.3",
|
|
80
|
+
"oxc-parser": "0.121.0",
|
|
81
|
+
"tinyglobby": "0.2.17"
|
|
82
|
+
},
|
|
83
|
+
"peerDependencies": {
|
|
84
|
+
"@angular/build": ">=22.0.0 <23.0.0",
|
|
85
|
+
"vite": "^6.0.0 || ^7.0.0 || ^8.0.0",
|
|
86
|
+
"@analogjs/vite-plugin-angular": "^2.8.0",
|
|
87
|
+
"@angular/compiler": ">=22.0.0 <23.0.0",
|
|
88
|
+
"@angular/compiler-cli": ">=22.0.0 <23.0.0"
|
|
89
|
+
},
|
|
90
|
+
"peerDependenciesMeta": {
|
|
91
|
+
"vite": {
|
|
92
|
+
"optional": true
|
|
93
|
+
},
|
|
94
|
+
"@analogjs/vite-plugin-angular": {
|
|
95
|
+
"optional": true
|
|
96
|
+
},
|
|
97
|
+
"@angular/compiler": {
|
|
98
|
+
"optional": true
|
|
99
|
+
},
|
|
100
|
+
"@angular/compiler-cli": {
|
|
101
|
+
"optional": true
|
|
102
|
+
}
|
|
103
|
+
},
|
|
104
|
+
"ng-doc": {
|
|
105
|
+
"viteEngine": {
|
|
106
|
+
"@analogjs/vite-plugin-angular": "^2.8.0",
|
|
107
|
+
"@angular/compiler": "^22.0.0",
|
|
108
|
+
"@angular/compiler-cli": "^22.0.0",
|
|
109
|
+
"vite": "^8.3.0"
|
|
110
|
+
}
|
|
39
111
|
},
|
|
40
112
|
"publishConfig": {
|
|
41
113
|
"access": "public"
|
|
42
114
|
},
|
|
43
115
|
"overrides": {
|
|
44
116
|
"nunjucks": {
|
|
45
|
-
"chokidar": "^
|
|
117
|
+
"chokidar": "^5.0.0"
|
|
46
118
|
}
|
|
47
119
|
},
|
|
48
|
-
"
|
|
49
|
-
|
|
50
|
-
"keywords": [
|
|
51
|
-
"angular",
|
|
52
|
-
"documentation",
|
|
53
|
-
"generator",
|
|
54
|
-
"builder",
|
|
55
|
-
"guides",
|
|
56
|
-
"api",
|
|
57
|
-
"demo",
|
|
58
|
-
"ng-doc"
|
|
59
|
-
],
|
|
60
|
-
"author": "Skoropad Aleksandr <alex@skoropad.dev>",
|
|
61
|
-
"repository": {
|
|
62
|
-
"type": "git",
|
|
63
|
-
"url": "git+https://github.com/ng-doc/ng-doc.git"
|
|
120
|
+
"bin": {
|
|
121
|
+
"ng-doc": "./generator/bootstrap/bin.js"
|
|
64
122
|
},
|
|
65
|
-
"
|
|
66
|
-
"
|
|
123
|
+
"engines": {
|
|
124
|
+
"node": ">=24.15.0 <25"
|
|
67
125
|
},
|
|
68
|
-
"
|
|
69
|
-
"license": "MIT"
|
|
126
|
+
"author": "Skoropad Aleksandr <alex@skoropad.dev>"
|
|
70
127
|
}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import
|
|
1
|
+
import P from 'parsimmon';
|
|
2
2
|
export declare const number: P.Parser<number>;
|
|
@@ -2,6 +2,6 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.number = void 0;
|
|
4
4
|
const tslib_1 = require("tslib");
|
|
5
|
-
const
|
|
6
|
-
exports.number =
|
|
5
|
+
const parsimmon_1 = tslib_1.__importDefault(require("parsimmon"));
|
|
6
|
+
exports.number = parsimmon_1.default.digits.map(Number);
|
|
7
7
|
//# sourceMappingURL=number.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"number.js","sourceRoot":"","sources":["../../../../../libs/builder/parsers/helpers/number.ts"],"names":[],"mappings":";;;;AAAA,
|
|
1
|
+
{"version":3,"file":"number.js","sourceRoot":"","sources":["../../../../../libs/builder/parsers/helpers/number.ts"],"names":[],"mappings":";;;;AAAA,kEAA0B;AAEb,QAAA,MAAM,GAAG,mBAAC,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC"}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import
|
|
1
|
+
import P from 'parsimmon';
|
|
2
2
|
export declare const paramValue: () => P.Parser<string>;
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.paramValue = void 0;
|
|
4
4
|
const tslib_1 = require("tslib");
|
|
5
|
-
const
|
|
6
|
-
const paramValue = () =>
|
|
5
|
+
const parsimmon_1 = tslib_1.__importDefault(require("parsimmon"));
|
|
6
|
+
const paramValue = () => parsimmon_1.default.regexp(/.+?(?=")/).wrap(parsimmon_1.default.string('"'), parsimmon_1.default.string('"'));
|
|
7
7
|
exports.paramValue = paramValue;
|
|
8
8
|
//# sourceMappingURL=param-value.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"param-value.js","sourceRoot":"","sources":["../../../../../libs/builder/parsers/helpers/param-value.ts"],"names":[],"mappings":";;;;AAAA,
|
|
1
|
+
{"version":3,"file":"param-value.js","sourceRoot":"","sources":["../../../../../libs/builder/parsers/helpers/param-value.ts"],"names":[],"mappings":";;;;AAAA,kEAA0B;AAEnB,MAAM,UAAU,GAAG,GAAG,EAAE,CAAC,mBAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,mBAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,mBAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;AAA3E,QAAA,UAAU,cAAiE"}
|
package/parsers/helpers/param.js
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.param = param;
|
|
4
4
|
const tslib_1 = require("tslib");
|
|
5
|
-
const
|
|
5
|
+
const parsimmon_1 = tslib_1.__importDefault(require("parsimmon"));
|
|
6
6
|
const param_value_1 = require("./param-value");
|
|
7
7
|
/**
|
|
8
8
|
*
|
|
@@ -10,8 +10,8 @@ const param_value_1 = require("./param-value");
|
|
|
10
10
|
* @param newKeyName
|
|
11
11
|
*/
|
|
12
12
|
function param(key, newKeyName) {
|
|
13
|
-
return
|
|
14
|
-
.then(
|
|
13
|
+
return parsimmon_1.default.string(key)
|
|
14
|
+
.then(parsimmon_1.default.string('='))
|
|
15
15
|
.then((0, param_value_1.paramValue)())
|
|
16
16
|
.map((value) => ({ [newKeyName ?? key]: value }));
|
|
17
17
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"param.js","sourceRoot":"","sources":["../../../../../libs/builder/parsers/helpers/param.ts"],"names":[],"mappings":";;AAUA,sBAQC;;AAlBD,
|
|
1
|
+
{"version":3,"file":"param.js","sourceRoot":"","sources":["../../../../../libs/builder/parsers/helpers/param.ts"],"names":[],"mappings":";;AAUA,sBAQC;;AAlBD,kEAA0B;AAG1B,+CAA2C;AAE3C;;;;GAIG;AACH,SAAgB,KAAK,CACnB,GAAM,EACN,UAAc;IAEd,OAAO,mBAAC,CAAC,MAAM,CAAC,GAAG,CAAC;SACjB,IAAI,CAAC,mBAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SACnB,IAAI,CAAC,IAAA,wBAAU,GAAE,CAAC;SAClB,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,UAAU,IAAI,GAAG,CAAC,EAAE,KAAK,EAAE,CAA6C,CAAC,CAAC;AAClG,CAAC"}
|
|
@@ -2,41 +2,47 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.parseCodeBlockParams = parseCodeBlockParams;
|
|
4
4
|
const tslib_1 = require("tslib");
|
|
5
|
-
const
|
|
5
|
+
const parsimmon_1 = tslib_1.__importDefault(require("parsimmon"));
|
|
6
6
|
const helpers_1 = require("./helpers");
|
|
7
|
+
/**
|
|
8
|
+
* A code block language: a Shiki language id or alias. Besides letters and dashes, they use digits
|
|
9
|
+
* (`f90`, `1c`), `+` and `#` (`c++`, `c#`, `f#`) and other scripts (`文言`). Quotes, `=`, braces and
|
|
10
|
+
* whitespace end it, so the parameters that follow are parsed as before.
|
|
11
|
+
*/
|
|
12
|
+
const CODE_BLOCK_LANGUAGE = /[\p{L}\p{N}+#-]+/u;
|
|
7
13
|
/**
|
|
8
14
|
* Code block options parser
|
|
9
15
|
* @param options - Options string to parse
|
|
10
16
|
*/
|
|
11
17
|
function parseCodeBlockParams(options) {
|
|
12
|
-
const parser =
|
|
13
|
-
language: () =>
|
|
14
|
-
.skip(
|
|
18
|
+
const parser = parsimmon_1.default.createLanguage({
|
|
19
|
+
language: () => parsimmon_1.default.regexp(CODE_BLOCK_LANGUAGE)
|
|
20
|
+
.skip(parsimmon_1.default.optWhitespace)
|
|
15
21
|
.map((language) => ({ language })),
|
|
16
22
|
// File Parsers
|
|
17
|
-
fileLineNumber: () =>
|
|
18
|
-
fileLineRange: (p) =>
|
|
23
|
+
fileLineNumber: () => parsimmon_1.default.string('L').then(parsimmon_1.default.digits).map(Number),
|
|
24
|
+
fileLineRange: (p) => parsimmon_1.default.seqMap(parsimmon_1.default.string('#')
|
|
19
25
|
.then(p['fileLineNumber'])
|
|
20
|
-
.map((num) => num - 1),
|
|
21
|
-
fileLineStart: (p) =>
|
|
26
|
+
.map((num) => num - 1), parsimmon_1.default.string('-').then(p['fileLineNumber'].fallback(undefined)), (fileLineStart, fileLineEnd) => ({ fileLineStart, fileLineEnd })),
|
|
27
|
+
fileLineStart: (p) => parsimmon_1.default.string('#')
|
|
22
28
|
.then(p['fileLineNumber'])
|
|
23
29
|
.map((num) => num - 1)
|
|
24
30
|
.map((fileLineStart) => ({ fileLineStart, fileLineEnd: fileLineStart + 1 })),
|
|
25
31
|
lineParams: (p) => p['fileLineRange'].or(p['fileLineStart']).fallback({}),
|
|
26
|
-
highlightedLinesRange: () =>
|
|
32
|
+
highlightedLinesRange: () => parsimmon_1.default.seqMap(helpers_1.number.skip(parsimmon_1.default.string('-')), helpers_1.number, (start, end) => [...Array(end + 1).keys()].slice(start - end - 1)),
|
|
27
33
|
// Main Parsers
|
|
28
|
-
lineNumbers: () =>
|
|
34
|
+
lineNumbers: () => parsimmon_1.default.string('lineNumbers').map(() => ({ lineNumbers: true })),
|
|
29
35
|
filePath: () => (0, helpers_1.param)('file'),
|
|
30
36
|
name: () => (0, helpers_1.param)('name'),
|
|
31
37
|
group: () => (0, helpers_1.param)('group'),
|
|
32
38
|
fileName: () => (0, helpers_1.param)('fileName', 'name'),
|
|
33
39
|
icon: () => (0, helpers_1.param)('icon'),
|
|
34
|
-
active: () =>
|
|
35
|
-
file: (p) =>
|
|
40
|
+
active: () => parsimmon_1.default.string('active').map(() => ({ active: true })),
|
|
41
|
+
file: (p) => parsimmon_1.default.seq(p['filePath'], p['lineParams'].map(({ fileLineStart, fileLineEnd }) => ({ fileLineStart, fileLineEnd }))).map(([file, lineParams]) => ({ ...file, ...lineParams })),
|
|
36
42
|
highlightedLines: (p) => p['highlightedLinesRange']
|
|
37
43
|
.or(helpers_1.number)
|
|
38
|
-
.sepBy(
|
|
39
|
-
.wrap(
|
|
44
|
+
.sepBy(parsimmon_1.default.string(',').then(parsimmon_1.default.optWhitespace))
|
|
45
|
+
.wrap(parsimmon_1.default.string('{'), parsimmon_1.default.string('}'))
|
|
40
46
|
.map((a) => Array.from(new Set(a.flat())))
|
|
41
47
|
.map((highlightedLines) => ({ highlightedLines })),
|
|
42
48
|
// Combined Parsers
|
|
@@ -48,8 +54,8 @@ function parseCodeBlockParams(options) {
|
|
|
48
54
|
.or(p['active'])
|
|
49
55
|
.or(p['icon'])
|
|
50
56
|
.or(p['highlightedLines'])
|
|
51
|
-
.sepBy(
|
|
52
|
-
languageWithParamsParser: (p) =>
|
|
57
|
+
.sepBy(parsimmon_1.default.whitespace),
|
|
58
|
+
languageWithParamsParser: (p) => parsimmon_1.default.seq(p['language'], p['paramsParser']).map((v) => v.flat()),
|
|
53
59
|
});
|
|
54
60
|
let result = parser['paramsParser'].parse(options);
|
|
55
61
|
if (result.status) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"parse-code-block-params.js","sourceRoot":"","sources":["../../../../libs/builder/parsers/parse-code-block-params.ts"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"parse-code-block-params.js","sourceRoot":"","sources":["../../../../libs/builder/parsers/parse-code-block-params.ts"],"names":[],"mappings":";;AAgBA,oDAkFC;;AAlGD,kEAA0B;AAG1B,uCAA0C;AAE1C;;;;GAIG;AACH,MAAM,mBAAmB,GAAW,mBAAmB,CAAC;AAExD;;;GAGG;AACH,SAAgB,oBAAoB,CAAC,OAAe;IAClD,MAAM,MAAM,GAAG,mBAAC,CAAC,cAAc,CAAC;QAC9B,QAAQ,EAAE,GAAG,EAAE,CACb,mBAAC,CAAC,MAAM,CAAC,mBAAmB,CAAC;aAC1B,IAAI,CAAC,mBAAC,CAAC,aAAa,CAAC;aACrB,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;QACtC,eAAe;QACf,cAAc,EAAE,GAAG,EAAE,CAAC,mBAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,mBAAC,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;QAC9D,aAAa,EAAE,CAAC,CAAC,EAAE,EAAE,CACnB,mBAAC,CAAC,MAAM,CACN,mBAAC,CAAC,MAAM,CAAC,GAAG,CAAC;aACV,IAAI,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;aACzB,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,EACxB,mBAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAC3D,CAAC,aAAa,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC,EAAE,aAAa,EAAE,WAAW,EAAE,CAAC,CACjE;QACH,aAAa,EAAE,CAAC,CAAC,EAAE,EAAE,CACnB,mBAAC,CAAC,MAAM,CAAC,GAAG,CAAC;aACV,IAAI,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;aACzB,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC;aACrB,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC,EAAE,aAAa,EAAE,WAAW,EAAE,aAAa,GAAG,CAAC,EAAE,CAAC,CAAC;QAChF,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;QACzE,qBAAqB,EAAE,GAAG,EAAE,CAC1B,mBAAC,CAAC,MAAM,CAAC,gBAAM,CAAC,IAAI,CAAC,mBAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,gBAAM,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAC1D,CAAC,GAAG,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,GAAG,CAAC,CAAC,CAClD;QAEH,eAAe;QACf,WAAW,EAAE,GAAG,EAAE,CAAC,mBAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;QAC7E,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAA,eAAK,EAAC,MAAM,CAAC;QAC7B,IAAI,EAAE,GAAG,EAAE,CAAC,IAAA,eAAK,EAAC,MAAM,CAAC;QACzB,KAAK,EAAE,GAAG,EAAE,CAAC,IAAA,eAAK,EAAC,OAAO,CAAC;QAC3B,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAA,eAAK,EAAC,UAAU,EAAE,MAAM,CAAC;QACzC,IAAI,EAAE,GAAG,EAAE,CAAC,IAAA,eAAK,EAAC,MAAM,CAAC;QACzB,MAAM,EAAE,GAAG,EAAE,CAAC,mBAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9D,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CACV,mBAAC,CAAC,GAAG,CACH,CAAC,CAAC,UAAU,CAAC,EACb,CAAC,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,aAAa,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,aAAa,EAAE,WAAW,EAAE,CAAC,CAAC,CAC1F,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC;QAE7D,gBAAgB,EAAE,CAAC,CAAC,EAAE,EAAE,CACtB,CAAC,CAAC,uBAAuB,CAAC;aACvB,EAAE,CAAC,gBAAM,CAAC;aACV,KAAK,CAAC,mBAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,mBAAC,CAAC,aAAa,CAAC,CAAC;aAC1C,IAAI,CAAC,mBAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,mBAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;aAClC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;aACzC,GAAG,CAAC,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC,EAAE,gBAAgB,EAAE,CAAC,CAAC;QAEtD,mBAAmB;QACnB,YAAY,EAAE,CAAC,CAAa,EAAE,EAAE,CAC9B,CAAC,CAAC,aAAa,CAAC;aACb,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;aACjB,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;aACb,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;aACb,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;aACd,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;aACf,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;aACb,EAAE,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC;aACzB,KAAK,CAAC,mBAAC,CAAC,UAAU,CAAC;QACxB,wBAAwB,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,mBAAC,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;KAC9F,CAAC,CAAC;IAEH,IAAI,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAEnD,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClB,OAAO,MAAM,CAAC,KAAK,CAAC,MAAM,CACxB,CAAC,GAAyB,EAAE,GAAkC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC,EACvF,EAAE,CACH,CAAC;IACJ,CAAC;IAED,MAAM,GAAG,MAAM,CAAC,0BAA0B,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAE3D,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClB,OAAO,MAAM,CAAC,KAAK,CAAC,MAAM,CACxB,CAAC,GAAyB,EAAE,GAAkC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC,EACvF,EAAE,CACH,CAAC;IACJ,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,wCAAwC,OAAO,GAAG,CAAC,CAAC;AACtE,CAAC"}
|
package/parsers/parse-snippet.js
CHANGED
|
@@ -2,31 +2,31 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.parseSnippet = parseSnippet;
|
|
4
4
|
const tslib_1 = require("tslib");
|
|
5
|
-
const
|
|
5
|
+
const parsimmon_1 = tslib_1.__importDefault(require("parsimmon"));
|
|
6
6
|
const helpers_1 = require("./helpers");
|
|
7
7
|
/**
|
|
8
8
|
*
|
|
9
9
|
* @param string - string to parse
|
|
10
10
|
*/
|
|
11
11
|
function parseSnippet(string) {
|
|
12
|
-
const parser =
|
|
13
|
-
keyword: () =>
|
|
14
|
-
id: () =>
|
|
15
|
-
.then(
|
|
12
|
+
const parser = parsimmon_1.default.createLanguage({
|
|
13
|
+
keyword: () => parsimmon_1.default.string('snippet'),
|
|
14
|
+
id: () => parsimmon_1.default.string('#')
|
|
15
|
+
.then(parsimmon_1.default.regexp(/[a-zA-Z0-9-]+/))
|
|
16
16
|
.fallback(null)
|
|
17
17
|
.map((id) => ({ id })),
|
|
18
|
-
lang: () =>
|
|
19
|
-
.then(
|
|
18
|
+
lang: () => parsimmon_1.default.string(':')
|
|
19
|
+
.then(parsimmon_1.default.regexp(/[a-zA-Z0-9-]+/))
|
|
20
20
|
.fallback(undefined)
|
|
21
21
|
.map((lang) => ({ lang })),
|
|
22
22
|
icon: () => (0, helpers_1.param)('icon'),
|
|
23
23
|
title: () => (0, helpers_1.paramValue)().map((title) => ({ title })),
|
|
24
|
-
opened: () =>
|
|
24
|
+
opened: () => parsimmon_1.default.string('opened')
|
|
25
25
|
.result(true)
|
|
26
26
|
.fallback(undefined)
|
|
27
27
|
.map((opened) => ({ opened })),
|
|
28
|
-
snippet: ({ keyword, id, lang, icon, title, opened }) => keyword.then(
|
|
29
|
-
snippetFromFile: ({ lang, icon, title, opened }) =>
|
|
28
|
+
snippet: ({ keyword, id, lang, icon, title, opened }) => keyword.then(parsimmon_1.default.seq(id, lang, parsimmon_1.default.whitespace.then(title.or(icon).or(opened).sepBy(parsimmon_1.default.whitespace)).fallback([])).map(([id, lang, rest]) => ({ ...id, ...lang, ...Object.assign({}, ...rest) }))),
|
|
29
|
+
snippetFromFile: ({ lang, icon, title, opened }) => parsimmon_1.default.seq((0, helpers_1.param)('snippet-from-file', 'fromFile'), lang, parsimmon_1.default.whitespace.then(title.or(icon).or(opened).sepBy(parsimmon_1.default.whitespace)).fallback([])).map(([id, lang, rest]) => ({ ...id, ...lang, ...Object.assign({}, ...rest) })),
|
|
30
30
|
anySnippet: ({ snippet, snippetFromFile }) => snippetFromFile.or(snippet),
|
|
31
31
|
});
|
|
32
32
|
const result = parser.anySnippet.parse(string);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"parse-snippet.js","sourceRoot":"","sources":["../../../../libs/builder/parsers/parse-snippet.ts"],"names":[],"mappings":";;AASA,oCAmDC;;AA5DD,
|
|
1
|
+
{"version":3,"file":"parse-snippet.js","sourceRoot":"","sources":["../../../../libs/builder/parsers/parse-snippet.ts"],"names":[],"mappings":";;AASA,oCAmDC;;AA5DD,kEAA0B;AAG1B,uCAA8C;AAE9C;;;GAGG;AACH,SAAgB,YAAY,CAAC,MAAc;IACzC,MAAM,MAAM,GAAG,mBAAC,CAAC,cAAc,CAU5B;QACD,OAAO,EAAE,GAAG,EAAE,CAAC,mBAAC,CAAC,MAAM,CAAC,SAAS,CAAC;QAClC,EAAE,EAAE,GAAG,EAAE,CACP,mBAAC,CAAC,MAAM,CAAC,GAAG,CAAC;aACV,IAAI,CAAC,mBAAC,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;aAC/B,QAAQ,CAAC,IAAI,CAAC;aACd,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAC1B,IAAI,EAAE,GAAG,EAAE,CACT,mBAAC,CAAC,MAAM,CAAC,GAAG,CAAC;aACV,IAAI,CAAC,mBAAC,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;aAC/B,QAAQ,CAAC,SAAS,CAAC;aACnB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9B,IAAI,EAAE,GAAG,EAAE,CAAC,IAAA,eAAK,EAAC,MAAM,CAAC;QACzB,KAAK,EAAE,GAAG,EAAE,CAAC,IAAA,oBAAU,GAAE,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QACrD,MAAM,EAAE,GAAG,EAAE,CACX,mBAAC,CAAC,MAAM,CAAC,QAAQ,CAAC;aACf,MAAM,CAAC,IAAI,CAAC;aACZ,QAAQ,CAAC,SAAS,CAAC;aACnB,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QAElC,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,CACtD,OAAO,CAAC,IAAI,CACV,mBAAC,CAAC,GAAG,CACH,EAAE,EACF,IAAI,EACJ,mBAAC,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,mBAAC,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAC9E,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CACjF;QACH,eAAe,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,CACjD,mBAAC,CAAC,GAAG,CACH,IAAA,eAAK,EAAC,mBAAmB,EAAE,UAAU,CAAC,EACtC,IAAI,EACJ,mBAAC,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,mBAAC,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAC9E,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC;QAClF,UAAU,EAAE,CAAC,EAAE,OAAO,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC,eAAe,CAAC,EAAE,CAAC,OAAO,CAAC;KAC1E,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/C,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AAClD,CAAC"}
|
|
@@ -1,25 +1,36 @@
|
|
|
1
1
|
{
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
2
|
+
"$schema": "../../../node_modules/@angular-devkit/schematics/collection-schema.json",
|
|
3
|
+
"schematics": {
|
|
4
|
+
"category": {
|
|
5
|
+
"description": "Generates NgDoc Category entity",
|
|
6
|
+
"factory": "./category/index#generate",
|
|
7
|
+
"schema": "./category/schema.json"
|
|
8
|
+
},
|
|
9
|
+
"page": {
|
|
10
|
+
"description": "Generates NgDoc Page entity",
|
|
11
|
+
"factory": "./page/index#generate",
|
|
12
|
+
"schema": "./page/schema.json"
|
|
13
|
+
},
|
|
14
|
+
"api": {
|
|
15
|
+
"description": "Generates NgDoc API entity",
|
|
16
|
+
"factory": "./api/index#generate",
|
|
17
|
+
"schema": "./api/schema.json"
|
|
18
|
+
},
|
|
19
|
+
"migrate-to-vite": {
|
|
20
|
+
"description": "Moves a project from the legacy NgDoc builders to the Vite engine (or back with --revert)",
|
|
21
|
+
"factory": "./migrate-to-vite/index#migrateToVite",
|
|
22
|
+
"schema": "./migrate-to-vite/schema.json"
|
|
23
|
+
},
|
|
24
|
+
"vite-setup": {
|
|
25
|
+
"description": "Sets up the Vite engine for a project on Angular's application builder (run by ng add @ng-doc/add)",
|
|
26
|
+
"factory": "./vite-setup/index#viteSetup",
|
|
27
|
+
"schema": "./vite-setup/schema.json",
|
|
28
|
+
"hidden": true
|
|
29
|
+
},
|
|
30
|
+
"standalone-pages-migration": {
|
|
31
|
+
"description": "Moves all dependencies from ng-doc.dependencies.ts to ng-doc.page.ts",
|
|
32
|
+
"factory": "./migrations/standalone-pages/index#migrate",
|
|
33
|
+
"schema": "./migrations/standalone-pages/schema.json"
|
|
34
|
+
}
|
|
35
|
+
}
|
|
25
36
|
}
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
import { Tree } from '@angular-devkit/schematics';
|
|
2
|
+
import { NgDocViteSetup } from './setup/vite-config';
|
|
3
|
+
import { WorkspaceProject, WorkspaceTarget } from './setup/workspace';
|
|
4
|
+
/** The legacy builders the schematic migrates. */
|
|
5
|
+
export declare const LEGACY_BUILD_BUILDERS: string[];
|
|
6
|
+
export declare const LEGACY_SERVE_BUILDERS: string[];
|
|
7
|
+
/**
|
|
8
|
+
* How an option or a workspace detail is carried over:
|
|
9
|
+
* - `migrated`: applied to the Vite configuration or the new targets;
|
|
10
|
+
* - `dropped`: it has no effect under Vite, or Vite's default matches it;
|
|
11
|
+
* - `manual`: not migrated, and the site may behave differently until it is handled by hand;
|
|
12
|
+
* - `blocking`: the project cannot be migrated; nothing is changed.
|
|
13
|
+
*/
|
|
14
|
+
export type FindingLevel = 'migrated' | 'dropped' | 'manual' | 'blocking';
|
|
15
|
+
export interface MigrationFinding {
|
|
16
|
+
level: FindingLevel;
|
|
17
|
+
/** The option (`build.fileReplacements`) or the subject (`package.json`). */
|
|
18
|
+
subject: string;
|
|
19
|
+
message: string;
|
|
20
|
+
}
|
|
21
|
+
/** A `buildTarget` of another target that must keep pointing at the legacy build. */
|
|
22
|
+
export interface Retarget {
|
|
23
|
+
target: string;
|
|
24
|
+
before?: string;
|
|
25
|
+
after: string;
|
|
26
|
+
}
|
|
27
|
+
/** Everything the migration of one project changes. */
|
|
28
|
+
export interface MigrationPlan {
|
|
29
|
+
project: WorkspaceProject;
|
|
30
|
+
build: {
|
|
31
|
+
name: string;
|
|
32
|
+
legacyName: string;
|
|
33
|
+
legacy: WorkspaceTarget;
|
|
34
|
+
next: WorkspaceTarget;
|
|
35
|
+
};
|
|
36
|
+
serve?: {
|
|
37
|
+
name: string;
|
|
38
|
+
legacyName: string;
|
|
39
|
+
legacy: WorkspaceTarget;
|
|
40
|
+
next: WorkspaceTarget;
|
|
41
|
+
};
|
|
42
|
+
setup: NgDocViteSetup;
|
|
43
|
+
retargets: Retarget[];
|
|
44
|
+
/** The legacy engine's generated folder, deleted once so the new engine can own it. */
|
|
45
|
+
legacyOutput?: string;
|
|
46
|
+
findings: MigrationFinding[];
|
|
47
|
+
}
|
|
48
|
+
export interface AnalyzeOptions {
|
|
49
|
+
/** The configuration file to create, workspace-relative (default `<root>/vite.config.mjs`). */
|
|
50
|
+
viteConfig?: string;
|
|
51
|
+
/** The root component, workspace-relative (default: found from the browser entry). */
|
|
52
|
+
rootComponent?: string;
|
|
53
|
+
/**
|
|
54
|
+
* The name the original build target is kept under, for the Angular builders that read its
|
|
55
|
+
* options. By default it is `<build>-legacy`, which still builds the site with the legacy
|
|
56
|
+
* builders; a target kept under another name is not offered as the way to keep a server.
|
|
57
|
+
*/
|
|
58
|
+
keptBuildName?: string;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* Every option of Angular's `application` builder (and NgDoc's `ngDoc` extension) that the
|
|
62
|
+
* schematic knows. Anything else in a build target is reported as unknown.
|
|
63
|
+
*/
|
|
64
|
+
export declare const KNOWN_BUILD_OPTIONS: string[];
|
|
65
|
+
/** The Vite mode that stands for a build target's plain options, when it has no default configuration. */
|
|
66
|
+
export declare const PLAIN_MODE = "default";
|
|
67
|
+
/** The legacy build and serve targets of a project, by name. */
|
|
68
|
+
export declare function findLegacyTargets(project: WorkspaceProject): {
|
|
69
|
+
build?: string;
|
|
70
|
+
serve?: string;
|
|
71
|
+
};
|
|
72
|
+
/**
|
|
73
|
+
* Analyzes the legacy `build` and `serve` targets of a project and plans the migration: the Vite
|
|
74
|
+
* setup, the new targets, the targets to retarget and every finding for the report.
|
|
75
|
+
*/
|
|
76
|
+
export declare function analyzeProject(tree: Tree, project: WorkspaceProject, buildName: string, serveName: string | undefined, options: AnalyzeOptions, builderKey: 'builder' | 'executor'): MigrationPlan;
|