@ng-doc/builder 22.0.0-beta.2 → 22.1.0

package/schematics/migrate-to-vite/setup/dependencies.d.ts

@@ -0,0 +1,64 @@
+import { Tree } from '@angular-devkit/schematics';
+/**
+ * The packages the Vite engine needs next to `@ng-doc/builder`, with the version ranges it is
+ * released and tested with (`ng-doc.viteEngine` in the package's own manifest), so the schematic of
+ * a release always installs that release's ranges. Each is a caret range (`^8.3.0`): npm installs
+ * the newest matching release, and nothing is pinned.
+ */
+export declare function ngDocViteDependencies(): {
+    [name: string]: string;
+};
+/** Whether the Vite engine refuses to start with a version of this package outside its range. */
+export declare function isEnforced(name: string): boolean;
+/** A dependency the workspace has at a version outside the Vite engine's range. */
+export interface DependencyMismatch {
+    name: string;
+    expected: string;
+    /** The specifier in `package.json`. */
+    found: string;
+    /** The installed version, when it is what lies outside the range. */
+    installed?: string;
+}
+/** The report line of a dependency mismatch, with the command that fixes an enforced one. */
+export declare function dependencyMismatchText({ name, expected, found, installed, }: DependencyMismatch): string;
+/**
+ * Whether a declared dependency specifier can resolve to a version inside `required` (a caret
+ * range): true when it does, false when it cannot, and undefined when the specifier is not a plain
+ * version, caret or tilde range (a tag, a URL, `>=`, `||`, `x`), which this check cannot tell.
+ * @param declared - The specifier in the workspace's `package.json`.
+ * @param required - The engine's range, such as `^8.3.0`.
+ */
+export declare function admitsRange(declared: string, required: string): boolean | undefined;
+/**
+ * Adds the missing Vite engine dependencies to the `devDependencies` of `package.json`. A package
+ * the workspace already declares is left as it is: nothing is added when its installed version
+ * (or, before an install, its specifier) satisfies the engine's range, and it is returned as a
+ * mismatch when it cannot.
+ */
+export declare function addNgDocViteDependencies(tree: Tree, dependencies?: {
+    [name: string]: string;
+}): {
+    added: {
+        [name: string]: string;
+    };
+    mismatches: DependencyMismatch[];
+};
+/**
+ * The SHA-256 of a file's content without its layout, as recorded in the migration state. The
+ * Angular CLI formats the files a schematic wrote with the workspace's Prettier configuration, so
+ * whitespace and trailing commas are left out: a formatted file still counts as the one the
+ * migration wrote, and any other change counts as the user's.
+ */
+export declare function hashContent(content: string): string;
+/**
+ * Adds a line to `.gitignore` when no existing line already ignores it. Returns whether the file
+ * changed; false also when the workspace has no `.gitignore`.
+ * @param tree - The workspace tree.
+ * @param line - The line, such as `/.cache/ng-doc`.
+ * @param comment - The comment written above it.
+ */
+export declare function addGitIgnoreLine(tree: Tree, line: string, comment?: string): boolean;
+/** Reads `compilerOptions.paths` of a tsconfig and of the files it extends, nearest first. */
+export declare function readTsconfigPaths(tree: Tree, file: string): {
+    [alias: string]: string[];
+} | undefined;

package/schematics/migrate-to-vite/setup/dependencies.js

