@vamship/build-utils 2.0.0 → 2.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vamship/build-utils",
-    "version": "2.0.0",
+    "version": "2.2.0",
     "description": "Utility library for build tooling",
     "type": "module",
     "main": "src/index.js",
@@ -46,29 +46,29 @@
     },
     "homepage": "https://github.com/vamship/build-utils#readme",
     "devDependencies": {
-        "c8": "^9.1.0",
+        "c8": "^10.1.2",
         "chai": "^4.4.1",
-        "dot-prop": "^8.0.2",
+        "dot-prop": "^9.0.0",
         "eslint": "^8.56.0",
-        "esmock": "^2.6.5",
-        "gulp-eslint-new": "^2.0.0",
+        "esmock": "^2.6.6",
+        "gulp-eslint-new": "^2.1.0",
         "jsdoc": "^4.0.3",
-        "mocha": "^10.4.0",
-        "nodemon": "^3.1.0",
-        "prettier": "^3.2.5",
+        "mocha": "^10.5.2",
+        "nodemon": "^3.1.4",
+        "prettier": "^3.3.2",
         "rewire": "^7.0.0",
-        "sinon": "^17.0.2",
+        "sinon": "^18.0.0",
         "sinon-chai": "^3.7.0"
     },
     "dependencies": {
-        "ajv": "^8.13.0",
+        "ajv": "^8.16.0",
         "ansi-colors": "^4.1.3",
         "change-case": "^5.4.4",
         "delete": "^1.1.0",
         "docdash": "^2.0.2",
         "dotenv": "^16.4.5",
         "dotenv-expand": "^11.0.6",
-        "execa": "^9.0.1",
+        "execa": "^9.3.0",
         "fancy-log": ">=2.0.0",
         "mkdirp": "^3.0.1",
         "semver": "^7.6.2"
@@ -91,7 +91,7 @@
     },
     "optionalDependencies": {
         "gulp-jsdoc3": "= 3.0.0",
-        "typedoc": ">=0.25.13",
-        "typescript": ">=5.4.5"
+        "typedoc": ">=0.26.2",
+        "typescript": ">=5.5.2"
     }
 }

package/src/directory.js

@@ -1,4 +1,5 @@
 import _path from 'path';
+import _fs from 'fs';
 
 const _sepRegexp = new RegExp(_path.sep.replace(/\\/g, '\\\\'), 'g');
 
@@ -120,6 +121,16 @@ export class Directory {
         return this._globPath;
     }
 
+    /**
+     * Returns a boolean indicating whether the directory exists on the file
+     * system.
+     *
+     * @return {Boolean} True if the directory exists, false otherwise.
+     */
+    exists() {
+        return _fs.existsSync(this.absolutePath);
+    }
+
     /**
      * Adds a child directory object to the current directory.
      *

package/src/project.js

@@ -57,6 +57,12 @@ export class Project {
             );
         }
 
+        if (type === 'aws-microservice' && !aws) {
+            throw new Error(
+                `AWS microservice projects require AWS configuration`,
+            );
+        }
+
         if (aws && aws.stacks && Object.keys(aws.stacks).length <= 0) {
             throw new Error(`No AWS stacks defined`);
         }
@@ -243,6 +249,11 @@ export class Project {
      * @return {Array} A list of stack keys
      */
     getCdkTargets() {
+        if (this._type !== 'aws-microservice') {
+            throw new Error(
+                'CDK targets are only available for AWS microservices',
+            );
+        }
         return Object.keys(this._cdkTargets);
     }
 

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

@@ -36,9 +36,13 @@ export class BuildJsTaskBuilder extends TaskBuilder {
         }
 
         const { rootDir } = project;
-        const dirs = ['src', 'test', 'infra'];
+        const dirs = ['src', 'test'];
         const extensions = ['js'];
 
+        if (project.type === 'aws-microservice') {
+            dirs.push('infra');
+        }
+
         const paths = dirs
             .map((dir) => rootDir.getChild(dir))
             .map((dir) => extensions.map((ext) => dir.getAllFilesGlob(ext)))

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

@@ -35,9 +35,13 @@ export class BuildTsTaskBuilder extends TaskBuilder {
         }
 
         const { rootDir } = project;
-        const dirs = ['src', 'test', 'infra'];
+        const dirs = ['src', 'test'];
         const extensions = ['ts'];
 
+        if (project.type === 'aws-microservice') {
+            dirs.push('infra');
+        }
+
         const paths = dirs
             .map((dir) => rootDir.getChild(dir))
             .map((dir) => extensions.map((ext) => dir.getAllFilesGlob(ext)))

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

@@ -36,7 +36,7 @@ export class CopyFilesTaskBuilder extends TaskBuilder {
         }
 
         const { rootDir } = project;
-        const dirs = ['src', 'test', 'infra'];
+        const dirs = ['src', 'test'];
         const extensions = ['json'].concat(project.getStaticFilePatterns());
         const containerBuildFiles = project
             .getContainerTargets()
