@adobe/ccweb-add-on-scaffolder 2.5.0 → 3.1.0

package/src/app/TemplateAddOnScaffolder.ts

@@ -1,153 +0,0 @@
-/********************************************************************************
- * MIT License
-
- * © Copyright 2023 Adobe. All rights reserved.
-
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- * 
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- * 
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- ********************************************************************************/
-
-import type { Logger, Process } from "@adobe/ccweb-add-on-core";
-import { DEFAULT_HOST_NAME, ITypes as ICoreTypes } from "@adobe/ccweb-add-on-core";
-import type { CommandExecutor as SSLCommandExecutor } from "@adobe/ccweb-add-on-ssl";
-import { ITypes as ISSLTypes, SetupCommandOptions } from "@adobe/ccweb-add-on-ssl";
-import { inject, injectable, named } from "inversify";
-import "reflect-metadata";
-import { ITypes } from "../config/inversify.types.js";
-import type { ScaffolderOptions } from "../models/ScaffolderOptions.js";
-import type { TemplateValidator } from "../validators/index.js";
-import type { AddOnBuilderFactory } from "./AddOnBuilder.js";
-import type { AddOnScaffolder } from "./AddOnScaffolder.js";
-import type { PackageBuilderFactory } from "./PackageBuilder.js";
-
-/**
- * Add-on scaffolder implementation class for orchestrating the creation of the Add-on project.
- */
-@injectable()
-export class TemplateAddOnScaffolder implements AddOnScaffolder {
-    private readonly _addOnBuilderFactory: AddOnBuilderFactory;
-    private readonly _packageBuilderFactory: PackageBuilderFactory;
-    private readonly _templateValidator: TemplateValidator;
-
-    private readonly _sslCommandExecutor: SSLCommandExecutor;
-
-    private readonly _process: Process;
-    private readonly _logger: Logger;
-
-    /**
-     * Instantiate {@link TemplateAppScaffolder}.
-     * @param addOnBuilderFactory - {@link AddOnBuilderFactory} reference.
-     * @param packageBuilderFactory - {@link PackageBuilderFactory} reference.
-     * @param templateValidator - {@link TemplateValidator} reference.
-     * @param sslCommandExecutor - {@link SSLCommandExecutor} reference.
-     * @param cliProcess - {@link Process} reference.
-     * @param logger - {@link Logger} reference.
-     * @returns Reference to a new {@link TemplateAppScaffolder} instance.
-     */
-    constructor(
-        @inject(ITypes.AddOnBuilder) addOnBuilderFactory: AddOnBuilderFactory,
-        @inject(ITypes.PackageBuilder) packageBuilderFactory: PackageBuilderFactory,
-        @inject(ITypes.TemplateValidator) templateValidator: TemplateValidator,
-        @inject(ISSLTypes.CommandExecutor) @named("setup") sslCommandExecutor: SSLCommandExecutor,
-        @inject(ICoreTypes.Process) cliProcess: Process,
-        @inject(ICoreTypes.Logger) logger: Logger
-    ) {
-        this._addOnBuilderFactory = addOnBuilderFactory;
-        this._packageBuilderFactory = packageBuilderFactory;
-        this._templateValidator = templateValidator;
-
-        this._sslCommandExecutor = sslCommandExecutor;
-
-        this._process = cliProcess;
-        this._logger = logger;
-    }
-
-    /**
-     * Run the scaffolder to create the Add-on project from the provided options.
-     * @param options - {@link ScaffolderOptions} reference.
-     * @returns Promise.
-     */
-    async run(options: ScaffolderOptions): Promise<void> {
-        try {
-            this._templateValidator.validateTemplate(options.templateName);
-
-            const addOnBuilder = this._addOnBuilderFactory(options);
-            const packageJson = addOnBuilder.getPackageJson();
-            const templateJson = addOnBuilder.getTemplateJson();
-
-            const packageBuilder = this._packageBuilderFactory(packageJson)(templateJson);
-            const combinedPackage = packageBuilder.build();
-
-            addOnBuilder.build(combinedPackage.toJSON());
-
-            const templateDevDependencies = addOnBuilder.getDevDependenciesToInstall(templateJson);
-            await this._installDevDependencies(templateDevDependencies, options.verbose);
-
-            const templateDependencies = addOnBuilder.getDependenciesToInstall(templateJson);
-            await this._installDependencies(templateDependencies, options.verbose);
-
-            await this._setupSSL(options.verbose);
-
-            addOnBuilder.displaySuccess();
-        } catch (error) {
-            this._process.handleError(error);
-            process.exit(1);
-        }
-    }
-
-    private async _installDevDependencies(templateDevDependencies: Set<string>, verbose: boolean) {
-        if (templateDevDependencies.size > 0) {
-            const devDependencyArgs = ["install", "--save-dev", "--save-exact", ...templateDevDependencies];
-            if (verbose) {
-                devDependencyArgs.push("--verbose");
-            }
-
-            this._logger.information(LOGS.installingTemplateDevDependencies, {
-                prefix: LOGS.newLine
-            });
-
-            await this._process.execute("npm", devDependencyArgs, { stdio: "inherit" });
-        }
-    }
-
-    private async _installDependencies(templateDependencies: Set<string>, verbose: boolean) {
-        if (templateDependencies.size > 0) {
-            const dependencyArgs = ["install", "--save", "--save-exact", ...templateDependencies];
-            if (verbose) {
-                dependencyArgs.push("--verbose");
-            }
-
-            this._logger.information(LOGS.installingTemplateDependencies, {
-                prefix: LOGS.newLine
-            });
-
-            await this._process.execute("npm", dependencyArgs, { stdio: "inherit" });
-        }
-    }
-
-    private async _setupSSL(verbose: boolean): Promise<void> {
-        const setupCommandOptions = new SetupCommandOptions(DEFAULT_HOST_NAME, true, verbose);
-        await this._sslCommandExecutor.execute(setupCommandOptions);
-    }
-}
-
-const LOGS = {
-    newLine: "\n",
-    installingTemplateDevDependencies: "Installing template dev dependencies ...",
-    installingTemplateDependencies: "Installing template dependencies ..."
-};