@@ -0,0 +1,183 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ngDocViteDependencies = ngDocViteDependencies;
+exports.isEnforced = isEnforced;
+exports.dependencyMismatchText = dependencyMismatchText;
+exports.admitsRange = admitsRange;
+exports.addNgDocViteDependencies = addNgDocViteDependencies;
+exports.hashContent = hashContent;
+exports.addGitIgnoreLine = addGitIgnoreLine;
+exports.readTsconfigPaths = readTsconfigPaths;
+const crypto_1 = require("crypto");
+const fs_1 = require("fs");
+const path_1 = require("path");
+const json_file_1 = require("./json-file");
+/**
+ * The packages the Vite engine needs next to `@ng-doc/builder`, with the version ranges it is
+ * released and tested with (`ng-doc.viteEngine` in the package's own manifest), so the schematic of
+ * a release always installs that release's ranges. Each is a caret range (`^8.3.0`): npm installs
+ * the newest matching release, and nothing is pinned.
+ */
+function ngDocViteDependencies() {
+    const manifest = JSON.parse((0, fs_1.readFileSync)((0, path_1.join)(__dirname, '../../../package.json'), 'utf8'));
+    return Object.fromEntries(Object.entries(manifest['ng-doc']?.viteEngine ?? {}).sort());
+}
+/**
+ * The packages whose version the Vite engine checks when it starts: it refuses any version outside
+ * the range, while the others only differ from what it is tested with.
+ */
+const ENFORCED = new Set(['vite']);
+/** Whether the Vite engine refuses to start with a version of this package outside its range. */
+function isEnforced(name) {
+    return ENFORCED.has(name);
+}
+/** The report line of a dependency mismatch, with the command that fixes an enforced one. */
+function dependencyMismatchText({ name, expected, found, installed, }) {
+    const is = `\`${name}\` is \`${found}\`${installed ? ` (installed \`${installed}\`)` : ''}`;
+    return isEnforced(name)
+        ? `${is}; the Vite engine requires \`${expected}\` and does not start ` +
+            `with another version. Update it: \`npm i -D ${name}@${expected}\`.`
+        : `${is}; the Vite engine is tested with \`${expected}\`.`;
+}
+const VERSION = /^v?(\d+)\.(\d+)\.(\d+)(?:[-+][0-9A-Za-z.+-]*)?$/;
+function parseVersion(text) {
+    const match = VERSION.exec(text.trim());
+    return match ? [Number(match[1]), Number(match[2]), Number(match[3])] : undefined;
+}
+function compare(left, right) {
+    for (let index = 0; index < 3; index++) {
+        if (left[index] !== right[index])
+            return left[index] - right[index];
+    }
+    return 0;
+}
+/** The lower bound and the exclusive upper bound a caret range (`^8.3.0`, major ≥ 1) admits. */
+function caretBounds(range) {
+    const version = range.startsWith('^') ? parseVersion(range.slice(1)) : undefined;
+    return version && version[0] > 0 ? [version, [version[0] + 1, 0, 0]] : undefined;
+}
+/**
+ * Whether a declared dependency specifier can resolve to a version inside `required` (a caret
+ * range): true when it does, false when it cannot, and undefined when the specifier is not a plain
+ * version, caret or tilde range (a tag, a URL, `>=`, `||`, `x`), which this check cannot tell.
+ * @param declared - The specifier in the workspace's `package.json`.
+ * @param required - The engine's range, such as `^8.3.0`.
+ */
+function admitsRange(declared, required) {
+    const bounds = caretBounds(required);
+    if (!bounds)
+        return undefined;
+    const [low, high] = bounds;
+    const text = declared.trim();
+    const operator = /^[\^~=]/.exec(text)?.[0];
+    const version = parseVersion(operator ? text.slice(1) : text);
+    if (!version)
+        return undefined;
+    if (!operator || operator === '=')
+        return compare(version, low) >= 0 && compare(version, high) < 0;
+    // `^0.y.z` and `~x.y.z` stay below the next minor; `^x.y.z` below the next major.
+    const upper = operator === '~' || version[0] === 0 ? [version[0], version[1] + 1, 0] : [version[0] + 1, 0, 0];
+    return compare(version, high) < 0 && compare(upper, low) > 0;
+}
+/**
+ * The version of a package installed in the workspace's `node_modules`, when the tree can read
+ * it (a real workspace; schematic test trees have none).
+ */
+function installedVersion(tree, name) {
+    const file = `node_modules/${name}/package.json`;
+    if (!tree.exists(file))
+        return undefined;
+    try {
+        const version = JSON.parse(tree.readText(file)).version;
+        return typeof version === 'string' ? version : undefined;
+    }
+    catch {
+        return undefined;
+    }
+}
+/**
+ * Adds the missing Vite engine dependencies to the `devDependencies` of `package.json`. A package
+ * the workspace already declares is left as it is: nothing is added when its installed version
+ * (or, before an install, its specifier) satisfies the engine's range, and it is returned as a
+ * mismatch when it cannot.
+ */
+function addNgDocViteDependencies(tree, dependencies = ngDocViteDependencies()) {
+    const added = {};
+    const mismatches = [];
+    if (!tree.exists('package.json'))
+        return { added, mismatches };
+    const json = new json_file_1.JsonFile(tree, 'package.json');
+    for (const [name, expected] of Object.entries(dependencies)) {
+        const found = json.get(['dependencies', name]) ??
+            json.get(['devDependencies', name]);
+        if (found === undefined) {
+            json.modify(['devDependencies', name], expected);
+            added[name] = expected;
+            continue;
+        }
+        const installed = installedVersion(tree, name);
+        if (installed !== undefined) {
+            if (admitsRange(installed, expected) === false) {
+                mismatches.push({ name, expected, found, installed });
+            }
+        }
+        else if (admitsRange(found, expected) === false) {
+            mismatches.push({ name, expected, found });
+        }
+    }
+    return { added, mismatches };
+}
+/**
+ * The SHA-256 of a file's content without its layout, as recorded in the migration state. The
+ * Angular CLI formats the files a schematic wrote with the workspace's Prettier configuration, so
+ * whitespace and trailing commas are left out: a formatted file still counts as the one the
+ * migration wrote, and any other change counts as the user's.
+ */
+function hashContent(content) {
+    const normalized = content.replace(/\s+/g, '').replace(/,(?=[)\]}])/g, '');
+    return (0, crypto_1.createHash)('sha256').update(normalized).digest('hex');
+}
+const CACHE_LINES = new Set(['.cache', '.cache/', '.cache/ng-doc', '.cache/ng-doc/']);
+/**
+ * Adds a line to `.gitignore` when no existing line already ignores it. Returns whether the file
+ * changed; false also when the workspace has no `.gitignore`.
+ * @param tree - The workspace tree.
+ * @param line - The line, such as `/.cache/ng-doc`.
+ * @param comment - The comment written above it.
+ */
+function addGitIgnoreLine(tree, line, comment = 'NgDoc cache') {
+    if (!tree.exists('.gitignore'))
+        return false;
+    const text = tree.readText('.gitignore');
+    const wanted = line.replace(/^\//, '');
+    const covered = text
+        .split(/\r?\n/)
+        .map((entry) => entry.trim().replace(/^\//, ''))
+        .some((entry) => entry === wanted ||
+        entry === `${wanted}/` ||
+        (CACHE_LINES.has(entry) && CACHE_LINES.has(wanted)));
+    if (covered)
+        return false;
+    const separator = text === '' || text.endsWith('\n') ? '' : '\n';
+    tree.overwrite('.gitignore', `${text}${separator}\n# ${comment}\n${line}\n`);
+    return true;
+}
+/** Reads `compilerOptions.paths` of a tsconfig and of the files it extends, nearest first. */
+function readTsconfigPaths(tree, file) {
+    const seen = new Set();
+    let current = file;
+    while (current && tree.exists(current) && !seen.has(current)) {
+        seen.add(current);
+        const json = new json_file_1.JsonFile(tree, current);
+        const paths = json.get(['compilerOptions', 'paths']);
+        if (paths && typeof paths === 'object')
+            return paths;
+        const extended = json.get(['extends']);
+        current =
+            typeof extended === 'string' && extended.startsWith('.')
+                ? path_1.posix.join(path_1.posix.dirname(current), extended)
+                : undefined;
+    }
+    return undefined;
+}
+//# sourceMappingURL=dependencies.js.map

package/schematics/migrate-to-vite/setup/dependencies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dependencies.js","sourceRoot":"","sources":["../../../../../../libs/builder/schematics/migrate-to-vite/setup/dependencies.ts"],"names":[],"mappings":";;AAaA,sDAKC;AASD,gCAEC;AAaD,wDAWC;AA+BD,kCAcC;AAuBD,4DA2BC;AAQD,kCAGC;AAWD,4CAqBC;AAGD,8CAkBC;AAnND,mCAAoC;AACpC,2BAAkC;AAClC,+BAAmC;AAEnC,2CAAuC;AAEvC;;;;;GAKG;AACH,SAAgB,qBAAqB;IACnC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAA,iBAAY,EAAC,IAAA,WAAI,EAAC,SAAS,EAAE,uBAAuB,CAAC,EAAE,MAAM,CAAC,CAEzF,CAAC;IACF,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,UAAU,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;AACzF,CAAC;AAED;;;GAGG;AACH,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AAEnC,iGAAiG;AACjG,SAAgB,UAAU,CAAC,IAAY;IACrC,OAAO,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC;AAYD,6FAA6F;AAC7F,SAAgB,sBAAsB,CAAC,EACrC,IAAI,EACJ,QAAQ,EACR,KAAK,EACL,SAAS,GACU;IACnB,MAAM,EAAE,GAAG,KAAK,IAAI,WAAW,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,iBAAiB,SAAS,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAC5F,OAAO,UAAU,CAAC,IAAI,CAAC;QACrB,CAAC,CAAC,GAAG,EAAE,gCAAgC,QAAQ,wBAAwB;YACnE,+CAA+C,IAAI,IAAI,QAAQ,KAAK;QACxE,CAAC,CAAC,GAAG,EAAE,sCAAsC,QAAQ,KAAK,CAAC;AAC/D,CAAC;AAID,MAAM,OAAO,GAAG,iDAAiD,CAAC;AAElE,SAAS,YAAY,CAAC,IAAY;IAChC,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;IACxC,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACpF,CAAC;AAED,SAAS,OAAO,CAAC,IAAa,EAAE,KAAc;IAC5C,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC;QACvC,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,KAAK,CAAC,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC,KAAK,CAAE,GAAG,KAAK,CAAC,KAAK,CAAE,CAAC;IACxE,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,gGAAgG;AAChG,SAAS,WAAW,CAAC,KAAa;IAChC,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACjF,OAAO,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACnF,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,WAAW,CAAC,QAAgB,EAAE,QAAgB;IAC5D,MAAM,MAAM,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;IACrC,IAAI,CAAC,MAAM;QAAE,OAAO,SAAS,CAAC;IAC9B,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,MAAM,CAAC;IAC3B,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;IAC7B,MAAM,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,OAAO,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC9D,IAAI,CAAC,OAAO;QAAE,OAAO,SAAS,CAAC;IAC/B,IAAI,CAAC,QAAQ,IAAI,QAAQ,KAAK,GAAG;QAC/B,OAAO,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IAClE,kFAAkF;IAClF,MAAM,KAAK,GACT,QAAQ,KAAK,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAClG,OAAO,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;AAC/D,CAAC;AAED;;;GAGG;AACH,SAAS,gBAAgB,CAAC,IAAU,EAAE,IAAY;IAChD,MAAM,IAAI,GAAG,gBAAgB,IAAI,eAAe,CAAC;IACjD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QAAE,OAAO,SAAS,CAAC;IACzC,IAAI,CAAC;QACH,MAAM,OAAO,GAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAA2B,CAAC,OAAO,CAAC;QACnF,OAAO,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAgB,wBAAwB,CACtC,IAAU,EACV,eAA2C,qBAAqB,EAAE;IAElE,MAAM,KAAK,GAA+B,EAAE,CAAC;IAC7C,MAAM,UAAU,GAAyB,EAAE,CAAC;IAC5C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;QAAE,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;IAC/D,MAAM,IAAI,GAAG,IAAI,oBAAQ,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IAChD,KAAK,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;QAC5D,MAAM,KAAK,GACR,IAAI,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,IAAI,CAAC,CAAwB;YACvD,IAAI,CAAC,GAAG,CAAC,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAwB,CAAC;QAC9D,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,IAAI,CAAC,MAAM,CAAC,CAAC,iBAAiB,EAAE,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAC;YACjD,KAAK,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;YACvB,SAAS;QACX,CAAC;QACD,MAAM,SAAS,GAAG,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC/C,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,IAAI,WAAW,CAAC,SAAS,EAAE,QAAQ,CAAC,KAAK,KAAK,EAAE,CAAC;gBAC/C,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;YACxD,CAAC;QACH,CAAC;aAAM,IAAI,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,KAAK,EAAE,CAAC;YAClD,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;AAC/B,CAAC;AAED;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,OAAe;IACzC,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IAC3E,OAAO,IAAA,mBAAU,EAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,SAAS,EAAE,eAAe,EAAE,gBAAgB,CAAC,CAAC,CAAC;AAEtF;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAC9B,IAAU,EACV,IAAY,EACZ,UAAkB,aAAa;IAE/B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;QAAE,OAAO,KAAK,CAAC;IAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IACzC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IACvC,MAAM,OAAO,GAAG,IAAI;SACjB,KAAK,CAAC,OAAO,CAAC;SACd,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;SAC/C,IAAI,CACH,CAAC,KAAK,EAAE,EAAE,CACR,KAAK,KAAK,MAAM;QAChB,KAAK,KAAK,GAAG,MAAM,GAAG;QACtB,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CACtD,CAAC;IACJ,IAAI,OAAO;QAAE,OAAO,KAAK,CAAC;IAC1B,MAAM,SAAS,GAAG,IAAI,KAAK,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IACjE,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,GAAG,IAAI,GAAG,SAAS,OAAO,OAAO,KAAK,IAAI,IAAI,CAAC,CAAC;IAC7E,OAAO,IAAI,CAAC;AACd,CAAC;AAED,8FAA8F;AAC9F,SAAgB,iBAAiB,CAC/B,IAAU,EACV,IAAY;IAEZ,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,IAAI,OAAO,GAAuB,IAAI,CAAC;IACvC,OAAO,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7D,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAClB,MAAM,IAAI,GAAa,IAAI,oBAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACnD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAY,CAAC;QAChE,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,KAAsC,CAAC;QACtF,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAY,CAAC;QAClD,OAAO;YACL,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC;gBACtD,CAAC,CAAC,YAAK,CAAC,IAAI,CAAC,YAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC;gBAC9C,CAAC,CAAC,SAAS,CAAC;IAClB,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/schematics/migrate-to-vite/setup/index.d.ts

@@ -0,0 +1,6 @@
+export * from './dependencies';
+export * from './json-file';
+export * from './source';
+export * from './targets';
+export * from './vite-config';
+export * from './workspace';

package/schematics/migrate-to-vite/setup/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+// The building blocks of an NgDoc project on the Vite engine: the Vite configuration, the Angular
+// CLI targets, the dependencies and the workspace files. The migration schematic assembles them
+// from a legacy build target; a new project can assemble them from its own options.
+tslib_1.__exportStar(require("./dependencies"), exports);
+tslib_1.__exportStar(require("./json-file"), exports);
+tslib_1.__exportStar(require("./source"), exports);
+tslib_1.__exportStar(require("./targets"), exports);
+tslib_1.__exportStar(require("./vite-config"), exports);
+tslib_1.__exportStar(require("./workspace"), exports);
+//# sourceMappingURL=index.js.map

package/schematics/migrate-to-vite/setup/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../libs/builder/schematics/migrate-to-vite/setup/index.ts"],"names":[],"mappings":";;;AAAA,kGAAkG;AAClG,gGAAgG;AAChG,oFAAoF;AACpF,yDAA+B;AAC/B,sDAA4B;AAC5B,mDAAyB;AACzB,oDAA0B;AAC1B,wDAA8B;AAC9B,sDAA4B"}

package/schematics/migrate-to-vite/setup/json-file.d.ts

@@ -0,0 +1,51 @@
+import { Tree } from '@angular-devkit/schematics';
+/** A path into a JSON document: property names and array indexes. */
+export type JsonPath = Array<string | number>;
+/**
+ * Where `modify` inserts a new property: `undefined` keeps the properties sorted by name (as
+ * ng-morph's `JSONFile` does), `false` appends, a function returns the index among the existing
+ * property names.
+ */
+export type JsonInsertion = ((properties: string[]) => number) | false | undefined;
+/**
+ * A JSON file of the tree, read as JSONC the way the Angular CLI reads `angular.json`, Nx
+ * `project.json` and tsconfig files: comments and trailing commas are accepted. Edits are applied
+ * as text edits, so comments, key order and layout outside the edited value stay as they were.
+ */
+export declare class JsonFile {
+    private readonly tree;
+    readonly path: string;
+    private content;
+    private ast;
+    /**
+     * Reads the file.
+     * @param tree - The workspace tree.
+     * @param path - The file, workspace-relative.
+     */
+    constructor(tree: Tree, path: string);
+    private root;
+    /**
+     * The value at a path, or undefined.
+     * @param path - The path; empty for the whole document.
+     */
+    get(path: JsonPath): unknown;
+    /**
+     * Sets the value at a path (`undefined` removes it) and writes the file.
+     * @param path - The path.
+     * @param value - The new value.
+     * @param insertion - Where a new property goes.
+     */
+    modify(path: JsonPath, value: unknown, insertion?: JsonInsertion): void;
+    /**
+     * Removes the value at a path, if there is one.
+     * @param path - The path.
+     */
+    remove(path: JsonPath): void;
+    /**
+     * Renames the property at a path by rewriting its key only, so its value keeps its text, its
+     * comments and its place among its siblings. Does nothing when there is no such property.
+     * @param path - The path of the property.
+     * @param name - The new name, which no sibling may have.
+     */
+    rename(path: JsonPath, name: string): void;
+}

package/schematics/migrate-to-vite/setup/json-file.js

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JsonFile = void 0;
+const jsonc_parser_1 = require("jsonc-parser");
+const text_order_1 = require("../../../helpers/text-order");
+/**
+ * The indentation and line ending the file already uses, so an edit keeps its layout. Files
+ * without an indented line get two spaces.
+ * @param content - The file's text.
+ */
+function formattingOf(content) {
+    const indented = /^([ \t]+)\S/m.exec(content)?.[1];
+    const eol = content.includes('\r\n') ? '\r\n' : '\n';
+    if (indented?.startsWith('\t'))
+        return { insertSpaces: false, tabSize: 1, eol };
+    return { insertSpaces: true, tabSize: indented?.length ?? 2, eol };
+}
+/**
+ * A JSON file of the tree, read as JSONC the way the Angular CLI reads `angular.json`, Nx
+ * `project.json` and tsconfig files: comments and trailing commas are accepted. Edits are applied
+ * as text edits, so comments, key order and layout outside the edited value stay as they were.
+ */
+class JsonFile {
+    /**
+     * Reads the file.
+     * @param tree - The workspace tree.
+     * @param path - The file, workspace-relative.
+     */
+    constructor(tree, path) {
+        this.tree = tree;
+        this.path = path;
+        if (!tree.exists(path))
+            throw new Error(`Could not read '${path}'.`);
+        this.content = tree.readText(path);
+    }
+    root() {
+        if (this.ast)
+            return this.ast;
+        const errors = [];
+        this.ast = (0, jsonc_parser_1.parseTree)(this.content, errors, {
+            allowTrailingComma: true,
+            disallowComments: false,
+        });
+        if (errors.length) {
+            const { error, offset } = errors[0];
+            throw new Error(`[${this.path}] ${(0, jsonc_parser_1.printParseErrorCode)(error)} at offset ${offset}.`);
+        }
+        return this.ast;
+    }
+    /**
+     * The value at a path, or undefined.
+     * @param path - The path; empty for the whole document.
+     */
+    get(path) {
+        const root = this.root();
+        if (!root)
+            return undefined;
+        const node = path.length ? (0, jsonc_parser_1.findNodeAtLocation)(root, path) : root;
+        return node ? (0, jsonc_parser_1.getNodeValue)(node) : undefined;
+    }
+    /**
+     * Sets the value at a path (`undefined` removes it) and writes the file.
+     * @param path - The path.
+     * @param value - The new value.
+     * @param insertion - Where a new property goes.
+     */
+    modify(path, value, insertion) {
+        const property = path[path.length - 1];
+        const getInsertionIndex = insertion === undefined
+            ? (properties) => [...properties, String(property)].sort(text_order_1.compareText).indexOf(String(property))
+            : insertion === false
+                ? undefined
+                : insertion;
+        const edits = (0, jsonc_parser_1.modify)(this.content, path, value, {
+            getInsertionIndex,
+            formattingOptions: formattingOf(this.content),
+        });
+        this.content = (0, jsonc_parser_1.applyEdits)(this.content, edits);
+        this.ast = undefined;
+        this.tree.overwrite(this.path, this.content);
+    }
+    /**
+     * Removes the value at a path, if there is one.
+     * @param path - The path.
+     */
+    remove(path) {
+        if (this.get(path) !== undefined)
+            this.modify(path, undefined);
+    }
+    /**
+     * Renames the property at a path by rewriting its key only, so its value keeps its text, its
+     * comments and its place among its siblings. Does nothing when there is no such property.
+     * @param path - The path of the property.
+     * @param name - The new name, which no sibling may have.
+     */
+    rename(path, name) {
+        const root = this.root();
+        const value = root && path.length ? (0, jsonc_parser_1.findNodeAtLocation)(root, path) : undefined;
+        const property = value?.parent;
+        const key = property?.type === 'property' ? property.children?.[0] : undefined;
+        if (!key)
+            return;
+        if (this.get([...path.slice(0, -1), name]) !== undefined) {
+            throw new Error(`[${this.path}] Cannot rename to '${name}': the property exists.`);
+        }
+        this.content =
+            this.content.slice(0, key.offset) +
+                JSON.stringify(name) +
+                this.content.slice(key.offset + key.length);
+        this.ast = undefined;
+        this.tree.overwrite(this.path, this.content);
+    }
+}
+exports.JsonFile = JsonFile;
+//# sourceMappingURL=json-file.js.map

package/schematics/migrate-to-vite/setup/json-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json-file.js","sourceRoot":"","sources":["../../../../../../libs/builder/schematics/migrate-to-vite/setup/json-file.ts"],"names":[],"mappings":";;;AACA,+CAUsB;AAEtB,4DAA0D;AAY1D;;;;GAIG;AACH,SAAS,YAAY,CAAC,OAAe;IACnC,MAAM,QAAQ,GAAG,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACnD,MAAM,GAAG,GAAG,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;IACrD,IAAI,QAAQ,EAAE,UAAU,CAAC,IAAI,CAAC;QAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC;IAChF,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;AACrE,CAAC;AAED;;;;GAIG;AACH,MAAa,QAAQ;IAInB;;;;OAIG;IACH,YACmB,IAAU,EAClB,IAAY;QADJ,SAAI,GAAJ,IAAI,CAAM;QAClB,SAAI,GAAJ,IAAI,CAAQ;QAErB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,mBAAmB,IAAI,IAAI,CAAC,CAAC;QACrE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAEO,IAAI;QACV,IAAI,IAAI,CAAC,GAAG;YAAE,OAAO,IAAI,CAAC,GAAG,CAAC;QAC9B,MAAM,MAAM,GAAiB,EAAE,CAAC;QAChC,IAAI,CAAC,GAAG,GAAG,IAAA,wBAAS,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE;YACzC,kBAAkB,EAAE,IAAI;YACxB,gBAAgB,EAAE,KAAK;SACxB,CAAC,CAAC;QACH,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAClB,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YACpC,MAAM,IAAI,KAAK,CAAC,IAAI,IAAI,CAAC,IAAI,KAAK,IAAA,kCAAmB,EAAC,KAAK,CAAC,cAAc,MAAM,GAAG,CAAC,CAAC;QACvF,CAAC;QACD,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED;;;OAGG;IACH,GAAG,CAAC,IAAc;QAChB,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QACzB,IAAI,CAAC,IAAI;YAAE,OAAO,SAAS,CAAC;QAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAA,iCAAkB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACjE,OAAO,IAAI,CAAC,CAAC,CAAC,IAAA,2BAAY,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,IAAc,EAAE,KAAc,EAAE,SAAyB;QAC9D,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACvC,MAAM,iBAAiB,GACrB,SAAS,KAAK,SAAS;YACrB,CAAC,CAAC,CAAC,UAAoB,EAAE,EAAE,CACvB,CAAC,GAAG,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,wBAAW,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YACjF,CAAC,CAAC,SAAS,KAAK,KAAK;gBACnB,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,SAAS,CAAC;QAClB,MAAM,KAAK,GAAG,IAAA,qBAAM,EAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE;YAC9C,iBAAiB;YACjB,iBAAiB,EAAE,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC;SAC9C,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,GAAG,IAAA,yBAAU,EAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC/C,IAAI,CAAC,GAAG,GAAG,SAAS,CAAC;QACrB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,IAAc;QACnB,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,SAAS;YAAE,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IACjE,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,IAAc,EAAE,IAAY;QACjC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QACzB,MAAM,KAAK,GAAG,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAA,iCAAkB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC/E,MAAM,QAAQ,GAAG,KAAK,EAAE,MAAM,CAAC;QAC/B,MAAM,GAAG,GAAG,QAAQ,EAAE,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC/E,IAAI,CAAC,GAAG;YAAE,OAAO;QACjB,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;YACzD,MAAM,IAAI,KAAK,CAAC,IAAI,IAAI,CAAC,IAAI,uBAAuB,IAAI,yBAAyB,CAAC,CAAC;QACrF,CAAC;QACD,IAAI,CAAC,OAAO;YACV,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC;gBACjC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBACpB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,CAAC,GAAG,GAAG,SAAS,CAAC;QACrB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/C,CAAC;CACF;AAhGD,4BAgGC"}

package/schematics/migrate-to-vite/setup/source.d.ts

@@ -0,0 +1,30 @@
+import { Tree } from '@angular-devkit/schematics';
+/**
+ * Finds the root component of an application from its browser entry: the first argument of
+ * `bootstrapApplication(...)`, or the `bootstrap` component of the module passed to
+ * `bootstrapModule(...)`. Returns its workspace-relative file, or undefined when the entry does not
+ * follow either pattern.
+ */
+export declare function findRootComponent(tree: Tree, browserEntry: string): string | undefined;
+/**
+ * The name of the NgModule that a server entry exports as its default export
+ * (`export { AppServerModule as default } from './app/app.module.server'`, as `ng new
+ * --no-standalone --ssr` writes it, `export default AppServerModule`, or an exported decorated
+ * class), or undefined when the default export is anything else, such as a bootstrap function.
+ * @param tree - The workspace tree.
+ * @param file - The server entry, workspace-relative.
+ */
+export declare function serverEntryNgModule(tree: Tree, file: string): string | undefined;
+/** The import that provides `withNgDocContentReady`. */
+export declare const CONTENT_READY_IMPORT = "import { withNgDocContentReady } from '@ng-doc/app/helpers';";
+/**
+ * Wraps the default export of a server entry (`main.server.ts`) with `withNgDocContentReady`, so a
+ * prerendered page waits for its NgDoc content and a content failure fails the route. Returns the
+ * new text, the same text when it is already wrapped, or undefined when the default export is not
+ * an expression (`export { AppServerModule as default }`) and the entry needs a manual change.
+ *
+ * The change is two insertions: the import after the last import, in that import's quotes and
+ * semicolon style and the file's line ending, and the call around the exported expression. The
+ * rest of the file keeps its bytes, so the diff a user reviews is exactly what the migration does.
+ */
+export declare function wrapServerEntry(file: string, text: string): string | undefined;