@adobe/create-ccweb-add-on 3.0.0 → 3.1.0

package/src/validators/DirectoryValidator.ts

@@ -22,23 +22,184 @@
  * SOFTWARE.
  ********************************************************************************/
 
+import type { AnalyticsService } from "@adobe/ccweb-add-on-analytics";
+import { ITypes as IAnalyticsTypes } from "@adobe/ccweb-add-on-analytics";
+import type { Logger } from "@adobe/ccweb-add-on-core";
+import { ITypes as ICoreTypes, isNullOrWhiteSpace } from "@adobe/ccweb-add-on-core";
+import fs from "fs-extra";
+import { inject, injectable } from "inversify";
+import path from "path";
+import process from "process";
+import "reflect-metadata";
+import format from "string-template";
+import validate from "validate-npm-package-name";
+import { AnalyticsErrorMarkers } from "../AnalyticsMarkers.js";
+import { PROGRAM_NAME } from "../constants.js";
+
 /**
- * Directory validator interface to validate
+ * Directory validator implementation class to validate
  * whether the directory can be used to create the add-on project.
  */
-export interface DirectoryValidator {
+@injectable()
+export class DirectoryValidator {
+    private readonly _logger: Logger;
+    private readonly _analyticsService: AnalyticsService;
+
     /**
-     * Validate the app name.
-     *
-     * @param appName - Name of the app.
+     * Instantiate {@link DirectoryValidator}.
+     * @param logger - {@link Logger} reference.
+     * @param analyticsService - {@link AnalyticsService} reference.
+     * @returns Reference to a new {@link DirectoryValidator} instance.
      */
-    validateAddOnName(appName: string): Promise<void>;
+    constructor(
+        @inject(ICoreTypes.Logger) logger: Logger,
+        @inject(IAnalyticsTypes.AnalyticsService) analyticsService: AnalyticsService
+    ) {
+        this._logger = logger;
+        this._analyticsService = analyticsService;
+    }
 
     /**
-     * Validate the app directory.
-     *
-     * @param appDirectory - Root directory of the app.
-     * @param appName - Name of the app.
+     * Validate the Add-on name.
+     * @param addOnName - Name of the Add-on.
      */
-    validateAddOnDirectory(appDirectory: string, appName: string): Promise<void>;
+    async validateAddOnName(addOnName: string): Promise<void> {
+        if (isNullOrWhiteSpace(addOnName)) {
+            this._logger.warning(LOGS.specifyAddOnName);
+            this._chooseDifferentAddOnName();
+            await this._analyticsService.postEvent(
+                AnalyticsErrorMarkers.ERROR_NO_ADD_ON_NAME,
+                LOGS.analyticsNoAddOnName,
+                false
+            );
+            return process.exit(0);
+        }
+
+        const isValid = validate(addOnName).validForNewPackages;
+        if (!isValid) {
+            this._logger.warning(format(LOGS.npmNamingRestriction, { addOnName }));
+            this._chooseDifferentAddOnName();
+            await this._analyticsService.postEvent(
+                AnalyticsErrorMarkers.ERROR_INVALID_NAME_NPM,
+                LOGS.analyticsInvalidAddOnNameNPM,
+                false
+            );
+            return process.exit(0);
+        }
+
+        const dependencies = new Set([
+            "@adobe/create-ccweb-add-on",
+            "create-ccweb-add-on",
+            "@adobe/ccweb-add-on-scripts",
+            "ccweb-add-on-scripts",
+            "@adobe/ccweb-add-on-scaffolder",
+            "ccweb-add-on-scaffolder"
+        ]);
+        if (dependencies.has(addOnName)) {
+            this._logger.warning(format(LOGS.dependencyNamingRestriction, { addOnName }));
+            this._chooseDifferentAddOnName();
+            await this._analyticsService.postEvent(
+                AnalyticsErrorMarkers.ERROR_INVALID_NAME_DEP,
+                LOGS.analyticsInvalidAddOnNameDependency,
+                false
+            );
+            return process.exit(0);
+        }
+    }
+
+    /**
+     * Validate the addOn directory.
+     * @param addOnDirectory - Root directory of the addOn.
+     * @param addOnName - Name of the addOn.
+     */
+    async validateAddOnDirectory(addOnDirectory: string, addOnName: string): Promise<void> {
+        fs.ensureDirSync(addOnName);
+
+        const validFiles = [
+            ".DS_Store",
+            ".git",
+            ".gitattributes",
+            ".gitignore",
+            ".gitlab-ci.yml",
+            ".hg",
+            ".hgcheck",
+            ".hgignore",
+            ".idea",
+            ".npmignore",
+            ".travis.yml",
+            "docs",
+            "LICENSE",
+            "README.md",
+            "mkdocs.yml",
+            "Thumbs.db"
+        ];
+
+        const errorLogFilePatterns = ["npm-debug.log"];
+
+        const isErrorLog = (file: string) => {
+            return errorLogFilePatterns.some(pattern => file.startsWith(pattern));
+        };
+
+        const existingFiles = fs.readdirSync(addOnDirectory, { withFileTypes: true });
+        const conflictingFiles = existingFiles
+            .filter(file => !validFiles.includes(file.name))
+            .filter(file => !/\.iml$/.test(file.name))
+            .filter(file => !isErrorLog(file.name));
+
+        if (conflictingFiles.length === 0) {
+            return;
+        }
+
+        this._logger.warning(format(LOGS.directoryContainsFiles, { addOnName }), {
+            postfix: LOGS.newLine
+        });
+
+        for (const file of conflictingFiles) {
+            try {
+                if (fs.lstatSync(path.join(addOnDirectory, file.name)).isDirectory()) {
+                    this._logger.warning(`${file.name}/`, { prefix: LOGS.tab });
+                } else {
+                    this._logger.warning(`${file.name}`, { prefix: LOGS.tab });
+                }
+            } catch {
+                this._logger.warning(`${file.name}`, { prefix: LOGS.tab });
+            }
+        }
+
+        this._logger.information(LOGS.newAddOnOrRemoveFiles, { prefix: LOGS.newLine });
+        await this._analyticsService.postEvent(
+            AnalyticsErrorMarkers.ERROR_INVALID_NAME_DIR,
+            LOGS.analyticsInvalidAddOnDir,
+            false
+        );
+        return process.exit(0);
+    }
+
+    private _chooseDifferentAddOnName() {
+        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,
+            postfix: LOGS.newLine
+        });
+    }
 }
