@ng-doc/builder 22.0.0 → 22.2.0

package/helpers/playground/written-union-order.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.writtenUnionOrder = writtenUnionOrder;
+exports.writtenOrder = writtenOrder;
+exports.writtenTypeNode = writtenTypeNode;
+const ts_morph_1 = require("ts-morph");
+const is_input_1 = require("../angular/is-input");
+/**
+ * The members of `type`'s union in the order the author wrote them.
+ *
+ * The checker's order is not the author's: without `stableTypeOrdering` it is the creation order
+ * of the member types (which depends on what the checker was asked before), with it literals sort
+ * by value. A playground lists its options from that union, so the list is read from the syntax: the type node written for the input (its annotation, or the type
+ * argument of `input<T>()`, `input.required<T>()` or `model<T>()`), followed through unions,
+ * parentheses, non-generic type aliases and enums, to its literal members. Those members take their
+ * written order, in the positions they hold in the checker's list; every member the syntax does
+ * not name (`undefined` of an optional input, `boolean`'s literals, a generic alias) keeps the
+ * checker's position. Without a written node the checker's order is returned.
+ * @param declaration - The input property, accessor or pipe parameter.
+ * @param type - The input's type.
+ * @param members - The union's members in the order to fall back to (default: the checker's).
+ */
+function writtenUnionOrder(declaration, type, members = type.getUnionTypes()) {
+    return writtenOrder(writtenTypeNode(declaration), members);
+}
+/**
+ * The members of a union in the order a written type node names them (see
+ * {@link writtenUnionOrder}): the members the node names, through unions, parentheses,
+ * non-generic type aliases and enums, take their written order in the positions they hold in
+ * `members`; the others keep their positions. Without a node, `members` is returned.
+ * @param node - The type node the author wrote for the union, if any.
+ * @param members - The union's members in the order to fall back to.
+ */
+function writtenOrder(node, members) {
+    if (!node || members.length < 2)
+        return members;
+    const written = [];
+    collect(node, written, new Set());
+    const slots = new Set(members.map((member) => member.compilerType));
+    const order = written.filter((member, index) => slots.has(member) && written.indexOf(member) === index);
+    const named = new Set(order);
+    let next = 0;
+    const byCompiler = new Map(members.map((member) => [member.compilerType, member]));
+    return members.map((member) => named.has(member.compilerType) ? byCompiler.get(order[next++]) : member);
+}
+/**
+ * The type node the author wrote for an input or parameter, if any: its annotation, or the type
+ * argument of `input<T>()`, `input.required<T>()` or `model<T>()`.
+ * @param declaration - The input property, accessor or pipe parameter.
+ */
+function writtenTypeNode(declaration) {
+    if (ts_morph_1.Node.isPropertyDeclaration(declaration) && (0, is_input_1.isInputSignal)(declaration)) {
+        const initializer = declaration.getInitializer();
+        return ts_morph_1.Node.isCallExpression(initializer) ? initializer.getTypeArguments()[0] : undefined;
+    }
+    if (ts_morph_1.Node.isSetAccessorDeclaration(declaration))
+        return declaration.getParameters()[0]?.getTypeNode();
+    if (ts_morph_1.Node.isGetAccessorDeclaration(declaration))
+        return declaration.getReturnTypeNode();
+    if (ts_morph_1.Node.isPropertyDeclaration(declaration) || ts_morph_1.Node.isParameterDeclaration(declaration))
+        return declaration.getTypeNode();
+    return undefined;
+}
+/** Appends the member types `node` names, in written order. */
+function collect(node, into, seen) {
+    if (seen.has(node))
+        return;
+    seen.add(node);
+    if (ts_morph_1.Node.isUnionTypeNode(node)) {
+        node.getTypeNodes().forEach((member) => collect(member, into, seen));
+        return;
+    }
+    if (ts_morph_1.Node.isParenthesizedTypeNode(node)) {
+        collect(node.getTypeNode(), into, seen);
+        return;
+    }
+    if (ts_morph_1.Node.isTypeReference(node) && !node.getTypeArguments().length) {
+        let symbol = node.getTypeName().getSymbol();
+        if (symbol?.isAlias())
+            symbol = symbol.getAliasedSymbol();
+        const declaration = symbol?.getDeclarations()[0];
+        if (ts_morph_1.Node.isTypeAliasDeclaration(declaration) && !declaration.getTypeParameters().length) {
+            const aliased = declaration.getTypeNode();
+            if (aliased) {
+                collect(aliased, into, seen);
+                return;
+            }
+        }
+        if (ts_morph_1.Node.isEnumDeclaration(declaration)) {
+            // A member's declared type is the fresh literal type; a union holds the regular one.
+            declaration
+                .getMembers()
+                .forEach((member) => into.push(regularType(member.getType().compilerType)));
+            return;
+        }
+    }
+    into.push(node.getType().compilerType);
+}
+/**
+ * The regular type of a fresh literal type, which is the one unions hold; other types as they are.
+ * @param type - A type.
+ */
+function regularType(type) {
+    return type.regularType ?? type;
+}
+//# sourceMappingURL=written-union-order.js.map

