@vamship/build-utils 2.4.3 → 2.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vamship/build-utils",
-    "version": "2.4.3",
+    "version": "2.5.0",
     "description": "Utility library for build tooling",
     "type": "module",
     "main": "src/index.js",

package/src/project.js

@@ -45,6 +45,7 @@ export class Project {
                 type,
                 language,
                 requiredEnv,
+                staticDirs,
                 staticFilePatterns,
                 aws,
                 container,
@@ -63,7 +64,7 @@ export class Project {
             );
         }
 
-        if (aws && aws.stacks && Object.keys(aws.stacks).length <= 0) {
+        if (aws?.stacks && Object.keys(aws.stacks).length <= 0) {
             throw new Error(`No AWS stacks defined`);
         }
 
@@ -75,6 +76,7 @@ export class Project {
         this._type = type;
         this._language = language;
         this._staticFilePatterns = staticFilePatterns || [];
+        this._staticDirs = staticDirs || [];
         this._requiredEnv = requiredEnv || [];
         this._aws = aws || { stacks: {} };
         this._cdkTargets = Object.keys(this._aws.stacks).reduce(
@@ -103,7 +105,7 @@ export class Project {
             {},
         );
 
-        this._rootDir = Directory.createTree('./', {
+        const rootDir = {
             src: null,
             test: {
                 unit: null,
@@ -130,7 +132,14 @@ export class Project {
             '.tscache': null,
             logs: null,
             'cdk.out': null,
-        });
+        };
+
+        for (const dir of this._staticDirs) {
+            rootDir[dir] = null;
+            rootDir.working[dir] = null;
+        }
+
+        this._rootDir = Directory.createTree('./', rootDir);
         this._banner = `${_colors.cyan(this._name)}@${_colors.green(
             this._version,
         )} (${_colors.blue(this._type)} - ${_colors.yellow(this._language)})`;
@@ -237,6 +246,16 @@ export class Project {
         return this._staticFilePatterns.concat([]);
     }
 
+    /**
+     * Returns a list of static file directories configured for the project.
+     *
+     * @returns {Array} An array of strings used to identify static files
+     * included in the build.
+     */
+    getStaticDirs() {
+        return this._staticDirs.concat([]);
+    }
+
     /**
      * Returns a list of environment variables that must be defined for the
      * build.

package/src/schema/project-definition.js

@@ -158,6 +158,12 @@ export default {
                  * process without any compilation/modification.
                  */
                 staticFilePatterns: { type: 'array' },
+
+                /**
+                 * Any static directories that should be copied over during the build
+                 * process without any compilation/modification.
+                 */
+                staticDirs: { type: 'array' },
             },
             required: ['type', 'language'],
         },

package/src/task-builders/copy-files-task-builder.js

@@ -69,9 +69,17 @@ export class CopyFilesTaskBuilder extends TaskBuilder {
             .reduce((result, arr) => result.concat(arr), [])
             .concat(extras.map((item) => rootDir.getFileGlob(item)));
 
+        const staticPaths = project
+            .getStaticDirs()
+            .map((dir) => rootDir.getChild(dir))
+            .filter((dir) => dir.exists())
+            .map((dir) => dir.getAllFilesGlob());
+
+        const finalPaths = paths.concat(staticPaths);
+
         const task = () =>
             _gulp
-                .src(paths, {
+                .src(finalPaths, {
                     allowEmpty: true,
                     base: rootDir.globPath,
                 })

package/src/task-builders/package-task-builder.js

@@ -64,8 +64,8 @@ export class PackageTaskBuilder extends TaskBuilder {
         else if (type === 'aws-microservice') {
             return [new PackageAwsTaskBuilder()];
         }
-        // Type container
-        else if (type === 'container') {
+        // Type container or api or ui
+        else if (type === 'container' || type === 'api' || type === 'ui') {
             return [new PackageContainerTaskBuilder('default')];
         }
         // Type cli
@@ -76,10 +76,6 @@ export class PackageTaskBuilder extends TaskBuilder {
                 return [new PackageNpmTaskBuilder()];
             }
         }
-        // Type api
-        else if (type === 'api') {
-            return [new PackageContainerTaskBuilder('default')];
-        }
         // Type ui (and potentially others that are not supported)
         else {
             return [new NotSupportedTaskBuilder()];

package/src/task-builders/publish-task-builder.js

@@ -78,8 +78,8 @@ export class PublishTaskBuilder extends TaskBuilder {
                 ];
             }
         }
-        // Type container
-        else if (type === 'container') {
+        // Type container or api or ui
+        else if (type === 'container' || type === 'api' || type === 'ui') {
             return [
                 new PublishContainerTaskBuilder('default', project.version),
             ];
@@ -94,12 +94,6 @@ export class PublishTaskBuilder extends TaskBuilder {
                 return [new PublishNpmTaskBuilder()];
             }
         }
-        // Type api
-        else if (type === 'api') {
-            return [
-                new PublishContainerTaskBuilder('default', project.version),
-            ];
-        }
         // Type ui (and potentially others that are not supported)
         else {
             return [new NotSupportedTaskBuilder()];

package/src/task-factories/ui-task-factory.js

@@ -8,6 +8,12 @@ import { BuildTaskBuilder } from '../task-builders/build-task-builder.js';
 import { DocsTaskBuilder } from '../task-builders/docs-task-builder.js';
 import { TestUiTaskBuilder } from '../task-builders/test-ui-task-builder.js';
 
+import { PackageTaskBuilder } from '../task-builders/package-task-builder.js';
+import { PublishTaskBuilder } from '../task-builders/publish-task-builder.js';
+import { generateAdditionalContainerTasks } from '../utils/task-factory-utils.js';
+import { PublishContainerTaskBuilder } from '../task-builders/publish-container-task-builder.js';
+import { PackageContainerTaskBuilder } from '../task-builders/package-container-task-builder.js';
+
 /**
  * Represents a factory that generates a set of build tasks for a given project
  * type. This is an abstract class that must be extended to provide a list of
@@ -34,6 +40,15 @@ export class UiTaskFactory extends TaskFactory {
             return [];
         }
 
+        // Helper function to generate the set of tasks for each additional container
+        // if needed
+        const additionalTaskList = (target) => {
+            return [
+                new PackageContainerTaskBuilder(target),
+                new PublishContainerTaskBuilder(target, this._project.version),
+            ];
+        };
+
         return [
             new CleanTaskBuilder(),
             new FormatTaskBuilder(),
@@ -43,6 +58,11 @@ export class UiTaskFactory extends TaskFactory {
 
             new DocsTaskBuilder(this._project),
             new BuildTaskBuilder(this._project),
-        ];
+            new PackageTaskBuilder(this._project),
+            new PublishTaskBuilder(this._project),
+            new PublishContainerTaskBuilder('default'),
+        ].concat(
+            generateAdditionalContainerTasks(this._project, additionalTaskList),
+        );
     }
 }