+
+const LOGS = {
+    newLine: "\n",
+    tab: "  ",
+    specifyAddOnName: "Please specify an Add-on name",
+    executeProgram: "{PROGRAM_NAME} <add-on-name> --entrypoint <panel> --template <javascript>",
+    executeProgramExample: "{PROGRAM_NAME} my-add-on --entrypoint panel --template javascript",
+    forExample: "For example:",
+    npmNamingRestriction: "Cannot create a project named {addOnName} because of NPM naming restrictions.",
+    dependencyNamingRestriction:
+        "Cannot create a project named {addOnName} because a dependency with the same name exists.",
+    chooseDifferentAddOnName: "Please choose a different Add-on name:",
+    directoryContainsFiles: "The directory {addOnName} contains files that could conflict:",
+    newAddOnOrRemoveFiles: "Either try using a new Add-on name, or remove the files listed above.",
+    analyticsNoAddOnName: "Add-on name was not specified",
+    analyticsInvalidAddOnNameNPM: "Invalid Add-on name. Npm name check failed",
+    analyticsInvalidAddOnNameDependency: "Invalid Add-on name. Dependency with same name exists",
+    analyticsInvalidAddOnDir: "Invalid Add-on name. Conflicting directory with same name exists"
+};

package/src/validators/EnvironmentValidator.ts

@@ -22,23 +22,175 @@
  * SOFTWARE.
  ********************************************************************************/
 
+import type { AnalyticsService } from "@adobe/ccweb-add-on-analytics";
+import { ITypes as IAnalyticsTypes } from "@adobe/ccweb-add-on-analytics";
+import type { Logger, Process } from "@adobe/ccweb-add-on-core";
+import { ITypes as ICoreTypes } from "@adobe/ccweb-add-on-core";
+import { inject, injectable } from "inversify";
+import process from "process";
+import "reflect-metadata";
+import semver from "semver";
+import format from "string-template";
+import { AnalyticsErrorMarkers } from "../AnalyticsMarkers.js";
+import { PROGRAM_NAME } from "../constants.js";
+
 /**
- * Environment validator interface to validate
+ * Environment validator implementation class to validate
  * the system requirements required for running the app.
  */