package/helpers/playground/written-union-order.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"written-union-order.js","sourceRoot":"","sources":["../../../../../libs/builder/helpers/playground/written-union-order.ts"],"names":[],"mappings":";;AAmBA,8CAMC;AAUD,oCAcC;AAOD,0CAWC;AAnED,uCAAoD;AAEpD,kDAA2E;AAE3E;;;;;;;;;;;;;;GAcG;AACH,SAAgB,iBAAiB,CAC/B,WAAyC,EACzC,IAAU,EACV,UAAkB,IAAI,CAAC,aAAa,EAAE;IAEtC,OAAO,YAAY,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC,CAAC;AAC7D,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,YAAY,CAAC,IAA0B,EAAE,OAAe;IACtE,IAAI,CAAC,IAAI,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,OAAO,CAAC;IAChD,MAAM,OAAO,GAAc,EAAE,CAAC;IAC9B,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;IAClC,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;IACpE,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAC1B,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,KAAK,CAC1E,CAAC;IACF,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;IAC7B,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IACnF,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAC5B,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAE,CAAE,CAAC,CAAC,CAAC,MAAM,CAC1E,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,SAAgB,eAAe,CAAC,WAAyC;IACvE,IAAI,eAAI,CAAC,qBAAqB,CAAC,WAAW,CAAC,IAAI,IAAA,wBAAa,EAAC,WAAW,CAAC,EAAE,CAAC;QAC1E,MAAM,WAAW,GAAG,WAAW,CAAC,cAAc,EAAE,CAAC;QACjD,OAAO,eAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC5F,CAAC;IACD,IAAI,eAAI,CAAC,wBAAwB,CAAC,WAAW,CAAC;QAC5C,OAAO,WAAW,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC;IACvD,IAAI,eAAI,CAAC,wBAAwB,CAAC,WAAW,CAAC;QAAE,OAAO,WAAW,CAAC,iBAAiB,EAAE,CAAC;IACvF,IAAI,eAAI,CAAC,qBAAqB,CAAC,WAAW,CAAC,IAAI,eAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC;QACrF,OAAO,WAAW,CAAC,WAAW,EAAE,CAAC;IACnC,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,+DAA+D;AAC/D,SAAS,OAAO,CAAC,IAAc,EAAE,IAAe,EAAE,IAAe;IAC/D,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;QAAE,OAAO;IAC3B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACf,IAAI,eAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/B,IAAI,CAAC,YAAY,EAAE,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;QACrE,OAAO;IACT,CAAC;IACD,IAAI,eAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,EAAE,CAAC;QACvC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QACxC,OAAO;IACT,CAAC;IACD,IAAI,eAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,MAAM,EAAE,CAAC;QAClE,IAAI,MAAM,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,SAAS,EAAE,CAAC;QAC5C,IAAI,MAAM,EAAE,OAAO,EAAE;YAAE,MAAM,GAAG,MAAM,CAAC,gBAAgB,EAAE,CAAC;QAC1D,MAAM,WAAW,GAAG,MAAM,EAAE,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC;QACjD,IAAI,eAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,MAAM,EAAE,CAAC;YACxF,MAAM,OAAO,GAAG,WAAW,CAAC,WAAW,EAAE,CAAC;YAC1C,IAAI,OAAO,EAAE,CAAC;gBACZ,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;gBAC7B,OAAO;YACT,CAAC;QACH,CAAC;QACD,IAAI,eAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,EAAE,CAAC;YACxC,qFAAqF;YACrF,WAAW;iBACR,UAAU,EAAE;iBACZ,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAC9E,OAAO;QACT,CAAC;IACH,CAAC;IACD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,YAAY,CAAC,CAAC;AACzC,CAAC;AAED;;;GAGG;AACH,SAAS,WAAW,CAAC,IAAa;IAChC,OAAQ,IAA4C,CAAC,WAAW,IAAI,IAAI,CAAC;AAC3E,CAAC"}

