@adobe/ccweb-add-on-scaffolder 0.1.0

package/src/config/inversify.config.ts

@@ -0,0 +1,58 @@
+/********************************************************************************
+ * 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, PackageJson, TemplateJson } from "@adobe/ccweb-add-on-core";
+import { IContainer as ICoreContainer, ITypes as ICoreTypes } from "@adobe/ccweb-add-on-core";
+import type { interfaces } from "inversify";
+import "reflect-metadata";
+import type { AddOnBuilder, AddOnScaffolder, PackageBuilder } from "../app/index.js";
+import { TemplateAddOnBuilder, TemplateAddOnScaffolder, TemplatePackageBuilder } from "../app/index.js";
+import type { ScaffolderOptions } from "../models/ScaffolderOptions.js";
+import type { TemplateValidator } from "../validators/index.js";
+import { AddOnTemplateValidator } from "../validators/index.js";
+import { ITypes } from "./inversify.types.js";
+
+const container = ICoreContainer;
+
+container
+    .bind<interfaces.Factory<AddOnBuilder>>(ITypes.AddOnBuilder)
+    .toFactory<AddOnBuilder, [ScaffolderOptions]>(context => {
+        return (options: ScaffolderOptions) => {
+            return new TemplateAddOnBuilder(options, context.container.get<Logger>(ICoreTypes.Logger));
+        };
+    });
+
+container
+    .bind<interfaces.Factory<PackageBuilder>>(ITypes.PackageBuilder)
+    .toFactory<PackageBuilder, [PackageJson], [TemplateJson]>(() => {
+        return (packageJson: PackageJson) => (templateJson: TemplateJson) => {
+            return new TemplatePackageBuilder(packageJson, templateJson);
+        };
+    });
+
+container.bind<TemplateValidator>(ITypes.TemplateValidator).to(AddOnTemplateValidator).inSingletonScope();
+
+container.bind<AddOnScaffolder>(ITypes.AddOnScaffolder).to(TemplateAddOnScaffolder).inSingletonScope();
+
+export { container as IContainer };

package/src/config/inversify.types.ts

@@ -0,0 +1,31 @@
+/********************************************************************************
+ * 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 const ITypes = {
+    Command: Symbol.for("Command"),
+    AddOnScaffolder: Symbol.for("AddOnScaffolder"),
+    AddOnBuilder: Symbol.for("AddOnBuilder"),
+    PackageBuilder: Symbol.for("PackageBuilder"),
+    TemplateValidator: Symbol.for("TemplateValidator")
+};

package/src/constants.ts

@@ -0,0 +1,36 @@
+/********************************************************************************
+ * 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 const PACKAGE_NAME = "@adobe/ccweb-add-on-scaffolder";
+export const PROGRAM_NAME = "ccweb-add-on-scaffolder";
+
+export const PACKAGE_JSON = "package.json";
+export const TEMPLATE_JSON = "template.json";
+export const MANIFEST_JSON = "manifest.json";
+
+export const TEMP_TEMPLATE_PATH = ".template";
+
+export enum AnalyticsErrorMarkers {
+    ERROR_INVALID_ARGS = "ERROR_INVALID_ARGS"
+}

package/src/index.ts

@@ -0,0 +1,28 @@
+/********************************************************************************
+ * 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 "./app/AddOnScaffolder.js";
+export * from "./config/index.js";
+export * from "./constants.js";
+export * from "./models/index.js";

package/src/models/ScaffolderOptions.ts

@@ -0,0 +1,86 @@
+/********************************************************************************
+ * 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 { EntrypointType } from "@adobe/ccweb-add-on-manifest";
+
+/**
+ * Options for scaffolding an add-on.
+ */
+export class ScaffolderOptions {
+    /**
+     * Path of the Add-on directory.
+     */
+    readonly addOnDirectory: string;
+
+    /**
+     * Name of the Add-on.
+     */
+    readonly addOnName: string;
+
+    /**
+     * Kind of the Add-on. For example: panel.
+     */
+    readonly addOnKind: EntrypointType;
+
+    /**
+     * Path of the Add-on root directory.
+     */
+    readonly rootDirectory: string;
+
+    /**
+     * Name of the template with which the Add-on is to be scaffolded.
+     */
+    readonly templateName: string;
+
+    /**
+     * Verbose flag.
+     */
+    readonly verbose: boolean;
+
+    /**
+     * Instantiate {@link ScaffolderOptions}.
+     * @param addOnDirectory - Path of the Add-on directory.
+     * @param addOnName - Name of the Add-on.
+     * @param addOnKind - Kind of the Add-on. For example: panel.
+     * @param rootDirectory - Path of the Add-on root directory.
+     * @param templateName - Name of the template with which the Add-on is to be scaffolded.
+     * @param verbose - Verbose flag.
+     * @returns Reference to a new {@link ScaffolderOptions} instance.
+     */
+    constructor(
+        addOnDirectory: string,
+        addOnName: string,
+        addOnKind: EntrypointType,
+        rootDirectory: string,
+        templateName: string,
+        verbose: boolean
+    ) {
+        this.addOnDirectory = addOnDirectory;
+        this.addOnName = addOnName;
+        this.addOnKind = addOnKind;
+        this.rootDirectory = rootDirectory;
+        this.templateName = templateName;
+        this.verbose = verbose;
+    }
+}

package/src/models/index.ts

@@ -0,0 +1,25 @@
+/********************************************************************************
+ * 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 "./ScaffolderOptions.js";