-export interface EnvironmentValidator {
+@injectable()
+export class EnvironmentValidator {
+    private readonly _process: Process;
+    private readonly _logger: Logger;
+    private readonly _analyticsService: AnalyticsService;
+    /**
+     * Instantiate {@link EnvironmentValidator}.
+     *
+     * @param processHandler - {@link Process} reference.
+     * @param logger - {@link Logger} reference.
+     * @param analyticsService - {@link AnalyticsService} reference.
+     * @returns Reference to a new {@link EnvironmentValidator} instance.
+     */
+    constructor(
+        @inject(ICoreTypes.Process) processHandler: Process,
+        @inject(ICoreTypes.Logger) logger: Logger,
+        @inject(IAnalyticsTypes.AnalyticsService) analyticsService: AnalyticsService
+    ) {
+        this._process = processHandler;
+        this._logger = logger;
+        this._analyticsService = analyticsService;
+    }
+
     /**
      * Validate the node version in the user's system.
      */
-    validateNodeVersion(): Promise<void>;
+    async validateNodeVersion(): Promise<void> {
+        const minNode = "18.0.0";
+        try {
+            const result = this._process.executeSync("node", ["--version"]);
+            const nodeVersion = String(result?.data)?.trim();
+            const hasMinNode = semver.gte(nodeVersion, minNode);
+            if (!hasMinNode) {
+                this._logger.warning(format(LOGS.usingNodeVersion, { nodeVersion }));
+                this._logger.information(
+                    format(LOGS.requiresHigherNode, {
+                        PROGRAM_NAME,
+                        minNode
+                    })
+                );
+                this._logger.information(LOGS.updateNodeVersion);
+                await this._analyticsService.postEvent(
+                    AnalyticsErrorMarkers.ERROR_INVALID_NODE,
+                    format(LOGS.analyticsInvalidNode, { nodeVersion }),
+                    false
+                );
+                return process.exit(0);
+            }
+        } catch (error) {
+            this._process.handleError(error);
+        }
+    }
 
     /**
      * Validate the npm version in the user's system.
      */
-    validateNpmVersion(): Promise<void>;
+    async validateNpmVersion(): Promise<void> {
+        const minNpm = "10.0.0";
+        try {
+            const result = this._process.executeSync("npm", ["--version"]);
+            const npmVersion = result.data ? String(result.data)?.trim() : undefined;
+            if (!npmVersion) {
+                this._logger.warning(LOGS.notUsingNpm);
+                this._logger.information(
+                    format(LOGS.requiresHigherNpm, {
+                        PROGRAM_NAME,
+                        minNpm
+                    })
+                );
+                this._logger.information(LOGS.installNpm);
+                await this._analyticsService.postEvent(AnalyticsErrorMarkers.ERROR_NO_NPM, LOGS.analyticsNoNpm, false);
+                return process.exit(0);
+            }
+
+            const hasMinNpm = semver.gte(npmVersion, minNpm);
+            if (!hasMinNpm) {
+                this._logger.warning(format(LOGS.usingNpmVersion, { npmVersion }));
+                this._logger.information(
+                    format(LOGS.requiresHigherNpm, {
+                        PROGRAM_NAME,
+                        minNpm
+                    })
+                );
+                this._logger.information(LOGS.updateNpm);
+                await this._analyticsService.postEvent(
+                    AnalyticsErrorMarkers.ERROR_INVALID_NPM,
+                    format(LOGS.analyticsInvalidNpm, { npmVersion }),
+                    false
+                );
+                return process.exit(0);
+            }
+        } catch (error) {
+            this._process.handleError(error);
+        }
+    }
 
     /**
      * Validate the npm configuration in the user's system.
      */
-    validateNpmConfiguration(): Promise<void>;
+    async validateNpmConfiguration(): Promise<void> {
+        try {
+            const cwd = process.cwd();
+            const configList = this._process.executeSync("npm", ["config", "list"])?.data;
+            if (!configList) {
+                return;
+            }
+
+            const prefix = "; cwd = ";
+            const configLines = configList.split("\n");
+            const cwdLine = configLines.find(line => line.startsWith(prefix));
+            if (!cwdLine) {
+                return;
+            }
+
+            const npmCWD = cwdLine.substring(prefix.length);
+            if (npmCWD === cwd) {
+                return;
+            }
+
+            this._logger.warning(LOGS.couldNotStartNpmProcess);
+            this._logger.information(format(LOGS.currentDirectory, { cwd }));
+            this._logger.information(format(LOGS.newNpmProcessRunsIn, { npmCWD }));
+            this._logger.information(LOGS.misconfiguredTerminalShell);
+
+            await this._analyticsService.postEvent(
+                AnalyticsErrorMarkers.ERROR_NPM_NOT_STARTED,
+                LOGS.analyticsNotStartNpm,
+                false
+            );
+            return process.exit(0);
+        } catch (error) {
+            return;
+        }
+    }
 }
+
+const LOGS = {
+    newLine: "\n",
+    tab: "  ",
+    usingNodeVersion: "You are using node {nodeVersion}.",
+    requiresHigherNode: "{PROGRAM_NAME} requires node {minNode} or higher.",
+    updateNodeVersion: "Please update your version of node.",
+    notUsingNpm: "You are not using npm.",
+    requiresHigherNpm: "{PROGRAM_NAME} requires npm {minNpm} or higher.",
+    installNpm: "Please install npm.",
+    usingNpmVersion: "You are using npm {npmVersion}.",
+    updateNpm: "Please update your version of npm.",
+    couldNotStartNpmProcess: "Could not start an npm process in the right directory.",
+    currentDirectory: "The current directory is: {cwd}",
+    newNpmProcessRunsIn: "However, a newly started npm process runs in: {npmCWD}",
+    misconfiguredTerminalShell: "This is probably caused by a misconfigured system terminal shell.",
+    analyticsInvalidNode: "Invalid node version: {nodeVersion}",
+    analyticsNoNpm: "npm is not present",
+    analyticsInvalidNpm: "Invalid npm version: {npmVersion}",
+    analyticsNotStartNpm: "npm process could not be started"
+};

package/src/validators/index.ts

@@ -22,7 +22,5 @@
  * SOFTWARE.
  ********************************************************************************/
 
-export * from "./AddOnDirectoryValidator.js";
 export * from "./DirectoryValidator.js";
 export * from "./EnvironmentValidator.js";
-export * from "./NodeEnvironmentValidator.js";

package/templates/react-javascript/template.json

@@ -6,8 +6,8 @@
         "package": "ccweb-add-on-scripts package --use webpack"
     },
     "dependencies": {
-        "@swc-react/button": "1.0.3",
-        "@swc-react/theme": "1.0.3",
+        "@swc-react/button": "1.7.0",
+        "@swc-react/theme": "1.7.0",
         "react-dom": "18.2.0",
         "react": "18.2.0"
     },