package/helpers/to-template-string.d.ts

@@ -1,5 +1,9 @@
 /**
+ * Escapes text for the body of a template literal, so the literal evaluates to the text itself.
  *
- * @param content
+ * The backslash is escaped first: otherwise `\d` would evaluate to `d`, `\n` to a line break and
+ * `\203A` would fail to compile (octal escapes are not allowed in template literals), and the
+ * escapes added for `` ` `` and `${` must not be escaped again.
+ * @param content - The text to embed.
  */
 export declare function toTemplateString(content: string): string;

package/helpers/to-template-string.js

@@ -2,12 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toTemplateString = toTemplateString;
 /**
+ * Escapes text for the body of a template literal, so the literal evaluates to the text itself.
  *
- * @param content
+ * The backslash is escaped first: otherwise `\d` would evaluate to `d`, `\n` to a line break and
+ * `\203A` would fail to compile (octal escapes are not allowed in template literals), and the
+ * escapes added for `` ` `` and `${` must not be escaped again.
+ * @param content - The text to embed.
  */
 function toTemplateString(content) {
     return (content
-        ?.replace(/`/g, '\\`')
+        ?.replace(/\\/g, '\\\\')
+        .replace(/`/g, '\\`')
         .replace(/\${/g, '\\${')
         .replace(/{/g, '\\{')
         .replace(/}/g, '\\}') ?? '');

package/helpers/to-template-string.js.map

@@ -1 +1 @@
-{"version":3,"file":"to-template-string.js","sourceRoot":"","sources":["../../../../libs/builder/helpers/to-template-string.ts"],"names":[],"mappings":";;AAIA,4CAQC;AAZD;;;GAGG;AACH,SAAgB,gBAAgB,CAAC,OAAe;IAC/C,OAAO,CACN,OAAO;QACN,EAAE,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;SACrB,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC;SACvB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;SACpB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAC5B,CAAC;AACH,CAAC"}
+{"version":3,"file":"to-template-string.js","sourceRoot":"","sources":["../../../../libs/builder/helpers/to-template-string.ts"],"names":[],"mappings":";;AAQA,4CASC;AAjBD;;;;;;;GAOG;AACH,SAAgB,gBAAgB,CAAC,OAAe;IAC9C,OAAO,CACL,OAAO;QACL,EAAE,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC;SACvB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;SACpB,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC;SACvB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;SACpB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAC9B,CAAC;AACJ,CAAC"}

package/interfaces/code-block-options.d.ts

@@ -8,5 +8,10 @@ export interface NgDocCodeBlockParams {
     icon?: string;
     fileLineStart?: number;
     fileLineEnd?: number;
+    /**
+     * The snippet of `file` to show, from `file="./x.ts"#<id>`: the lines between the two
+     * `snippet#<id>` markers. Only the Vite engine reads it.
+     */
+    snippet?: string;
     highlightedLines?: number[];
 }

package/interfaces/configuration.d.ts

@@ -1,4 +1,4 @@
-import { NgDocHeading, NgDocKeywordsLoader } from '@ng-doc/core';
+import { NgDocDemoProvidersImport, NgDocHeading, NgDocKeywordsLoader } from '@ng-doc/core';
 import { NgDocGlobalKeyword } from '@ng-doc/core/interfaces/keyword-map';
 import { NgDocRepoConfig } from './repo-config';
 /**
@@ -43,6 +43,38 @@ export interface NgDocConfiguration {
      * The configuration for the guides
      */
     guide?: NgDocGuideConfiguration;
+    /**
+     * The configuration for the API pages. Only the Vite engine reads it.
+     */
+    api?: NgDocApiConfiguration;
+    /**
+     * Shows every demo of the `demo` action in an iframe, as `isolated: true` does for one demo
+     * (`false` by default). It also builds a demo page for every demo. Only the Vite engine reads it.
+     */
+    isolatedDemos?: boolean;
+    /**
+     * Renders the demos of every playground in iframes, as `isolated: true` does for one playground
+     * (`false` by default). It also builds the playground pages of every playground. Only the Vite
+     * engine reads it; the legacy engine renders playgrounds in the page.
+     */
+    isolatedPlaygrounds?: boolean;
+    /**
+     * The demo pages: one page per demo that loads only Angular and that demo, which isolated demos
+     * show in an iframe and "Open in new tab" opens, and one page per target of each playground,
+     * which isolated playgrounds show in iframes. Only the Vite engine builds them.
+     *
+     * By default only the pages with an isolated demo or playground get them. `true` (or an object)
+     * builds the demo pages of every page with demos; playground pages are built only for isolated
+     * playgrounds. `false` never builds them, and isolated demos and playgrounds render in the page.
+     */
+    demoApplication?: boolean | NgDocDemoApplicationConfiguration;
+    /**
+     * Imports the module whose default export lists the providers of the demo pages, for example
+     * `() => import('./demo.providers')`. It must be written in `ng-doc.config.ts` as an arrow
+     * function that returns one `import()` of a file. NgDoc never calls it while it generates; the
+     * demo pages import the module. Only the Vite engine reads it.
+     */
+    demoProviders?: NgDocDemoProvidersImport;
     /**
      * Shiki configuration
      */
@@ -51,8 +83,43 @@ export interface NgDocConfiguration {
             light: string;
             dark: string;
         };
+        /**
+         * Shiki language registrations that code blocks can use in addition to the languages bundled
+         * with Shiki, such as a grammar imported from a `.tmLanguage.json` file or from
+         * `@shikijs/langs`. A registration named like a bundled language replaces it. Only the Vite
+         * engine reads it; load the same languages in the browser with `provideNgDocApp`.
+         */
+        langs?: Array<NgDocShikiLanguage | readonly NgDocShikiLanguage[]>;
     };
 }
+/**
+ * A Shiki (TextMate) language registration: a grammar and the name that code blocks use for it.
+ * It must be plain JSON data, as in a `.tmLanguage.json` file or a module of `@shikijs/langs`.
+ */
+export interface NgDocShikiLanguage {
+    /** The language name: code blocks that name it (for example ` ```my-lang `) use the grammar. */
+    name: string;
+    /** The root scope of the grammar, such as `source.my-lang`. */
+    scopeName: string;
+    /** The name to display for the language. */
+    displayName?: string;
+    /** Other names that code blocks can use for the language. */
+    aliases?: string[];
+    /** The languages that the grammar embeds, which must be bundled or registered too. */
+    embeddedLangs?: string[];
+    /** The languages that the grammar embeds when they are loaded. */
+    embeddedLangsLazy?: string[];
+    /** The scopes that the grammar injects itself into. */
+    injectTo?: string[];
+    /** The TextMate rules of the grammar. */
+    patterns?: unknown;
+    /** The named TextMate rules that `patterns` include. */
+    repository?: unknown;
+    /** TextMate injections. */
+    injections?: unknown;
+    /** The selector of an injection grammar. */
+    injectionSelector?: string;
+}
 /**
  * The configuration for the guide page
  */
@@ -67,6 +134,30 @@ export interface NgDocGuideConfiguration {
      */
     headerTemplate?: string;
 }
+/**
+ * The configuration for the API pages.
+ */
+export interface NgDocApiConfiguration {
+    /**
+     * Whether API pages list the protected members of classes, inherited ones included
+     * (`true` by default). With `false`, they list only public members: hidden members get no row,
+     * anchor, search record or keyword.
+     */
+    protectedMembers?: boolean;
+}
+/**
+ * The configuration of the demo pages.
+ */
+export interface NgDocDemoApplicationConfiguration {
+    /**
+     * The URL path under which the demo pages are served, relative to the base href
+     * (`demo-preview` by default): a demo's page is `<base href><path>/<page route>/<demo name>/`.
+     * One or more URL segments of letters, digits, `-`, `_` and `.`; the first character of a
+     * segment is a letter or a digit, because some static hosts skip folders that start with `_`
+     * or `.`.
+     */
+    path?: string;
+}
 /**
  * The configuration for the global keywords.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ng-doc/builder",
-  "version": "22.0.0",
+  "version": "22.2.0",
   "description": "Generates an NgDoc documentation site from your Markdown pages and TypeScript code.",
   "keywords": [
     "angular",
@@ -31,8 +31,8 @@
     ]
   },
   "dependencies": {
-    "@ng-doc/core": "22.0.0",
-    "@ng-doc/utils": "22.0.0",
+    "@ng-doc/core": "22.2.0",
+    "@ng-doc/utils": "22.2.0",
     "@angular-devkit/architect": ">=0.2200.0 <0.2300.0",
     "minimatch": "9.0.9",
     "rxjs": "^7.0.0",
@@ -56,7 +56,8 @@
     "parsimmon": "^1.18.1",
     "@parcel/watcher": "^2.5.0",
     "@microsoft/tsdoc": "0.15.1",
-    "@shikijs/rehype": "1.10.3",
+    "@shikijs/rehype": "4.5.0",
+    "shiki": "4.5.0",
     "css-what": "6.1.0",
     "github-slugger": "2.0.0",
     "hast-util-has-property": "3.0.0",
@@ -121,7 +122,7 @@
     "ng-doc": "./generator/bootstrap/bin.js"
   },
   "engines": {
-    "node": ">=24.15.0 <25"
+    "node": ">=24.15.0 <25 || >=26.0.0 <27"
   },
   "author": "Skoropad Aleksandr <alex@skoropad.dev>"
 }

package/parsers/parse-code-block-params.d.ts

@@ -1,6 +1,15 @@
 import type { NgDocCodeBlockParams } from '../interfaces/code-block-options';
+/** Options of {@link parseCodeBlockParams}. */
+export interface NgDocCodeBlockParserOptions {
+    /**
+     * Whether a fragment after the `file` parameter may name a snippet: `file="./x.ts"#greeting`.
+     * Without it, only line ranges are accepted, and any other fragment fails to parse.
+     */
+    snippets?: boolean;
+}
 /**
  * Code block options parser
  * @param options - Options string to parse
+ * @param parserOptions - What the caller supports beyond the original syntax.
  */
-export declare function parseCodeBlockParams(options: string): NgDocCodeBlockParams;
+export declare function parseCodeBlockParams(options: string, parserOptions?: NgDocCodeBlockParserOptions): NgDocCodeBlockParams;

package/parsers/parse-code-block-params.js

@@ -10,11 +10,31 @@ const helpers_1 = require("./helpers");
  * whitespace end it, so the parameters that follow are parsed as before.
  */
 const CODE_BLOCK_LANGUAGE = /[\p{L}\p{N}+#-]+/u;
+/** The characters of a snippet id, as `// snippet#<id>` markers spell it (`parseSnippet`). */
+const SNIPPET_ID = /[a-zA-Z0-9-]+/;
+/** A fragment that is a line range: `L<n>`, `L<n>-` or `L<n>-L<m>`. */
+const LINE_RANGE = /^L(\d+)(?:(-)(?:L(\d+))?)?$/;
+/**
+ * The fragment after a `file` parameter when snippets are on: `#L<n>`, `#L<n>-` and
+ * `#L<n>-L<m>` are line ranges (the same ranges as without snippets), any other id names a
+ * snippet.
+ * @param fragment - The fragment without its `#`.
+ */
+function fileFragment(fragment) {
+    const range = LINE_RANGE.exec(fragment);
+    if (!range)
+        return { snippet: fragment };
+    const fileLineStart = Number(range[1]) - 1;
+    if (!range[2])
+        return { fileLineStart, fileLineEnd: fileLineStart + 1 };
+    return { fileLineStart, fileLineEnd: range[3] === undefined ? undefined : Number(range[3]) };
+}
 /**
  * Code block options parser
  * @param options - Options string to parse
+ * @param parserOptions - What the caller supports beyond the original syntax.
  */
-function parseCodeBlockParams(options) {
+function parseCodeBlockParams(options, parserOptions = {}) {
     const parser = parsimmon_1.default.createLanguage({
         language: () => parsimmon_1.default.regexp(CODE_BLOCK_LANGUAGE)
             .skip(parsimmon_1.default.optWhitespace)
@@ -28,7 +48,9 @@ function parseCodeBlockParams(options) {
             .then(p['fileLineNumber'])
             .map((num) => num - 1)
             .map((fileLineStart) => ({ fileLineStart, fileLineEnd: fileLineStart + 1 })),
-        lineParams: (p) => p['fileLineRange'].or(p['fileLineStart']).fallback({}),
+        lineParams: (p) => (parserOptions.snippets
+            ? parsimmon_1.default.string('#').then(parsimmon_1.default.regexp(SNIPPET_ID)).map(fileFragment)
+            : p['fileLineRange'].or(p['fileLineStart'])).fallback({}),
         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)),
         // Main Parsers
         lineNumbers: () => parsimmon_1.default.string('lineNumbers').map(() => ({ lineNumbers: true })),
@@ -38,7 +60,11 @@ function parseCodeBlockParams(options) {
         fileName: () => (0, helpers_1.param)('fileName', 'name'),
         icon: () => (0, helpers_1.param)('icon'),
         active: () => parsimmon_1.default.string('active').map(() => ({ active: true })),
-        file: (p) => parsimmon_1.default.seq(p['filePath'], p['lineParams'].map(({ fileLineStart, fileLineEnd }) => ({ fileLineStart, fileLineEnd }))).map(([file, lineParams]) => ({ ...file, ...lineParams })),
+        file: (p) => parsimmon_1.default.seq(p['filePath'], p['lineParams'].map(({ fileLineStart, fileLineEnd, snippet }) => ({
+            fileLineStart,
+            fileLineEnd,
+            ...(snippet === undefined ? {} : { snippet }),
+        }))).map(([file, lineParams]) => ({ ...file, ...lineParams })),
         highlightedLines: (p) => p['highlightedLinesRange']
             .or(helpers_1.number)
             .sepBy(parsimmon_1.default.string(',').then(parsimmon_1.default.optWhitespace))

package/parsers/parse-code-block-params.js.map

@@ -1 +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"}
+{"version":3,"file":"parse-code-block-params.js","sourceRoot":"","sources":["../../../../libs/builder/parsers/parse-code-block-params.ts"],"names":[],"mappings":";;AA8CA,oDA6FC;;AA3ID,kEAA0B;AAG1B,uCAA0C;AAE1C;;;;GAIG;AACH,MAAM,mBAAmB,GAAW,mBAAmB,CAAC;AAExD,8FAA8F;AAC9F,MAAM,UAAU,GAAW,eAAe,CAAC;AAE3C,uEAAuE;AACvE,MAAM,UAAU,GAAW,6BAA6B,CAAC;AAWzD;;;;;GAKG;AACH,SAAS,YAAY,CAAC,QAAgB;IACpC,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACxC,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC;IACzC,MAAM,aAAa,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAC3C,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QAAE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,aAAa,GAAG,CAAC,EAAE,CAAC;IACxE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAC/F,CAAC;AAED;;;;GAIG;AACH,SAAgB,oBAAoB,CAClC,OAAe,EACf,gBAA6C,EAAE;IAE/C,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,CAChB,CAAC,aAAa,CAAC,QAAQ;YACrB,CAAC,CAAC,mBAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,mBAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC;YAC5D,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAC5C,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChB,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,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;YAChE,aAAa;YACb,WAAW;YACX,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC;SAC9C,CAAC,CAAC,CACJ,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/schematics/collection.json

@@ -22,7 +22,7 @@
       "schema": "./migrate-to-vite/schema.json"
     },
     "vite-setup": {
-      "description": "Sets up the Vite engine for a project on Angular's application builder (run by ng add @ng-doc/add)",
+      "description": "Sets up the Vite engine for a project on Angular's application builder or Nx's application executor (run by ng add @ng-doc/add)",
       "factory": "./vite-setup/index#viteSetup",
       "schema": "./vite-setup/schema.json",
       "hidden": true

package/schematics/migrate-to-vite/analyze.js

@@ -106,7 +106,15 @@ const MANUAL = {
     serviceWorker: 'The Vite engine does not build the Angular service worker.',
     subresourceIntegrity: 'Use a Vite plugin to add `integrity` attributes.',
     webWorkerTsConfig: 'Vite bundles workers created with `new Worker(new URL(...))` itself.',
+    // Nx's `application` executor runs Angular's builder with these options of its own.
+    indexHtmlTransformer: 'Nx transforms index.html with this function; move it to a Vite plugin with a `transformIndexHtml` hook.',
+    plugins: 'Nx runs these esbuild plugins and Vite does not; add a Vite plugin that does the same to the Vite configuration.',
 };
+/**
+ * `buildLibsFromSource: false` of Nx's executors: Nx builds the buildable libraries first and
+ * resolves them to their output.
+ */
+const BUILD_LIBS_FROM_SOURCE = 'is `false`; the Vite engine reads the workspace libraries from source through the tsconfig `paths` and does not build them first.';
 function isRecord(value) {
     return typeof value === 'object' && value !== null && !Array.isArray(value);
 }
@@ -526,11 +534,17 @@ function analyzeProject(tree, project, buildName, serveName, options, builderKey
             else
                 add('dropped', 'build.outputHashing', 'Vite hashes the output file names by default.');
         }
-        else if (option === 'scripts') {
+        else if (option === 'scripts' || option === 'plugins') {
             if (values.some((value) => Array.isArray(value) && value.length))
-                add('manual', 'build.scripts', MANUAL['scripts']);
+                add('manual', `build.${option}`, MANUAL[option]);
+            else
+                add('dropped', `build.${option}`, 'The list is empty.');
+        }
+        else if (option === 'buildLibsFromSource') {
+            if (values.includes(false))
+                add('manual', 'build.buildLibsFromSource', BUILD_LIBS_FROM_SOURCE);
             else
-                add('dropped', 'build.scripts', 'The list is empty.');
+                add('dropped', 'build.buildLibsFromSource', 'The Vite engine reads the workspace libraries from source through the tsconfig `paths`.');
         }
         else if (option === 'serviceWorker') {
             if (active.length)
@@ -744,6 +758,35 @@ function analyzeServe(project, serveName, buildName, build, add, plainMode) {
             case 'verbose':
                 add('dropped', subject, 'Vite prebundles dependencies and logs by its own settings.');
                 break;
+            // The options Nx's `dev-server` executor adds to Angular's.
+            case 'buildLibsFromSource':
+                if (value === false)
+                    add('manual', subject, BUILD_LIBS_FROM_SOURCE);
+                else
+                    add('dropped', subject, 'The Vite engine reads the workspace libraries from source.');
+                break;
+            case 'watchDependencies':
+                add('dropped', subject, 'The Vite engine watches the library sources it reads.');
+                break;
+            case 'forceEsbuild':
+            case 'publicHost':
+                add('dropped', subject, 'Nx uses it with webpack-based builds only.');
+                break;
+            case 'disableHostCheck':
+                if (value === true) {
+                    devServer.allowedHosts = true;
+                    add('migrated', subject, 'Vite `server.allowedHosts: true`.');
+                }
+                else
+                    add('dropped', subject, 'The host check is on.');
+                break;
+            case 'esbuildMiddleware':
+                if (Array.isArray(value) && value.length) {
+                    add('manual', subject, 'Add these middleware functions with the `configureServer` hook of a Vite plugin.');
+                }
+                else
+                    add('dropped', subject, 'The list is empty.');
+                break;
             case 'ngDoc':
                 add('manual', subject, 'The development server uses the NgDoc settings of the build target.');
                 break;