package/src/app/TemplatePackageBuilder.ts

@@ -1,102 +0,0 @@
-/********************************************************************************
- * MIT License
-
- * © Copyright 2023 Adobe. All rights reserved.
-
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- * 
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- * 
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- ********************************************************************************/
-
-import type { TemplateJson } from "@adobe/ccweb-add-on-core";
-import { PackageJson } from "@adobe/ccweb-add-on-core";
-import { injectable } from "inversify";
-import type { PackageBuilder } from "./PackageBuilder.js";
-
-/**
- * Package builder implementation class for constructing the package.json of the Add-on project.
- */
-@injectable()
-export class TemplatePackageBuilder implements PackageBuilder {
-    private _combinedPackage: PackageJson;
-    private _templateJson: TemplateJson;
-
-    /**
-     * Instantiate {@link TemplatePackageBuilder}.
-     *
-     * @param packageJson - {@link PackageJson}.
-     * @param templateJson - {@link TemplateJson}.
-     * @returns Reference to a new {@link TemplatePackageBuilder} instance.
-     */
-    constructor(packageJson: PackageJson, templateJson: TemplateJson) {
-        this._combinedPackage = new PackageJson({ ...packageJson });
-        this._templateJson = templateJson;
-    }
-
-    /**
-     * Build {@link PackageJson}.
-     */
-    build(): PackageJson {
-        this._buildDevDependencies();
-        this._buildDependencies();
-        this._buildScripts();
-
-        return this._combinedPackage;
-    }
-
-    private _buildDevDependencies(): void {
-        if (!this._templateJson.devDependencies || this._templateJson.devDependencies.size === 0) {
-            return;
-        }
-
-        this._templateJson.devDependencies.forEach((value, key) => {
-            if (!this._combinedPackage.devDependencies) {
-                this._combinedPackage.devDependencies = new Map<string, string>();
-            }
-
-            this._combinedPackage.devDependencies.set(key, value);
-        });
-    }
-
-    private _buildDependencies(): void {
-        if (!this._templateJson.dependencies || this._templateJson.dependencies.size === 0) {
-            return;
-        }
-
-        this._templateJson.dependencies.forEach((value, key) => {
-            if (!this._combinedPackage.dependencies) {
-                this._combinedPackage.dependencies = new Map<string, string>();
-            }
-
-            this._combinedPackage.dependencies.set(key, value);
-        });
-    }
-
-    private _buildScripts(): void {
-        if (!this._templateJson.scripts || this._templateJson.scripts.size === 0) {
-            return;
-        }
-
-        this._templateJson.scripts.forEach((value, key) => {
-            if (!this._combinedPackage.scripts) {
-                this._combinedPackage.scripts = new Map<string, string>();
-            }
-
-            this._combinedPackage.scripts.set(key, value);
-        });
-    }
-}

package/src/validators/AddOnTemplateValidator.ts

@@ -1,79 +0,0 @@
-/********************************************************************************
- * MIT License
-
- * © Copyright 2023 Adobe. All rights reserved.
-
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- * 
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- * 
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- ********************************************************************************/
-
-import type { Logger } from "@adobe/ccweb-add-on-core";
-import { ITypes as ICoreTypes, isNullOrWhiteSpace } from "@adobe/ccweb-add-on-core";
-import { inject, injectable } from "inversify";
-import process from "process";
-import "reflect-metadata";
-import format from "string-template";
-import { PROGRAM_NAME } from "../constants.js";
-import type { TemplateValidator } from "./TemplateValidator.js";
-
-/**
- * Template validator implementation class to validate user selected template..
- */
-@injectable()
-export class AddOnTemplateValidator implements TemplateValidator {
-    private readonly _logger: Logger;
-
-    /**
-     * Instantiate {@link AppTemplateValidator}.
-     *
-     * @param logger - {@link Logger} reference.
-     * @returns Reference to a new {@link AppTemplateValidator} instance.
-     */
-    constructor(@inject(ICoreTypes.Logger) logger: Logger) {
-        this._logger = logger;
-    }
-
-    /**
-     * Validate the template.
-     *
-     * @param templateName - Name of the template.
-     */
-    validateTemplate(templateName: string) {
-        if (isNullOrWhiteSpace(templateName)) {
-            this._logger.warning(LOGS.specifyValidTemplateName);
-            this._logger.warning(format(LOGS.executeProgram, { PROGRAM_NAME }), {
-                prefix: LOGS.tab
-            });
-            this._logger.message(LOGS.forExample, { prefix: LOGS.newLine });
-            this._logger.information(format(LOGS.executeProgramExample, { PROGRAM_NAME }), {
-                prefix: LOGS.tab
-            });
-
-            process.exit(1);
-        }
-    }
-}
-
-const LOGS = {
-    newLine: "\n",
-    tab: "  ",
-    specifyValidTemplateName: "Please specify a valid template name:",
-    executeProgram: "{PROGRAM_NAME} --template <template-name>",
-    executeProgramExample: "{PROGRAM_NAME} --template javascript",
-    forExample: "For example:"
-};