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

package/schematics/ng-add/utils/get-app-template-path.js

@@ -6,9 +6,10 @@ const path = require("path");
 const get_app_component_1 = require("./get-app-component");
 const get_initializer_1 = require("./get-initializer");
 /**
- *
- * @param tree
- * @param mainPath
+ * Returns the path of the root component's template (`templateUrl`, or `app.component.html` next
+ * to the component when it has none).
+ * @param tree - The workspace tree.
+ * @param mainPath - Path of the application's main file.
  */
 function getAppTemplatePath(tree, mainPath) {
     const appComponent = (0, get_app_component_1.getAppComponent)(tree, mainPath);
@@ -18,7 +19,6 @@ function getAppTemplatePath(tree, mainPath) {
     const templateInitializer = (0, get_initializer_1.getInitializer)(appComponent, 'Component', 'templateUrl');
     const appComponentDir = appComponent.getSourceFile().getDirectoryPath();
     const templateUrlPath = path.join(appComponentDir, templateInitializer?.getText().replace(/['"]/g, '') ?? 'app.component.html');
-    (0, ng_morph_1.saveActiveProject)();
     return templateUrlPath;
 }
 //# sourceMappingURL=get-app-template-path.js.map

package/schematics/ng-add/utils/get-app-template-path.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-app-template-path.js","sourceRoot":"","sources":["../../../../../../libs/add/schematics/ng-add/utils/get-app-template-path.ts"],"names":[],"mappings":";;AAiBA,gDAuBC;AAlCD,uCAAiF;AACjF,6BAA6B;AAE7B,2DAAsD;AACtD,uDAAmD;AAEnD;;;;GAIG;AACH,SAAgB,kBAAkB,CAAC,IAAU,EAAE,QAAgB;IAC9D,MAAM,YAAY,GAAiC,IAAA,mCAAe,EAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAEnF,IAAI,CAAC,eAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,EAAE,CAAC;QAC5C,OAAO;IACR,CAAC;IAED,MAAM,mBAAmB,GAA2B,IAAA,gCAAc,EACjE,YAAY,EACZ,WAAW,EACX,aAAa,CACb,CAAC;IAEF,MAAM,eAAe,GAAW,YAAY,CAAC,aAAa,EAAE,CAAC,gBAAgB,EAAE,CAAC;IAEhF,MAAM,eAAe,GAAW,IAAI,CAAC,IAAI,CACxC,eAAe,EACf,mBAAmB,EAAE,OAAO,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,oBAAoB,CAC3E,CAAC;IAEF,IAAA,4BAAiB,GAAE,CAAC;IAEpB,OAAO,eAAe,CAAC;AACxB,CAAC"}
+{"version":3,"file":"get-app-template-path.js","sourceRoot":"","sources":["../../../../../../libs/add/schematics/ng-add/utils/get-app-template-path.ts"],"names":[],"mappings":";;AAaA,gDAqBC;AAjCD,uCAA8D;AAC9D,6BAA6B;AAE7B,2DAAsD;AACtD,uDAAmD;AAEnD;;;;;GAKG;AACH,SAAgB,kBAAkB,CAAC,IAAU,EAAE,QAAgB;IAC7D,MAAM,YAAY,GAAiC,IAAA,mCAAe,EAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAEnF,IAAI,CAAC,eAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,EAAE,CAAC;QAC3C,OAAO;IACT,CAAC;IAED,MAAM,mBAAmB,GAA2B,IAAA,gCAAc,EAChE,YAAY,EACZ,WAAW,EACX,aAAa,CACd,CAAC;IAEF,MAAM,eAAe,GAAW,YAAY,CAAC,aAAa,EAAE,CAAC,gBAAgB,EAAE,CAAC;IAEhF,MAAM,eAAe,GAAW,IAAI,CAAC,IAAI,CACvC,eAAe,EACf,mBAAmB,EAAE,OAAO,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,oBAAoB,CAC5E,CAAC;IAEF,OAAO,eAAe,CAAC;AACzB,CAAC"}

package/schematics/ng-add/utils/get-build-options-target.d.ts

@@ -0,0 +1,18 @@
+import { ProjectDefinition } from '@angular-devkit/core/src/workspace';
+/** The builder of the Vite engine's production build. */
+export declare const VITE_APPLICATION_BUILDER = "@ng-doc/builder:vite-application";
+/**
+ * The target the Vite setup keeps the Angular build options in, for the Angular builders that
+ * read them (`unit-test`, `extract-i18n`). `@ng-doc/builder:vite-setup` creates it.
+ */
+export declare const ANGULAR_BUILD_TARGET = "build-angular";
+/** The target `migrate-to-vite` keeps the legacy build target in. */
+export declare const LEGACY_BUILD_TARGET = "build-legacy";
+/**
+ * The target that holds the application's Angular build options: `build`, or, once `build` runs
+ * the Vite engine (whose options are a Vite configuration file), `build-angular` of `ng add` or
+ * `build-legacy` of `migrate-to-vite`. A `build` builder that runs Angular's builder from another
+ * target of the project, as native federation runs its `esbuild` target, has them on that target.
+ * @param project - The application project.
+ */
+export declare function getBuildOptionsTarget(project: ProjectDefinition): string;

package/schematics/ng-add/utils/get-build-options-target.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LEGACY_BUILD_TARGET = exports.ANGULAR_BUILD_TARGET = exports.VITE_APPLICATION_BUILDER = void 0;
+exports.getBuildOptionsTarget = getBuildOptionsTarget;
+/** The builder of the Vite engine's production build. */
+exports.VITE_APPLICATION_BUILDER = '@ng-doc/builder:vite-application';
+/**
+ * The target the Vite setup keeps the Angular build options in, for the Angular builders that
+ * read them (`unit-test`, `extract-i18n`). `@ng-doc/builder:vite-setup` creates it.
+ */
+exports.ANGULAR_BUILD_TARGET = 'build-angular';
+/** The target `migrate-to-vite` keeps the legacy build target in. */
+exports.LEGACY_BUILD_TARGET = 'build-legacy';
+/** Options through which a builder runs another target, as `project:target[:configuration]`. */
+const DELEGATING_OPTIONS = ['target', 'buildTarget', 'browserTarget'];
+/** Angular's builders that take the application's build options. */
+const ANGULAR_BUILD_BUILDERS = [
+    '@angular/build:application',
+    '@angular-devkit/build-angular:application',
+    '@angular-devkit/build-angular:browser',
+    '@angular-devkit/build-angular:browser-esbuild',
+];
+/**
+ * The target that holds the application's Angular build options: `build`, or, once `build` runs
+ * the Vite engine (whose options are a Vite configuration file), `build-angular` of `ng add` or
+ * `build-legacy` of `migrate-to-vite`. A `build` builder that runs Angular's builder from another
+ * target of the project, as native federation runs its `esbuild` target, has them on that target.
+ * @param project - The application project.
+ */
+function getBuildOptionsTarget(project) {
+    const build = project.targets.get('build');
+    if (build?.builder !== exports.VITE_APPLICATION_BUILDER) {
+        return delegatedBuildTarget(project) ?? 'build';
+    }
+    return ([exports.ANGULAR_BUILD_TARGET, exports.LEGACY_BUILD_TARGET].find((name) => project.targets.has(name)) ??
+        'build');
+}
+/**
+ * The target of the project that `build` runs Angular's builder through, if it runs one. Native
+ * federation names it in the configurations of `build`
+ * (`"production": {"target": "app:esbuild:production"}`).
+ * @param project - The application project.
+ */
+function delegatedBuildTarget(project) {
+    const build = project.targets.get('build');
+    const configurations = build?.configurations ?? {};
+    const defaultConfiguration = build?.defaultConfiguration;
+    const candidates = [
+        build?.options,
+        defaultConfiguration ? configurations[defaultConfiguration] : undefined,
+        ...Object.values(configurations),
+    ].flatMap((options) => DELEGATING_OPTIONS.map((option) => options?.[option]));
+    for (const value of candidates) {
+        const name = typeof value === 'string' ? value.split(':')[1] : undefined;
+        const builder = name ? project.targets.get(name)?.builder : undefined;
+        if (name && name !== 'build' && builder && ANGULAR_BUILD_BUILDERS.includes(builder)) {
+            return name;
+        }
+    }
+    return undefined;
+}
+//# sourceMappingURL=get-build-options-target.js.map

package/schematics/ng-add/utils/get-build-options-target.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-build-options-target.js","sourceRoot":"","sources":["../../../../../../libs/add/schematics/ng-add/utils/get-build-options-target.ts"],"names":[],"mappings":";;;AAgCA,sDAWC;AAzCD,yDAAyD;AAC5C,QAAA,wBAAwB,GAAG,kCAAkC,CAAC;AAE3E;;;GAGG;AACU,QAAA,oBAAoB,GAAG,eAAe,CAAC;AAEpD,qEAAqE;AACxD,QAAA,mBAAmB,GAAG,cAAc,CAAC;AAElD,gGAAgG;AAChG,MAAM,kBAAkB,GAAa,CAAC,QAAQ,EAAE,aAAa,EAAE,eAAe,CAAC,CAAC;AAEhF,oEAAoE;AACpE,MAAM,sBAAsB,GAAa;IACvC,4BAA4B;IAC5B,2CAA2C;IAC3C,uCAAuC;IACvC,+CAA+C;CAChD,CAAC;AAEF;;;;;;GAMG;AACH,SAAgB,qBAAqB,CAAC,OAA0B;IAC9D,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAE3C,IAAI,KAAK,EAAE,OAAO,KAAK,gCAAwB,EAAE,CAAC;QAChD,OAAO,oBAAoB,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC;IAClD,CAAC;IAED,OAAO,CACL,CAAC,4BAAoB,EAAE,2BAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC7F,OAAO,CACR,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAS,oBAAoB,CAAC,OAA0B;IACtD,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC3C,MAAM,cAAc,GAAG,KAAK,EAAE,cAAc,IAAI,EAAE,CAAC;IACnD,MAAM,oBAAoB,GAAG,KAAK,EAAE,oBAAoB,CAAC;IACzD,MAAM,UAAU,GAAG;QACjB,KAAK,EAAE,OAAO;QACd,oBAAoB,CAAC,CAAC,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,SAAS;QACvE,GAAG,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC;KACjC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,MAAc,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAEtF,KAAK,MAAM,KAAK,IAAI,UAAU,EAAE,CAAC;QAC/B,MAAM,IAAI,GAAuB,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC7F,MAAM,OAAO,GAAuB,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;QAE1F,IAAI,IAAI,IAAI,IAAI,KAAK,OAAO,IAAI,OAAO,IAAI,sBAAsB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YACpF,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/schematics/ng-add/utils/get-main-path.d.ts

@@ -1,6 +1,16 @@
 import { ProjectDefinition } from '@angular-devkit/core/src/workspace';
+import { Tree } from '@angular-devkit/schematics';
 /**
- *
- * @param project
+ * Returns the browser entry of the application (`browser`, or `main` of older builders).
+ * @param project - The application project.
  */
 export declare function getMainPath(project: ProjectDefinition): string;
+/**
+ * Returns the file that starts the application: the browser entry, or, when the entry starts
+ * nothing itself, the module it imports dynamically that does. The entry of a native federation
+ * application loads the federation manifest first, then imports `./bootstrap`, which calls
+ * `bootstrapApplication`.
+ * @param tree - The workspace tree.
+ * @param project - The application project.
+ */
+export declare function getBootstrapPath(tree: Tree, project: ProjectDefinition): string;

package/schematics/ng-add/utils/get-main-path.js

@@ -1,13 +1,45 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getMainPath = getMainPath;
+exports.getBootstrapPath = getBootstrapPath;
 const schematics_1 = require("@angular/cdk/schematics");
+const path_1 = require("path");
+const get_build_options_target_1 = require("./get-build-options-target");
 /**
- *
- * @param project
+ * Returns the browser entry of the application (`browser`, or `main` of older builders).
+ * @param project - The application project.
  */
 function getMainPath(project) {
-    const buildOptions = (0, schematics_1.getProjectTargetOptions)(project, 'build');
+    const buildOptions = (0, schematics_1.getProjectTargetOptions)(project, (0, get_build_options_target_1.getBuildOptionsTarget)(project));
     return (buildOptions['main'] ?? buildOptions['browser']);
 }
+/** A call that starts the application. */
+const BOOTSTRAP_CALL = /\bbootstrapApplication\s*\(|\.bootstrapModule\s*\(/;
+/** A dynamic import of a relative module. */
+const RELATIVE_DYNAMIC_IMPORT = /\bimport\(\s*['"](\.{1,2}\/[^'"]+)['"]\s*\)/g;
+/**
+ * Returns the file that starts the application: the browser entry, or, when the entry starts
+ * nothing itself, the module it imports dynamically that does. The entry of a native federation
+ * application loads the federation manifest first, then imports `./bootstrap`, which calls
+ * `bootstrapApplication`.
+ * @param tree - The workspace tree.
+ * @param project - The application project.
+ */
+function getBootstrapPath(tree, project) {
+    const mainPath = getMainPath(project);
+    const main = mainPath ? tree.read(mainPath)?.toString('utf-8') : undefined;
+    if (main === undefined || BOOTSTRAP_CALL.test(main)) {
+        return mainPath;
+    }
+    for (const [, specifier] of main.matchAll(RELATIVE_DYNAMIC_IMPORT)) {
+        const base = path_1.posix.join(path_1.posix.dirname(mainPath), specifier);
+        const found = [base, `${base}.ts`, `${base}/index.ts`].find((path) => /\.ts$/.test(path) &&
+            tree.exists(path) &&
+            BOOTSTRAP_CALL.test(tree.read(path)?.toString('utf-8') ?? ''));
+        if (found) {
+            return found;
+        }
+    }
+    return mainPath;
+}
 //# sourceMappingURL=get-main-path.js.map

package/schematics/ng-add/utils/get-main-path.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-main-path.js","sourceRoot":"","sources":["../../../../../../libs/add/schematics/ng-add/utils/get-main-path.ts"],"names":[],"mappings":";;AAQA,kCAOC;AAfD,wDAAkE;AAIlE;;;GAGG;AACH,SAAgB,WAAW,CAAC,OAA0B;IACrD,MAAM,YAAY,GAA0C,IAAA,oCAAuB,EAClF,OAAO,EACP,OAAO,CACP,CAAC;IAEF,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,YAAY,CAAC,SAAS,CAAC,CAAW,CAAC;AACpE,CAAC"}
+{"version":3,"file":"get-main-path.js","sourceRoot":"","sources":["../../../../../../libs/add/schematics/ng-add/utils/get-main-path.ts"],"names":[],"mappings":";;AAYA,kCAOC;AAgBD,4CAuBC;AA1DD,wDAAkE;AAIlE,+BAA6B;AAE7B,yEAAmE;AAEnE;;;GAGG;AACH,SAAgB,WAAW,CAAC,OAA0B;IACpD,MAAM,YAAY,GAA0C,IAAA,oCAAuB,EACjF,OAAO,EACP,IAAA,gDAAqB,EAAC,OAAO,CAAC,CAC/B,CAAC;IAEF,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,YAAY,CAAC,SAAS,CAAC,CAAW,CAAC;AACrE,CAAC;AAED,0CAA0C;AAC1C,MAAM,cAAc,GAAG,oDAAoD,CAAC;AAE5E,6CAA6C;AAC7C,MAAM,uBAAuB,GAAG,8CAA8C,CAAC;AAE/E;;;;;;;GAOG;AACH,SAAgB,gBAAgB,CAAC,IAAU,EAAE,OAA0B;IACrE,MAAM,QAAQ,GAAW,WAAW,CAAC,OAAO,CAAC,CAAC;IAC9C,MAAM,IAAI,GAAuB,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAE/F,IAAI,IAAI,KAAK,SAAS,IAAI,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACpD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,KAAK,MAAM,CAAC,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CAAC,EAAE,CAAC;QACnE,MAAM,IAAI,GAAW,YAAK,CAAC,IAAI,CAAC,YAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,CAAC;QACpE,MAAM,KAAK,GAAuB,CAAC,IAAI,EAAE,GAAG,IAAI,KAAK,EAAE,GAAG,IAAI,WAAW,CAAC,CAAC,IAAI,CAC7E,CAAC,IAAY,EAAE,EAAE,CACf,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;YAClB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YACjB,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAChE,CAAC;QAEF,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/schematics/ng-add/utils/get-root-module.d.ts

@@ -0,0 +1,14 @@
+import { CallExpression, ClassDeclaration } from 'ng-morph';
+/**
+ * Finds the `bootstrapModule(...)` call of an NgModule application.
+ *
+ * The platform is not checked: Angular 22 applications call `platformBrowser().bootstrapModule`,
+ * older ones `platformBrowserDynamic().bootstrapModule`, and both must be found.
+ * @param mainPath - Path of the application's main file.
+ */
+export declare function getBootstrapModuleFn(mainPath: string): CallExpression | undefined;
+/**
+ * Returns the class of the module passed to `bootstrapModule`.
+ * @param mainPath - Path of the application's main file.
+ */
+export declare function getRootModule(mainPath: string): ClassDeclaration | undefined;

package/schematics/ng-add/utils/get-root-module.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBootstrapModuleFn = getBootstrapModuleFn;
+exports.getRootModule = getRootModule;
+const ng_morph_1 = require("ng-morph");
+/**
+ * Finds the `bootstrapModule(...)` call of an NgModule application.
+ *
+ * The platform is not checked: Angular 22 applications call `platformBrowser().bootstrapModule`,
+ * older ones `platformBrowserDynamic().bootstrapModule`, and both must be found.
+ * @param mainPath - Path of the application's main file.
+ */
+function getBootstrapModuleFn(mainPath) {
+    const [sourceFile] = (0, ng_morph_1.getSourceFiles)(mainPath);
+    return sourceFile
+        ?.getDescendantsOfKind(ng_morph_1.SyntaxKind.CallExpression)
+        .find((call) => {
+        const expression = call.getExpression();
+        return (ng_morph_1.Node.isPropertyAccessExpression(expression) && expression.getName() === 'bootstrapModule');
+    });
+}
+/**
+ * Returns the class of the module passed to `bootstrapModule`.
+ * @param mainPath - Path of the application's main file.
+ */
+function getRootModule(mainPath) {
+    const [module] = getBootstrapModuleFn(mainPath)?.getArguments() ?? [];
+    const [definition] = ng_morph_1.Node.isIdentifier(module) ? module.getDefinitionNodes() : [];
+    return ng_morph_1.Node.isClassDeclaration(definition) ? definition : undefined;
+}
+//# sourceMappingURL=get-root-module.js.map

package/schematics/ng-add/utils/get-root-module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-root-module.js","sourceRoot":"","sources":["../../../../../../libs/add/schematics/ng-add/utils/get-root-module.ts"],"names":[],"mappings":";;AAgBA,oDAYC;AAMD,sCAKC;AAvCD,uCAOkB;AAElB;;;;;;GAMG;AACH,SAAgB,oBAAoB,CAAC,QAAgB;IACnD,MAAM,CAAC,UAAU,CAAC,GAAiB,IAAA,yBAAc,EAAC,QAAQ,CAAC,CAAC;IAE5D,OAAO,UAAU;QACf,EAAE,oBAAoB,CAAC,qBAAU,CAAC,cAAc,CAAC;SAChD,IAAI,CAAC,CAAC,IAAoB,EAAE,EAAE;QAC7B,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QAExC,OAAO,CACL,eAAI,CAAC,0BAA0B,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,OAAO,EAAE,KAAK,iBAAiB,CAC1F,CAAC;IACJ,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;;GAGG;AACH,SAAgB,aAAa,CAAC,QAAgB;IAC5C,MAAM,CAAC,MAAM,CAAC,GAAG,oBAAoB,CAAC,QAAQ,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACtE,MAAM,CAAC,UAAU,CAAC,GAAG,eAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAElF,OAAO,eAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;AACtE,CAAC"}

package/schematics/ng-add/utils/select-engine.d.ts

@@ -0,0 +1,58 @@
+import { logging } from '@angular-devkit/core';
+import { ProjectDefinition } from '@angular-devkit/core/src/workspace';
+import { Tree } from '@angular-devkit/schematics';
+import { NgDocEngine } from '../schema';
+/** The command that moves a project from the legacy builders to the Vite engine. */
+export declare const MIGRATE_TO_VITE = "ng g @ng-doc/builder:migrate-to-vite";
+/** The recipe for a project whose builder NgDoc must not replace. */
+export declare const KEEP_ANOTHER_BUILDER_URL = "https://ng-doc.com/docs/build-and-deploy/dev-server-and-builds#keep-another-builder";
+/** The engine `ng add` sets up, and whether the project already had it. */
+export interface EngineChoice {
+    engine: NgDocEngine;
+    /** The project already builds with NgDoc: its builders are kept as they are. */
+    existing: boolean;
+    /**
+     * Whether the legacy setup sets its builders on `build` and `serve`. An existing project whose
+     * NgDoc builder is on another target keeps `build` and `serve` as they are.
+     */
+    replaceBuilders: boolean;
+    /**
+     * The builder of `build` or `serve` that NgDoc doesn't replace (native federation, a custom
+     * builder). No NgDoc builder is set up then: the project generates its documentation with the
+     * `ng-doc` command next to that builder.
+     */
+    keptBuilder?: string;
+}
+/**
+ * The application builders whose options the Vite setup reads: Angular's, and Nx's executor that
+ * runs Angular's with the same options (the Vite setup reports the few options Nx adds).
+ */
+export declare const ANGULAR_APPLICATION_BUILDERS: string[];
+/**
+ * Whether a builder is neither Angular's (or an Nx executor that runs it) nor NgDoc's: NgDoc doesn't
+ * know what it does, so it doesn't replace it. Native federation, for example, runs Angular's
+ * builder from another target and adds an import map to its output.
+ * @param builder - The builder of a target.
+ */
+export declare function isForeignBuilder(builder: string): boolean;
+/**
+ * Whether the application bootstraps an NgModule (`bootstrapModule`) instead of a standalone
+ * component.
+ * @param tree - The workspace tree.
+ * @param project - The application project.
+ */
+export declare function isNgModuleApp(tree: Tree, project: ProjectDefinition): boolean;
+/**
+ * Chooses the engine to set up. A project that already builds with NgDoc keeps its engine: `ng add`
+ * never switches it (the legacy builders move to the Vite engine with `migrate-to-vite`). A new
+ * standalone application on Angular's application builder (or Nx's executor that runs it) gets the
+ * Vite engine unless `--engine legacy` is passed; an NgModule application, or one whose `build`
+ * target uses another builder, gets the legacy builders; `--engine vite` is refused for an NgModule
+ * application. Without `--engine`, a
+ * `build` or `serve` builder that is neither Angular's nor NgDoc's is kept (`keptBuilder`).
+ * @param tree - The workspace tree.
+ * @param project - The application project.
+ * @param requested - The `--engine` option, if any.
+ * @param logger - Where the choice is explained.
+ */
+export declare function selectEngine(tree: Tree, project: ProjectDefinition, requested: NgDocEngine | undefined, logger: logging.LoggerApi): EngineChoice;

package/schematics/ng-add/utils/select-engine.js

@@ -0,0 +1,139 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ANGULAR_APPLICATION_BUILDERS = exports.KEEP_ANOTHER_BUILDER_URL = exports.MIGRATE_TO_VITE = void 0;
+exports.isForeignBuilder = isForeignBuilder;
+exports.isNgModuleApp = isNgModuleApp;
+exports.selectEngine = selectEngine;
+const schematics_1 = require("@angular-devkit/schematics");
+const ng_morph_1 = require("ng-morph");
+const get_build_options_target_1 = require("./get-build-options-target");
+const get_main_path_1 = require("./get-main-path");
+const get_root_module_1 = require("./get-root-module");
+/** The command that moves a project from the legacy builders to the Vite engine. */
+exports.MIGRATE_TO_VITE = 'ng g @ng-doc/builder:migrate-to-vite';
+/** The recipe for a project whose builder NgDoc must not replace. */
+exports.KEEP_ANOTHER_BUILDER_URL = 'https://ng-doc.com/docs/build-and-deploy/dev-server-and-builds#keep-another-builder';
+/**
+ * The application builders whose options the Vite setup reads: Angular's, and Nx's executor that
+ * runs Angular's with the same options (the Vite setup reports the few options Nx adds).
+ */
+exports.ANGULAR_APPLICATION_BUILDERS = [
+    '@angular/build:application',
+    '@angular-devkit/build-angular:application',
+    '@nx/angular:application',
+];
+const NG_DOC_BUILDER_PREFIX = '@ng-doc/builder:';
+/** Angular's builders, which the legacy builders replace. */
+const ANGULAR_BUILDER_PREFIXES = ['@angular/build:', '@angular-devkit/build-angular:'];
+/**
+ * Nx's executors that run Angular's builders with the same options, so they are not foreign: the
+ * Vite setup reads the options of `application`, and the legacy builders replace them as they
+ * replace Angular's.
+ */
+const NX_ANGULAR_BUILDERS = [
+    '@nx/angular:application',
+    '@nx/angular:browser-esbuild',
+    '@nx/angular:dev-server',
+];
+/**
+ * Whether a builder is neither Angular's (or an Nx executor that runs it) nor NgDoc's: NgDoc doesn't
+ * know what it does, so it doesn't replace it. Native federation, for example, runs Angular's
+ * builder from another target and adds an import map to its output.
+ * @param builder - The builder of a target.
+ */
+function isForeignBuilder(builder) {
+    return (![...ANGULAR_BUILDER_PREFIXES, NG_DOC_BUILDER_PREFIX].some((prefix) => builder.startsWith(prefix)) && !NX_ANGULAR_BUILDERS.includes(builder));
+}
+/**
+ * Whether the application bootstraps an NgModule (`bootstrapModule`) instead of a standalone
+ * component.
+ * @param tree - The workspace tree.
+ * @param project - The application project.
+ */
+function isNgModuleApp(tree, project) {
+    // Without a build target there is no entry to look at; the setup reports the missing target.
+    const mainPath = project.targets.has('build')
+        ? (0, get_main_path_1.getBootstrapPath)(tree, project)
+        : undefined;
+    if (!mainPath || !tree.exists(mainPath)) {
+        return false;
+    }
+    try {
+        (0, ng_morph_1.setActiveProject)((0, ng_morph_1.createProject)(tree, '/', [mainPath]));
+        return !!(0, get_root_module_1.getBootstrapModuleFn)(mainPath);
+    }
+    finally {
+        (0, ng_morph_1.resetActiveProject)();
+    }
+}
+/**
+ * Chooses the engine to set up. A project that already builds with NgDoc keeps its engine: `ng add`
+ * never switches it (the legacy builders move to the Vite engine with `migrate-to-vite`). A new
+ * standalone application on Angular's application builder (or Nx's executor that runs it) gets the
+ * Vite engine unless `--engine legacy` is passed; an NgModule application, or one whose `build`
+ * target uses another builder, gets the legacy builders; `--engine vite` is refused for an NgModule
+ * application. Without `--engine`, a
+ * `build` or `serve` builder that is neither Angular's nor NgDoc's is kept (`keptBuilder`).
+ * @param tree - The workspace tree.
+ * @param project - The application project.
+ * @param requested - The `--engine` option, if any.
+ * @param logger - Where the choice is explained.
+ */
+function selectEngine(tree, project, requested, logger) {
+    const build = project.targets.get('build')?.builder;
+    const serve = project.targets.get('serve')?.builder;
+    if (build === get_build_options_target_1.VITE_APPLICATION_BUILDER) {
+        if (requested === 'legacy') {
+            logger.warn(`⚠️ The project already builds with the Vite engine (${get_build_options_target_1.VITE_APPLICATION_BUILDER}); "--engine legacy" was ignored and the builders were kept.`);
+        }
+        return { engine: 'vite', existing: true, replaceBuilders: false };
+    }
+    // Any NgDoc builder, not only on `build` and `serve`, means the project already uses NgDoc.
+    const ngDocTarget = [...project.targets.entries()]
+        .map(([name, target]) => [name, target.builder ?? ''])
+        .find(([, builder]) => builder.startsWith(NG_DOC_BUILDER_PREFIX));
+    if (ngDocTarget) {
+        const message = `The project already uses the NgDoc builders ("${ngDocTarget[0]}" runs ${ngDocTarget[1]}); they were kept. To move it to the Vite engine, run "${exports.MIGRATE_TO_VITE}".`;
+        if (requested === 'vite') {
+            logger.warn(`⚠️ "--engine vite" was ignored. ${message}`);
+        }
+        else {
+            logger.info(`ℹ️ ${message}`);
+        }
+        return {
+            engine: 'legacy',
+            existing: true,
+            replaceBuilders: !!build?.startsWith(NG_DOC_BUILDER_PREFIX) || !!serve?.startsWith(NG_DOC_BUILDER_PREFIX),
+        };
+    }
+    // A builder NgDoc doesn't know is kept, unless `--engine` asks for NgDoc's builders. The
+    // documentation is then generated with the `ng-doc` command next to it.
+    const foreign = requested
+        ? undefined
+        : [
+            ['build', build],
+            ['serve', serve],
+        ].find((entry) => !!entry[1] && isForeignBuilder(entry[1]));
+    if (foreign) {
+        logger.info(`ℹ️ The "${foreign[0]}" target uses "${foreign[1]}", which NgDoc doesn't replace, so the "build" and "serve" builders were kept and no NgDoc builder was set up. Generate the documentation with the "ng-doc" command next to your builder: ${exports.KEEP_ANOTHER_BUILDER_URL}`);
+        return { engine: 'legacy', existing: false, replaceBuilders: false, keptBuilder: foreign[1] };
+    }
+    if (isNgModuleApp(tree, project)) {
+        if (requested === 'vite') {
+            throw new schematics_1.SchematicsException(`[NGDOC_ADD_ENGINE] "ng add" sets up the Vite engine for standalone applications (bootstrapApplication), and this application bootstraps an NgModule. Run "ng add @ng-doc/add --engine legacy", then "${exports.MIGRATE_TO_VITE}" if you want the Vite engine.`);
+        }
+        if (requested === undefined) {
+            logger.info(`ℹ️ The application bootstraps an NgModule, so NgDoc uses the legacy builders. "${exports.MIGRATE_TO_VITE}" moves it to the Vite engine later.`);
+        }
+        return { engine: 'legacy', existing: false, replaceBuilders: true };
+    }
+    // The Vite setup reads the options of Angular's application builder. Without `--engine`, another
+    // builder (a browser builder, Nx's `browser-esbuild`) gets the legacy builders, as before; an
+    // explicit `--engine vite` goes on to the Vite setup, which refuses it and says why.
+    if (requested === undefined && !exports.ANGULAR_APPLICATION_BUILDERS.includes(build ?? '')) {
+        logger.info(`ℹ️ The "build" target uses ${build ? `"${build}"` : 'no builder'}, not Angular's application builder, so NgDoc uses the legacy builders.`);
+        return { engine: 'legacy', existing: false, replaceBuilders: true };
+    }
+    return { engine: requested ?? 'vite', existing: false, replaceBuilders: true };
+}
+//# sourceMappingURL=select-engine.js.map

package/schematics/ng-add/utils/select-engine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"select-engine.js","sourceRoot":"","sources":["../../../../../../libs/add/schematics/ng-add/utils/select-engine.ts"],"names":[],"mappings":";;;AAmEA,4CAMC;AAQD,sCAiBC;AAeD,oCAwFC;AAvMD,2DAAuE;AACvE,uCAA+E;AAG/E,yEAAsE;AACtE,mDAAmD;AACnD,uDAAyD;AAEzD,oFAAoF;AACvE,QAAA,eAAe,GAAG,sCAAsC,CAAC;AAEtE,qEAAqE;AACxD,QAAA,wBAAwB,GACnC,qFAAqF,CAAC;AAoBxF;;;GAGG;AACU,QAAA,4BAA4B,GAAa;IACpD,4BAA4B;IAC5B,2CAA2C;IAC3C,yBAAyB;CAC1B,CAAC;AAEF,MAAM,qBAAqB,GAAG,kBAAkB,CAAC;AAEjD,6DAA6D;AAC7D,MAAM,wBAAwB,GAAa,CAAC,iBAAiB,EAAE,gCAAgC,CAAC,CAAC;AAEjG;;;;GAIG;AACH,MAAM,mBAAmB,GAAa;IACpC,yBAAyB;IACzB,6BAA6B;IAC7B,wBAAwB;CACzB,CAAC;AAEF;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,OAAe;IAC9C,OAAO,CACL,CAAC,CAAC,GAAG,wBAAwB,EAAE,qBAAqB,CAAC,CAAC,IAAI,CAAC,CAAC,MAAc,EAAE,EAAE,CAC5E,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAC3B,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAC5C,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,IAAU,EAAE,OAA0B;IAClE,6FAA6F;IAC7F,MAAM,QAAQ,GAAuB,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;QAC/D,CAAC,CAAC,IAAA,gCAAgB,EAAC,IAAI,EAAE,OAAO,CAAC;QACjC,CAAC,CAAC,SAAS,CAAC;IAEd,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QACxC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,CAAC;QACH,IAAA,2BAAgB,EAAC,IAAA,wBAAa,EAAC,IAAI,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAEvD,OAAO,CAAC,CAAC,IAAA,sCAAoB,EAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC;YAAS,CAAC;QACT,IAAA,6BAAkB,GAAE,CAAC;IACvB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,YAAY,CAC1B,IAAU,EACV,OAA0B,EAC1B,SAAkC,EAClC,MAAyB;IAEzB,MAAM,KAAK,GAAuB,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IACxE,MAAM,KAAK,GAAuB,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAExE,IAAI,KAAK,KAAK,mDAAwB,EAAE,CAAC;QACvC,IAAI,SAAS,KAAK,QAAQ,EAAE,CAAC;YAC3B,MAAM,CAAC,IAAI,CACT,uDAAuD,mDAAwB,8DAA8D,CAC9I,CAAC;QACJ,CAAC;QAED,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,eAAe,EAAE,KAAK,EAAE,CAAC;IACpE,CAAC;IAED,4FAA4F;IAC5F,MAAM,WAAW,GAAiC,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;SAC7E,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,EAAoB,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;SACvE,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC,CAAC;IAEpE,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,OAAO,GAAW,iDAAiD,WAAW,CAAC,CAAC,CAAC,UAAU,WAAW,CAAC,CAAC,CAAC,0DAA0D,uBAAe,IAAI,CAAC;QAE7L,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;YACzB,MAAM,CAAC,IAAI,CAAC,mCAAmC,OAAO,EAAE,CAAC,CAAC;QAC5D,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CAAC,MAAM,OAAO,EAAE,CAAC,CAAC;QAC/B,CAAC;QAED,OAAO;YACL,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,IAAI;YACd,eAAe,EACb,CAAC,CAAC,KAAK,EAAE,UAAU,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,UAAU,CAAC,qBAAqB,CAAC;SAC3F,CAAC;IACJ,CAAC;IAED,yFAAyF;IACzF,wEAAwE;IACxE,MAAM,OAAO,GAAiC,SAAS;QACrD,CAAC,CAAC,SAAS;QACX,CAAC,CACG;YACE,CAAC,OAAO,EAAE,KAAK,CAAC;YAChB,CAAC,OAAO,EAAE,KAAK,CAAC;SAEnB,CAAC,IAAI,CAAC,CAAC,KAAK,EAA6B,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAE3F,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,CAAC,IAAI,CACT,WAAW,OAAO,CAAC,CAAC,CAAC,kBAAkB,OAAO,CAAC,CAAC,CAAC,6LAA6L,gCAAwB,EAAE,CACzQ,CAAC;QAEF,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IAChG,CAAC;IAED,IAAI,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;QACjC,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;YACzB,MAAM,IAAI,gCAAmB,CAC3B,wMAAwM,uBAAe,gCAAgC,CACxP,CAAC;QACJ,CAAC;QAED,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,CAAC,IAAI,CACT,kFAAkF,uBAAe,sCAAsC,CACxI,CAAC;QACJ,CAAC;QAED,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC;IACtE,CAAC;IAED,iGAAiG;IACjG,8FAA8F;IAC9F,qFAAqF;IACrF,IAAI,SAAS,KAAK,SAAS,IAAI,CAAC,oCAA4B,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC;QACnF,MAAM,CAAC,IAAI,CACT,8BAA8B,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,YAAY,yEAAyE,CAC3I,CAAC;QAEF,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC;IACtE,CAAC;IAED,OAAO,EAAE,MAAM,EAAE,SAAS,IAAI,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC;AACjF,CAAC"}