@@ -46,6 +46,10 @@ export class CopyFilesTaskBuilder extends TaskBuilder {
                     'Dockerfile',
             );
 
+        if (project.type === 'aws-microservice') {
+            dirs.push('infra');
+        }
+
         const extras = [
             project.configFileName,
             'package-lock.json',

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

@@ -32,10 +32,14 @@ export class FormatTaskBuilder extends TaskBuilder {
             throw new Error('Invalid project (arg #1)');
         }
 
-        const dirs = ['src', 'test', 'infra', '.gulp'];
+        const dirs = ['src', 'test'];
         const extras = ['Gulpfile.js', 'README.md'];
         const extensions = ['ts', 'js', 'json', 'py', 'tsx', 'jsx'];
 
+        if (project.type === 'aws-microservice') {
+            dirs.push('infra');
+        }
+
         const paths = dirs
             .map((dir) => project.rootDir.getChild(dir))
             .map((dir) => extensions.map((ext) => dir.getAllFilesGlob(ext)))

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

@@ -35,10 +35,14 @@ export class LintFixTaskBuilder extends TaskBuilder {
             throw new Error('Invalid project (arg #1)');
         }
 
-        const dirs = ['src', 'test', 'infra', '.gulp'];
+        const dirs = ['src', 'test'];
         const extras = ['Gulpfile.js'];
         const extensions = ['ts', 'js', 'tsx', 'jsx'];
 
+        if (project.type === 'aws-microservice') {
+            dirs.push('infra');
+        }
+
         const paths = dirs
             .map((dir) => project.rootDir.getChild(dir))
             .map((dir) => extensions.map((ext) => dir.getAllFilesGlob(ext)))

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

@@ -31,10 +31,14 @@ export class LintTaskBuilder extends TaskBuilder {
             throw new Error('Invalid project (arg #1)');
         }
 
-        const dirs = ['src', 'test', 'infra', '.gulp'];
+        const dirs = ['src', 'test'];
         const extras = ['Gulpfile.js'];
         const extensions = ['ts', 'js', 'tsx', 'jsx'];
 
+        if (project.type === 'aws-microservice') {
+            dirs.push('infra');
+        }
+
         const paths = dirs
             .map((dir) => project.rootDir.getChild(dir))
             .map((dir) => extensions.map((ext) => dir.getAllFilesGlob(ext)))

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

@@ -12,12 +12,21 @@ import { Project } from '../project.js';
 export class NotSupportedTaskBuilder extends TaskBuilder {
     /**
      * Creates a new task builder.
+     *
+     * @param {String} [message] An optional message to display when the task is
+     * run.
      */
-    constructor() {
+    constructor(message) {
         super(
             'not-supported',
             `Task that does nothing - used to indicate that a task is not supported for a project type.`,
         );
+
+        if (typeof message !== 'string' || message.length <= 0) {
+            message = 'Task not defined for project';
+        }
+
+        this._message = message;
     }
 
     /**
@@ -33,7 +42,7 @@ export class NotSupportedTaskBuilder extends TaskBuilder {
         if (!(project instanceof Project)) {
             throw new Error('Invalid project (arg #1)');
         }
-        return () => _fancyLog.warn('Task not defined for project');
+        return async () => _fancyLog.warn(this._message);
     }
 
     /**

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

@@ -89,13 +89,17 @@ export class PackageAwsTaskBuilder extends TaskBuilder {
         if (!(project instanceof Project)) {
             throw new Error('Invalid project (arg #1)');
         }
-        const dirs = ['src', 'test', 'infra'];
+        const dirs = ['src', 'test'];
         const exts = ['md', 'html', 'json', 'js', 'jsx', 'ts', 'tsx'];
         const rootDir =
             project.language === 'ts'
                 ? project.rootDir.getChild('working')
                 : project.rootDir;
 
+        if (project.type === 'aws-microservice') {
+            dirs.push('infra');
+        }
+
         return dirs
             .map((dir) =>
                 exts.map((ext) => rootDir.getChild(dir).getAllFilesGlob(ext)),

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

@@ -116,13 +116,17 @@ export class PackageContainerTaskBuilder extends TaskBuilder {
         if (!(project instanceof Project)) {
             throw new Error('Invalid project (arg #1)');
         }
-        const dirs = ['src', 'test', 'infra'];
+        const dirs = ['src', 'test'];
         const exts = ['md', 'html', 'json', 'js', 'jsx', 'ts', 'tsx'];
         const rootDir =
             project.language === 'ts'
                 ? project.rootDir.getChild('working')
                 : project.rootDir;
 
+        if (project.type === 'aws-microservice') {
+            dirs.push('infra');
+        }
+
         return dirs
             .map((dir) =>
                 exts.map((ext) => rootDir.getChild(dir).getAllFilesGlob(ext)),

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

@@ -69,13 +69,17 @@ export class PackageNpmTaskBuilder extends TaskBuilder {
         if (!(project instanceof Project)) {
             throw new Error('Invalid project (arg #1)');
         }
-        const dirs = ['src', 'test', 'infra'];
+        const dirs = ['src', 'test'];
         const exts = ['md', 'html', 'json', 'js', 'jsx', 'ts', 'tsx'];
         const rootDir =
             project.language === 'ts'
                 ? project.rootDir.getChild('working')
                 : project.rootDir;
 
+        if (project.type === 'aws-microservice') {
+            dirs.push('infra');
+        }
+
         return dirs
             .map((dir) =>
                 exts.map((ext) => rootDir.getChild(dir).getAllFilesGlob(ext)),

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

@@ -30,7 +30,11 @@ export class PublishAwsTaskBuilder extends TaskBuilder {
         if (typeof requireApproval !== 'boolean') {
             throw new Error('Invalid requireApproval (arg #3)');
         }
-        super('publish-aws', `Publish a CDK project to AWS`);
+
+        super(
+            `publish-aws-${target}`,
+            `Publish a CDK project to AWS: [${target}]`,
+        );
 
         this._target = target;
         this._environment = environment;

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

@@ -59,7 +59,24 @@ export class PublishTaskBuilder extends TaskBuilder {
         }
         // Type aws-microservice
         else if (type === 'aws-microservice') {
-            return [new PublishAwsTaskBuilder()];
+            const stacks = project.getCdkTargets();
+            const defaultStack = stacks.find((target) => target === 'default');
+
+            if (defaultStack) {
+                return [
+                    new PublishAwsTaskBuilder(
+                        defaultStack,
+                        process.env.INFRA_ENV,
+                        process.env.INFRA_NO_PROMPT === 'true',
+                    ),
+                ];
+            } else {
+                return [
+                    new NotSupportedTaskBuilder(
+                        'No default stack defined for project. Please use an explicitly named publish task.',
+                    ),
+                ];
+            }
         }
         // Type container
         else if (type === 'container') {

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

@@ -69,13 +69,17 @@ export class TestTaskBuilder extends TaskBuilder {
         if (!(project instanceof Project)) {
             throw new Error('Invalid project (arg #1)');
         }
-        const dirs = ['src', 'test', 'infra'];
+        const dirs = ['src', 'test'];
         const exts = ['md', 'html', 'json', 'js', 'jsx', 'ts', 'tsx'];
         const rootDir =
             project.language === 'ts'
                 ? project.rootDir.getChild('working')
                 : project.rootDir;
 
+        if (project.type === 'aws-microservice') {
+            dirs.push('infra');
+        }
+
         return dirs
             .map((dir) =>
                 exts.map((ext) => rootDir.getChild(dir).getAllFilesGlob(ext)),

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

@@ -49,13 +49,17 @@ export class TestUiTaskBuilder extends TaskBuilder {
         if (!(project instanceof Project)) {
             throw new Error('Invalid project (arg #1)');
         }
-        const dirs = ['src', 'test', 'infra'];
+        const dirs = ['src', 'test'];
         const exts = ['md', 'html', 'json', 'js', 'jsx', 'ts', 'tsx'];
         const rootDir =
             project.language === 'ts'
                 ? project.rootDir.getChild('working')
                 : project.rootDir;
 
+        if (project.type === 'aws-microservice') {
+            dirs.push('infra');
+        }
+
         return dirs
             .map((dir) =>
                 exts.map((ext) => rootDir.getChild(dir).getAllFilesGlob(ext)),

package/src/task-factories/aws-microservice-task-factory.js

@@ -9,6 +9,7 @@ import { PackageTaskBuilder } from '../task-builders/package-task-builder.js';
 import { PublishTaskBuilder } from '../task-builders/publish-task-builder.js';
 import { DocsTaskBuilder } from '../task-builders/docs-task-builder.js';
 import { TestTaskBuilder } from '../task-builders/test-task-builder.js';
+import { PublishAwsTaskBuilder } from '../task-builders/publish-aws-task-builder.js';
 
 /**
  * Represents a factory that generates a set of build tasks for a given project
@@ -36,6 +37,18 @@ export class AwsMicroserviceTaskFactory extends TaskFactory {
             return [];
         }
 
+        const publishTasks = this._project
+            .getCdkTargets()
+            .filter((stack) => stack !== 'default')
+            .map(
+                (stack) =>
+                    new PublishAwsTaskBuilder(
+                        stack,
+                        process.env.INFRA_ENV,
+                        process.env.INFRA_NO_PROMPT === 'true',
+                    ),
+            );
+
         return [
             new CleanTaskBuilder(),
             new FormatTaskBuilder(),
@@ -47,7 +60,7 @@ export class AwsMicroserviceTaskFactory extends TaskFactory {
             new DocsTaskBuilder(this._project),
             new BuildTaskBuilder(this._project),
             new PackageTaskBuilder(this._project),
-            new PublishTaskBuilder(this._project),
-        ];
+            new PublishTaskBuilder(),
+        ].concat(publishTasks);
     }
 }