package/templates/react-javascript-with-document-sandbox/template.json

@@ -6,8 +6,8 @@
         "package": "ccweb-add-on-scripts package --use webpack"
     },
     "dependencies": {
-        "@swc-react/button": "1.0.3",
-        "@swc-react/theme": "1.0.3",
+        "@swc-react/button": "1.7.0",
+        "@swc-react/theme": "1.7.0",
         "react-dom": "18.2.0",
         "react": "18.2.0"
     },

package/templates/react-typescript/template.json

@@ -6,8 +6,8 @@
         "package": "ccweb-add-on-scripts package --use webpack"
     },
     "dependencies": {
-        "@swc-react/button": "1.0.3",
-        "@swc-react/theme": "1.0.3",
+        "@swc-react/button": "1.7.0",
+        "@swc-react/theme": "1.7.0",
         "react-dom": "18.2.0",
         "react": "18.2.0"
     },

package/templates/react-typescript-with-document-sandbox/template.json

@@ -6,8 +6,8 @@
         "package": "ccweb-add-on-scripts package --use webpack"
     },
     "dependencies": {
-        "@swc-react/button": "1.0.3",
-        "@swc-react/theme": "1.0.3",
+        "@swc-react/button": "1.7.0",
+        "@swc-react/theme": "1.7.0",
         "react-dom": "18.2.0",
         "react": "18.2.0"
     },

package/templates/swc-javascript/template.json

