@adobe/ccweb-add-on-scaffolder 0.1.0

package/src/test/app/data/first_test_app/package.json

@@ -0,0 +1,19 @@
+{
+    "name": "iframe-panel",
+    "version": "1.0.0",
+    "description": "Iframe Add-on.",
+    "scripts": {
+        "clean": "ccweb-add-on-scripts clean",
+        "build": "ccweb-add-on-scripts build",
+        "start": "ccweb-add-on-scripts start"
+    },
+    "keywords": [
+        "Adobe",
+        "Horizon",
+        "WXP",
+        "Iframe",
+        "Panel"
+    ],
+    "author": "Adobe Systems Inc.",
+    "license": "ISC"
+}

package/src/test/app/data/first_test_app/src/manifest.json

@@ -0,0 +1,21 @@
+{
+    "testId": "",
+    "name": "",
+    "version": "",
+    "manifestVersion": 2,
+    "requirements": {
+        "apps": [
+            {
+                "name": "Express",
+                "apiVersion": 1
+            }
+        ]
+    },
+    "entryPoints": [
+        {
+            "type": "panel",
+            "id": "panel1",
+            "main": "index.html"
+        }
+    ]
+}

package/src/test/app/data/second-test-app/package.json

@@ -0,0 +1,19 @@
+{
+    "name": "iframe-panel",
+    "version": "1.0.0",
+    "description": "Iframe Add-on.",
+    "scripts": {
+        "clean": "ccweb-add-on-scripts clean",
+        "build": "ccweb-add-on-scripts build",
+        "start": "ccweb-add-on-scripts start"
+    },
+    "keywords": [
+        "Adobe",
+        "Horizon",
+        "WXP",
+        "Iframe",
+        "Panel"
+    ],
+    "author": "Adobe Systems Inc.",
+    "license": "ISC"
+}

package/src/test/app/data/second-test-app/src/manifest.json

@@ -0,0 +1,33 @@
+{
+    "id": "",
+    "name": "",
+    "version": "",
+    "manifestVersion": 1,
+    "requirements": {
+        "apps": ["Express"]
+    },
+    "icon": [
+        {
+            "width": 100,
+            "height": 100,
+            "path": "icon-light.png",
+            "theme": ["light"]
+        },
+        {
+            "width": 100,
+            "height": 100,
+            "path": "icon-dark.png",
+            "theme": ["dark"]
+        }
+    ],
+    "entryPoints": [
+        {
+            "type": "panel",
+            "id": "panel1",
+            "label": {
+                "default": ""
+            },
+            "main": "index.html"
+        }
+    ]
+}

package/src/test/app/data/third-test-app/.template/template.json

@@ -0,0 +1,10 @@
+{
+    "scripts": {
+        "clean": "ccweb-add-on-scripts clean",
+        "build": "ccweb-add-on-scripts build",
+        "start": "ccweb-add-on-scripts start"
+    },
+    "devDependencies": {
+        "prettier": "2.6.0"
+    }
+}

package/src/test/app/data/third-test-app/package.json

@@ -0,0 +1,19 @@
+{
+    "name": "iframe-panel",
+    "version": "1.0.0",
+    "description": "Iframe Add-on",
+    "scripts": {
+        "clean": "ccweb-add-on-scripts clean",
+        "build": "ccweb-add-on-scripts build",
+        "start": "ccweb-add-on-scripts start"
+    },
+    "keywords": [
+        "Adobe",
+        "Horizon",
+        "WXP",
+        "Iframe",
+        "Panel"
+    ],
+    "author": "Adobe Systems Inc.",
+    "license": "ISC"
+}

package/src/test/app/data/third-test-app/src/manifest.json

@@ -0,0 +1,23 @@
+{
+    "id": "",
+    "name": "",
+    "version": "",
+    "manifestVersion": 1,
+    "requirements": {
+        "apps": ["Express"]
+    },
+    "icon": [
+        {
+            "width": 100,
+            "height": 100,
+            "path": "icon-light.png",
+            "theme": ["light"]
+        },
+        {
+            "width": 100,
+            "height": 100,
+            "path": "icon-dark.png",
+            "theme": ["dark"]
+        }
+    ]
+}

package/src/test/models/ScaffolderOptions.spec.ts

@@ -0,0 +1,61 @@
+/********************************************************************************
+ * 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 { EntrypointType } from "@adobe/ccweb-add-on-manifest";
+import { assert } from "chai";
+import "mocha";
+import { ScaffolderOptions } from "../../models/index.js";
+
+describe("ScaffolderOptions", () => {
+    describe("constructor", () => {
+        const runs = [
+            {
+                addOnDirectory: "/apps/test-app",
+                addOnName: "test-app",
+                addOnKind: EntrypointType.PANEL,
+                rootDirectory: "/apps",
+                templateName: "javascript",
+                verbose: false
+            }
+        ];
+        runs.forEach(run => {
+            it(`should create a new instance for: ${run.addOnKind}.`, () => {
+                const scaffolderOptions = new ScaffolderOptions(
+                    run.addOnDirectory,
+                    run.addOnName,
+                    run.addOnKind as EntrypointType,
+                    run.rootDirectory,
+                    run.templateName,
+                    run.verbose
+                );
+                assert.equal(scaffolderOptions.addOnDirectory, run.addOnDirectory);
+                assert.equal(scaffolderOptions.addOnName, run.addOnName);
+                assert.equal(scaffolderOptions.addOnKind, run.addOnKind);
+                assert.equal(scaffolderOptions.rootDirectory, run.rootDirectory);
+                assert.equal(scaffolderOptions.templateName, run.templateName);
+                assert.equal(scaffolderOptions.verbose, run.verbose);
+            });
+        });
+    });
+});

package/src/test/validators/AppTemplateValidator.spec.ts

@@ -0,0 +1,98 @@
+/********************************************************************************
+ * 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 { assert } from "chai";
+import "mocha";
+import type { SinonSandbox } from "sinon";
+import sinon from "sinon";
+import type { StubbedInstance } from "ts-sinon";
+import { stubInterface } from "ts-sinon";
+import { PROGRAM_NAME } from "../../constants.js";
+import type { TemplateValidator } from "../../validators/index.js";
+import { AddOnTemplateValidator } from "../../validators/index.js";
+
+describe("AddOnTemplateValidator", () => {
+    describe("validateTemplate ...", () => {
+        let sandbox: SinonSandbox;
+        let logger: StubbedInstance<Logger>;
+        let validator: TemplateValidator;
+
+        beforeEach(() => {
+            sandbox = sinon.createSandbox();
+            logger = stubInterface<Logger>();
+            validator = new AddOnTemplateValidator(logger);
+        });
+
+        afterEach(() => {
+            sandbox.restore();
+        });
+
+        let runs = [{ template: "" }, { template: " " }];
+        runs.forEach(run => {
+            it(`should exit for empty template: ${run.template}.`, () => {
+                const processExitStub = sandbox.stub(process, "exit");
+
+                validator.validateTemplate(run.template);
+
+                assert.equal(logger.warning.callCount, 2);
+                assert.equal(logger.warning.getCall(0).calledWith("Please specify a valid template name:"), true);
+                assert.equal(
+                    logger.warning
+                        .getCall(1)
+                        .calledWith(`${PROGRAM_NAME} --template <template-name>`, { prefix: "  " }),
+                    true
+                );
+
+                assert.equal(logger.message.callCount, 1);
+                assert.equal(
+                    logger.message.calledWith("For example:", {
+                        prefix: "\n"
+                    }),
+                    true
+                );
+
+                assert.equal(logger.information.callCount, 1);
+                assert.equal(
+                    logger.information.calledWith(`${PROGRAM_NAME} --template javascript`, { prefix: "  " }),
+                    true
+                );
+
+                assert.equal(processExitStub.callCount, 1);
+                assert.equal(processExitStub.calledWith(1), true);
+            });
+        });
+
+        runs = [{ template: "javascript" }];
+        runs.forEach(run => {
+            it(`should return for non-empty template: ${run.template}.`, () => {
+                const processExitStub = sandbox.stub(process, "exit");
+
+                validator.validateTemplate(run.template);
+
+                assert.equal(processExitStub.callCount, 0);
+            });
+        });
+    });
+});

package/src/validators/AddOnTemplateValidator.ts

@@ -0,0 +1,79 @@
+/********************************************************************************
+ * 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:"
+};

package/src/validators/TemplateValidator.ts

@@ -0,0 +1,35 @@
+/********************************************************************************
+ * 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.
+ ********************************************************************************/
+
+/**
+ * Template validator interface to validate user selected template.
+ */
+export interface TemplateValidator {
+    /**
+     * Validate the template.
+     *
+     * @param templateName - Name of the template.
+     */
+    validateTemplate(templateName: string): void;
+}

package/src/validators/index.ts

@@ -0,0 +1,26 @@
+/********************************************************************************
+ * 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.
+ ********************************************************************************/
+
+export * from "./AddOnTemplateValidator.js";
+export * from "./TemplateValidator.js";

package/tsconfig.json

@@ -0,0 +1,28 @@
+{
+    "compilerOptions": {
+        "allowSyntheticDefaultImports": true,
+        "declaration": true,
+        "declarationMap": true,
+        "emitDecoratorMetadata": true,
+        "esModuleInterop": true,
+        "experimentalDecorators": true,
+        "forceConsistentCasingInFileNames": true,
+        "importHelpers": true,
+        "incremental": true,
+        "isolatedModules": true,
+        "module": "ESNext",
+        "moduleResolution": "node",
+        "noImplicitOverride": false,
+        "noUnusedLocals": true,
+        "outDir": "dist",
+        "preserveConstEnums": true,
+        "resolveJsonModule": true,
+        "sourceMap": true,
+        "strict": true,
+        "target": "ESNext",
+        "types": ["reflect-metadata"],
+        "useUnknownInCatchVariables": false
+    },
+    "exclude": ["node_modules", "src/test/**/*"],
+    "include": ["src/**/*"]
+}