@@ -6,8 +6,8 @@
         "package": "ccweb-add-on-scripts package --use webpack"
     },
     "dependencies": {
-        "@spectrum-web-components/button": "1.1.2",
-        "@spectrum-web-components/theme": "1.1.2",
+        "@spectrum-web-components/button": "1.7.0",
+        "@spectrum-web-components/theme": "1.7.0",
         "lit": "2.8.0"
     },
     "devDependencies": {

package/templates/swc-javascript-with-document-sandbox/template.json

@@ -6,8 +6,8 @@
         "package": "ccweb-add-on-scripts package --use webpack"
     },
     "dependencies": {
-        "@spectrum-web-components/button": "1.1.2",
-        "@spectrum-web-components/theme": "1.1.2",
+        "@spectrum-web-components/button": "1.7.0",
+        "@spectrum-web-components/theme": "1.7.0",
         "lit": "2.8.0"
     },
     "devDependencies": {

package/templates/swc-typescript/template.json

@@ -6,8 +6,8 @@
         "package": "ccweb-add-on-scripts package --use webpack"
     },
     "dependencies": {
-        "@spectrum-web-components/button": "1.1.2",
-        "@spectrum-web-components/theme": "1.1.2",
+        "@spectrum-web-components/button": "1.7.0",
+        "@spectrum-web-components/theme": "1.7.0",
         "lit": "2.8.0"
     },
     "devDependencies": {

package/templates/swc-typescript-with-document-sandbox/template.json

@@ -6,8 +6,8 @@
         "package": "ccweb-add-on-scripts package --use webpack"
     },
     "dependencies": {
-        "@spectrum-web-components/button": "1.1.2",
-        "@spectrum-web-components/theme": "1.1.2",
+        "@spectrum-web-components/button": "1.7.0",
+        "@spectrum-web-components/theme": "1.7.0",
         "lit": "2.8.0"
     },
     "devDependencies": {

package/dist/app/AddOnPackageManager.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"AddOnPackageManager.d.ts","sourceRoot":"","sources":["../../src/app/AddOnPackageManager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAElF,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAEnE;;GAEG;AACH,qBAAa,mBAAmB;IAC5B;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CAAC,cAAc,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,WAAW;CAaxF"}

package/dist/app/AddOnTemplateSelector.d.ts

@@ -1,54 +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 { AnalyticsService } from "@adobe/ccweb-add-on-analytics";
-import type { Logger } from "@adobe/ccweb-add-on-core";
-import "reflect-metadata";
-import type { CLIOptions } from "../models/index.js";
-import type { TemplateSelector } from "./TemplateSelector.js";
-export declare class AddOnTemplateSelector implements TemplateSelector {
-    private readonly _logger;
-    private readonly _analyticsService;
-    /**
-     * Instantiate {@link AddOnTemplateSelector}.
-     * @param logger - {@link Logger} reference.
-     * @param analyticsService - {@link AnalyticsService} reference.
-     * @returns Reference to a new {@link AddOnTemplateSelector} instance.
-     */
-    constructor(logger: Logger, analyticsService: AnalyticsService);
-    /**
-     * Sets up a template, as selected/provided by the user
-     * for scaffolding the add-on project.
-     * @param options - {@link CLIOptions}.
-     * @returns User selected/provided template name.
-     */
-    setupTemplate(options: CLIOptions): Promise<string>;
-    private _promptMessage;
-    private _promptMessageOption;
-    /**
-     * Validate whether entrypointType is valid or not.
-     * @param entrypointType - Add-on entrypoint. For example: panel.
-     */
-    private _validateAddOnEntrypoint;
-}
-//# sourceMappingURL=AddOnTemplateSelector.d.ts.map

package/dist/app/AddOnTemplateSelector.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"AddOnTemplateSelector.d.ts","sourceRoot":"","sources":["../../src/app/AddOnTemplateSelector.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAElF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAEtE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAMvD,OAAO,kBAAkB,CAAC;AAI1B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAE9D,qBACa,qBAAsB,YAAW,gBAAgB;IAC1D,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAmB;IAErD;;;;;OAKG;gBAE4B,MAAM,EAAE,MAAM,EACC,gBAAgB,EAAE,gBAAgB;IAMhF;;;;;OAKG;IACG,aAAa,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC;IAsEzD,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,oBAAoB;IAO5B;;;OAGG;YACW,wBAAwB;CA6BzC"}