@vamship/build-utils 1.6.1 → 2.0.0-1

package/src/utils/task-factory-utils.js

@@ -0,0 +1,70 @@
+import { Project } from '../project.js';
+import { LibTaskFactory } from '../task-factories/lib-task-factory.js';
+import { ApiTaskFactory } from '../task-factories/api-task-factory.js';
+import { CliTaskFactory } from '../task-factories/cli-task-factory.js';
+import { AwsMicroserviceTaskFactory } from '../task-factories/aws-microservice-task-factory.js';
+import { UiTaskFactory } from '../task-factories/ui-task-factory.js';
+import { ContainerTaskFactory } from '../task-factories/container-task-factory.js';
+
+/**
+ * For a project that has multiple containers defined, this function will return
+ * the additional tasks for each container. These tasks may be called by name
+ * following the naming convention package-container-${targetContainerName} and
+ * publish-container-${targetContainerName} for example.
+ *
+ * @param {Project} project The project for which to generate additional package
+ * and publish tasks.
+ * @param {Function} additionalTaskList A function that returns the set of task
+ * builders to be generated for each container. Takes container target as input.
+ * @returns {Array} An array of tasks, empty if no extra containers are defined
+ */
+export function generateAdditionalContainerTasks(project, additionalTaskList) {
+    if (!(project instanceof Project)) {
+        throw new Error('Invalid project (arg #1)');
+    }
+
+    if (typeof additionalTaskList !== 'function') {
+        throw new Error('Invalid additionalTaskList (arg #2)');
+    }
+
+    const tasks = [];
+    const containerTargets = project.getContainerTargets();
+
+    // > 1 since default container
+    if (containerTargets.length > 1) {
+        containerTargets
+            .filter((target) => target !== 'default')
+            .forEach((target) => {
+                tasks.push(...additionalTaskList(target));
+            });
+    }
+
+    return tasks;
+}
+
+/**
+ * Initializes a task factory for a given project type.
+ *
+ * @param {Project} project The project to generate build tasks for.
+ * @returns {TaskFactory} A task factory for the given project type.
+ */
+export function getTaskFactory(project) {
+    if (!(project instanceof Project)) {
+        throw new Error('Invalid project (arg #1)');
+    }
+    if (project.type === 'lib') {
+        return new LibTaskFactory(project);
+    } else if (project.type === 'api') {
+        return new ApiTaskFactory(project);
+    } else if (project.type === 'cli') {
+        return new CliTaskFactory(project);
+    } else if (project.type === 'ui') {
+        return new UiTaskFactory(project);
+    } else if (project.type === 'aws-microservice') {
+        return new AwsMicroserviceTaskFactory(project);
+    } else if (project.type === 'container') {
+        return new ContainerTaskFactory(project);
+    } else {
+        throw new Error(`Unrecognized project type (value=${project.type})`);
+    }
+}

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

@@ -1,66 +0,0 @@
-'use strict';
-
-const _gulp = require('gulp');
-
-/**
- * Sub builder that creates a task that will copy javascript files from source
- * to build directories. This method will return a watcher if the watch option
- * is set to true.
- *
- * @private
- * @param {Object} project Reference to an object that contains project metadata
- *        that can be used to customize build outputs.
- * @param {Object} options An options object that can be used to customize the
- *        task.
- *
- * @returns {Function} A gulp task.
- */
-module.exports = (project, options) => {
-    const { watch } = Object.assign({ watch: false }, options);
-    const rootDir = project.rootDir;
-    const workingDir = rootDir.getChild('working');
-
-    const dirs = ['src', 'test'];
-    if (project.projectType === 'aws-microservice') {
-        dirs.push('infra');
-    }
-
-    const extras = [
-        project.configFileName,
-        'package.json',
-        '.npmignore',
-        '.npmrc',
-    ];
-
-    if (project.hasDocker) {
-        extras.push('Dockerfile*');
-    }
-
-    const staticFilePatterns = ['js', 'json'].concat(
-        project.staticFilePatterns
-    );
-
-    const paths = dirs
-        .map((dir) => rootDir.getChild(dir))
-        .map((dir) => staticFilePatterns.map((ext) => dir.getAllFilesGlob(ext)))
-        .reduce((result, arr) => result.concat(arr), [])
-        .concat(extras.map((item) => rootDir.getFileGlob(item)));
-
-    const task = () =>
-        _gulp
-            .src(paths, { allowEmpty: true, base: rootDir.globPath })
-            .pipe(_gulp.dest(workingDir.absolutePath));
-
-    task.displayName = 'build-js';
-    task.description = 'Copy javascript files from source to build directory';
-
-    if (watch) {
-        const watchTask = () => _gulp.watch(paths, task);
-        watchTask.displayName = 'watch-build-js';
-        watchTask.description =
-            'Automatically copy javascript files to build directory on change';
-
-        return watchTask;
-    }
-    return task;
-};

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

@@ -1,70 +0,0 @@
-'use strict';
-
-const _gulp = require('gulp');
-const _typescript = require('gulp-typescript');
-
-/**
- * Sub builder that creates a task that will transpile typescript files into
- * javascript files. This method will return a watcher if the watch option
- * is set to true.
- *
- * @private
- * @param {Object} project Reference to an object that contains project metadata
- *        that can be used to customize build outputs.
- * @param {Object} options An options object that can be used to customize the
- *        task.
- *
- * @returns {Function} A gulp task.
- */
-module.exports = (project, options) => {
-    const { watch } = Object.assign({ watch: false }, options);
-    const rootDir = project.rootDir;
-    const workingDir = rootDir.getChild('working');
-
-    const dirs = ['src', 'test'];
-    if (project.projectType === 'aws-microservice') {
-        dirs.push('infra');
-    }
-
-    const tsProject = _typescript.createProject('tsconfig.json');
-
-    const paths = dirs
-        .map((dir) => rootDir.getChild(dir))
-        .map((dir) => ['ts'].map((ext) => dir.getAllFilesGlob(ext)))
-        .reduce((result, arr) => result.concat(arr), []);
-
-    const distFiles = [
-        rootDir.getFileGlob('package-lock.json'),
-        rootDir.getFileGlob('Dockerfile*'),
-        rootDir.getFileGlob('LICENSE'),
-        rootDir.getFileGlob('README.md'),
-        rootDir.getFileGlob('.env'),
-        rootDir.getFileGlob(project.configFileName),
-    ];
-
-    const buildTask = () =>
-        _gulp
-            .src(paths, { base: rootDir.globPath })
-            .pipe(tsProject())
-            .pipe(_gulp.dest(workingDir.absolutePath));
-
-    const copyTask = () =>
-        _gulp
-            .src(distFiles, { allowEmpty: true })
-            .pipe(_gulp.dest(workingDir.absolutePath));
-
-    const task = _gulp.parallel([copyTask, buildTask]);
-
-    task.displayName = 'build-ts';
-    task.description = 'Build typescript source files to javascript files';
-
-    if (watch) {
-        const watchTask = () => _gulp.watch(paths, task);
-        watchTask.displayName = 'watch-build-ts';
-        watchTask.description =
-            'Automatically build typescript files on change';
-
-        return watchTask;
-    }
-    return task;
-};

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

@@ -1,47 +0,0 @@
-'use strict';
-
-const _gulp = require('gulp');
-
-/**
- * Sub builder that creates a task that will copy type declaration files that
- * have been marked for export from source to build directories. This method
- * will return a watcher if the watch option is set to true.
- *
- * @private
- * @param {Object} project Reference to an object that contains project metadata
- *        that can be used to customize build outputs.
- * @param {Object} options An options object that can be used to customize the
- *        task.
- *
- * @returns {Function} A gulp task.
- */
-module.exports = (project, options) => {
-    const { watch } = Object.assign({ watch: false }, options);
-    const rootDir = project.rootDir;
-    const workingDir = rootDir.getChild('working');
-
-    const paths = [project.exportedTypes]
-        .map((dir) => rootDir.getChild(dir))
-        .map((dir) => [undefined].map((ext) => dir.getAllFilesGlob(ext)))
-        .reduce((result, arr) => result.concat(arr), []);
-    console.log('building types');
-
-    const task = () =>
-        _gulp
-            .src(paths, { allowEmpty: true, base: rootDir.globPath })
-            .pipe(_gulp.dest(workingDir.absolutePath));
-
-    task.displayName = 'build-types';
-    task.description =
-        'Copy type declaration files from source to build directory';
-
-    if (watch) {
-        const watchTask = () => _gulp.watch(paths, task);
-        watchTask.displayName = 'watch-build-types';
-        watchTask.description =
-            'Automatically copy type declaration files to build directory on change';
-
-        return watchTask;
-    }
-    return task;
-};

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

@@ -1,67 +0,0 @@
-'use strict';
-
-const _gulp = require('gulp');
-const _typescript = require('gulp-typescript');
-const _execa = require('execa');
-
-/**
- * Sub builder that creates a task that will build UI project
- *  using vite. This method will return a watcher if the watch option
- * is set to true.
- *
- * @private
- * @param {Object} project Reference to an object that contains project metadata
- *        that can be used to customize build outputs.
- * @param {Object} options An options object that can be used to customize the
- *        task.
- *
- * @returns {Function} A gulp task.
- */
-module.exports = (project, options) => {
-    const { watch } = Object.assign({ watch: false }, options);
-    const rootDir = project.rootDir;
-    const workingDir = rootDir.getChild('working');
-
-    const viteBin = project.rootDir.getFilePath('node_modules/.bin/vite');
-
-    const dirs = ['src', 'test'];
-
-    const distFiles = [
-        rootDir.getFileGlob('_scripts/*'),
-        rootDir.getFileGlob('nginx.conf'),
-        rootDir.getFileGlob('package-lock.json'),
-        rootDir.getFileGlob('Dockerfile*'),
-        rootDir.getFileGlob('LICENSE'),
-        rootDir.getFileGlob('README.md'),
-        rootDir.getFileGlob('.env'),
-        rootDir.getFileGlob(project.configFileName),
-    ];
-    const copyTask = () =>
-        _gulp
-            .src(distFiles, { allowEmpty: true })
-            .pipe(_gulp.dest(workingDir.absolutePath));
-
-    const args = ['build'];
-    const buildTask = () => _execa(viteBin, args, { stdio: 'inherit' });
-    buildTask.displayName = 'build-ui';
-    buildTask.description = 'Build the UI project';
-
-    const task = _gulp.series([buildTask, copyTask]);
-
-    if (watch) {
-        const paths = dirs
-            .map((dir) => rootDir.getChild(dir))
-            .map((dir) => ['ts', 'tsx'].map((ext) => dir.getAllFilesGlob(ext)))
-            .reduce((result, arr) => result.concat(arr), []);
-
-        args.push('--watch');
-        const buildTask = () => _execa(viteBin, args, { stdio: 'inherit' });
-        const task = _gulp.series([buildTask, copyTask]);
-        const watchTask = () => _gulp.watch(paths, task);
-        watchTask.displayName = 'watch-build-ui';
-        watchTask.description = 'Automatically build the UI project on change';
-        return watchTask;
-    }
-
-    return task;
-};

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

@@ -1,60 +0,0 @@
-'use strict';
-
-const _gulp = require('gulp');
-
-/**
- * Builder function that can be used to generate a gulp task to build source
- * files. The task takes on different implementations based on project types.
- * For example, this task will compile typescript projects, copy AWS
- * microservice projects to the target directory, and has no effect on other
- * pure javascript projects.
- *
- * @param {Object} project Reference to an object that contains project metadata
- *        that can be used to customize build outputs.
- * @param {Object} options An options object that can be used to customize the
- *        task.
- *
- * @returns {Function} A gulp task.
- */
-module.exports = (project, options) => {
-    const { watch } = Object.assign({ watch: false }, options);
-
-    if (
-        !project.hasExportedTypes &&
-        !project.hasTypescript &&
-        project.projectType !== 'aws-microservice'
-    ) {
-        return;
-    }
-
-    let task;
-    let tasks;
-
-    if (project.projectType !== 'ui') {
-        const jsBuild = require('./build-js');
-        tasks = [jsBuild(project, options)];
-
-        if (project.hasTypescript) {
-            const tsBuild = require('./build-ts');
-            tasks.push(tsBuild(project, options));
-        } else if (project.hasExportedTypes) {
-            const typesBuild = require('./build-types');
-            tasks.push(typesBuild(project, options));
-        }
-    } else {
-        const tsBuild = require('./build-ui');
-        tasks = [tsBuild(project, options)];
-    }
-
-    task = _gulp.parallel(tasks);
-    if (!watch) {
-        task.displayName = 'build';
-        task.description = 'Transpile/copy source files into working directory';
-    } else {
-        task.displayName = 'watch-build';
-        task.description =
-            'Automatically transpile/copy source files on change';
-    }
-
-    return task;
-};

package/src/task-builders/clean.js

@@ -1,57 +0,0 @@
-'use strict';
-
-const _delete = require('delete');
-
-/**
- * Builder function that can be used to generate a gulp task to clean temporary
- * project files.
- *
- * @param {Object} project Reference to an object that contains project metadata
- *        that can be used to customize build outputs.
- * @param {Object} options An options object that can be used to customize the
- *        task.
- *
- * @returns {Function} A gulp task.
- */
-module.exports = (project, options) => {
-    const rootDir = project.rootDir;
-
-    const dirs = ['coverage', 'dist'];
-    const extras = [];
-
-    if (
-        project.hasExportedTypes ||
-        project.hasTypescript ||
-        project.projectType === 'aws-microservice'
-    ) {
-        dirs.push('working');
-    }
-
-    if (project.hasTypescript) {
-        dirs.push('.tscache');
-        extras.push({
-            name: 'typescript-temp',
-            path: rootDir.getFileGlob('tscommand-*.tmp.txt'),
-        });
-    }
-
-    if (project.projectType === 'aws-microservice') {
-        dirs.push('cdk.out');
-    }
-
-    if (project.hasServer) {
-        extras.push({
-            name: 'logs',
-            path: rootDir.getChild('logs').getAllFilesGlob('log'),
-        });
-    }
-
-    const paths = dirs.map((dir) => rootDir.getChild(dir).globPath);
-    const task = () => _delete(paths);
-
-    task.displayName = 'clean';
-    task.description =
-        'Cleans out working, distribution and temporary files and directories';
-
-    return task;
-};

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

@@ -1,41 +0,0 @@
-'use strict';
-
-const _gulp = require('gulp');
-const _gulpJsdoc = require('gulp-jsdoc3');
-
-/**
- * Sub builder that creates a task that will generate documentation from
- * javascript files.
- *
- * @private
- * @param {Object} project Reference to an object that contains project metadata
- *        that can be used to customize build outputs.
- * @param {Object} options An options object that can be used to customize the
- *        task.
- *
- * @returns {Function} A gulp task.
- */
-module.exports = (project, options) => {
-    const { rootDir, name, version } = project;
-
-    const docOptions = Object.assign(
-        {
-            opts: {
-                readme: rootDir.getFilePath('README.md'),
-                destination: rootDir.getFilePath(`docs/${name}/${version}`),
-                template: rootDir.getFilePath('node_modules/docdash'),
-            },
-        },
-        options
-    );
-
-    const paths = ['src']
-        .map((dir) => rootDir.getChild(dir))
-        .map((dir) => ['js'].map((ext) => dir.getAllFilesGlob(ext)))
-        .reduce((result, arr) => result.concat(arr), []);
-
-    const task = () =>
-        _gulp.src(paths, { allowEmpty: true }).pipe(_gulpJsdoc(docOptions));
-
-    return task;
-};

package/src/task-builders/docs/docs-ts.js

@@ -1,40 +0,0 @@
-'use strict';
-
-const _gulp = require('gulp');
-const _gulpTypedoc = require('gulp-typedoc');
-
-/**
- * Sub builder that creates a task that will generate documentation from
- * typescript files.
- *
- * @private
- * @param {Object} project Reference to an object that contains project metadata
- *        that can be used to customize build outputs.
- * @param {Object} options An options object that can be used to customize the
- *        task.
- *
- * @returns {Function} A gulp task.
- */
-module.exports = (project, options) => {
-    const { rootDir, name, version } = project;
-
-    const docOptions = Object.assign(
-        {
-            name: `${name} Documentation`,
-            disableOutputCheck: true,
-            readme: rootDir.getFilePath('README.md'),
-            out: rootDir.getFilePath(`docs/${name}/${version}`),
-        },
-        options
-    );
-
-    const paths = ['src']
-        .map((dir) => rootDir.getChild(dir))
-        .map((dir) => ['ts'].map((ext) => dir.getAllFilesGlob(ext)))
-        .reduce((result, arr) => result.concat(arr), []);
-
-    const task = () =>
-        _gulp.src(paths, { allowEmpty: true }).pipe(_gulpTypedoc(docOptions));
-
-    return task;
-};

package/src/task-builders/docs/index.js

@@ -1,32 +0,0 @@
-'use strict';
-
-const _gulp = require('gulp');
-
-/**
- * Builder function that can be used to generate a gulp task that generates
- * documentation from code docs. The task takes on different implementations
- * based on the programming language - javascript or typescript.
- *
- * @param {Object} project Reference to an object that contains project metadata
- *        that can be used to customize build outputs.
- * @param {Object} options An options object that can be used to customize the
- *        task.
- *
- * @returns {Function} A gulp task.
- */
-module.exports = (project, options) => {
-    let createTask = null;
-
-    if (project.hasTypescript) {
-        createTask = require('./docs-ts');
-    } else {
-        createTask = require('./docs-js');
-    }
-
-    const task = createTask(project, options);
-
-    task.displayName = 'docs';
-    task.description = 'Generates project documentation from code docs';
-
-    return task;
-};

package/src/task-builders/format.js

@@ -1,58 +0,0 @@
-'use strict';
-
-const _gulp = require('gulp');
-const _prettier = require('gulp-prettier');
-
-/**
- * Builder function that can be used to generate a gulp task to format source
- * files.
- *
- * @param {Object} project Reference to an object that contains project metadata
- *        that can be used to customize build outputs.
- * @param {Object} options An options object that can be used to customize the
- *        task.
- *
- * @returns {Function} A gulp task.
- */
-module.exports = (project, options) => {
-    const { watch } = Object.assign({ watch: false }, options);
-
-    const rootDir = project.rootDir;
-
-    const dirs = ['src', 'test', '.gulp'];
-    const extras = ['Gulpfile.js', 'README.md'];
-
-    if (project.projectType === 'aws-microservice') {
-        dirs.push('infra');
-    }
-
-    const paths = dirs
-        .map((dir) => rootDir.getChild(dir))
-        .map((dir) =>
-            ['ts', 'js', 'json', 'py', 'tsx', 'jsx'].map((ext) =>
-                dir.getAllFilesGlob(ext)
-            )
-        )
-        .reduce((result, arr) => result.concat(arr), [])
-        .concat(extras.map((file) => rootDir.getFileGlob(file)));
-
-    const task = () =>
-        _gulp
-            .src(paths, { allowEmpty: true, base: rootDir.globPath })
-            .pipe(_prettier())
-            .pipe(_gulp.dest(rootDir.absolutePath));
-
-    task.displayName = 'format';
-    task.description = 'Formats all source files, README.md and build scripts';
-
-    if (watch) {
-        const watch = () =>
-            _gulp.watch(paths, { usePolling: true, delay: 5000 }, task);
-
-        watch.displayName = 'watch-format';
-        watch.description = 'Automatically format files on change';
-
-        return watch;
-    }
-    return task;
-};

package/src/task-builders/lint.js

@@ -1,56 +0,0 @@
-'use strict';
-
-const _gulp = require('gulp');
-const _eslint = require('gulp-eslint');
-
-/**
- * Builder function that can be used to generate a gulp task to format source
- * files.
- *
- * @param {Object} project Reference to an object that contains project metadata
- *        that can be used to customize build outputs.
- * @param {Object} options An options object that can be used to customize the
- *        task.
- *
- * @returns {Function} A gulp task.
- */
-module.exports = (project, options) => {
-    const { watch } = Object.assign({ watch: false }, options);
-
-    const rootDir = project.rootDir;
-    const extensions = ['js'];
-    const dirs = ['src', 'test'];
-
-    if (project.hasTypescript) {
-        extensions.push('ts');
-    }
-
-    if (project.projectType === 'aws-microservice') {
-        dirs.push('infra');
-    }
-
-    const paths = dirs
-        .map((dir) => rootDir.getChild(dir))
-        .map((dir) => extensions.map((ext) => dir.getAllFilesGlob(ext)))
-        .reduce((result, arr) => result.concat(arr), []);
-
-    const task = () =>
-        _gulp
-            .src(paths, { allowEmpty: true })
-            .pipe(_eslint())
-            .pipe(_eslint.format())
-            .pipe(_eslint.failAfterError());
-
-    task.displayName = 'lint';
-    task.description = 'Lints source files';
-
-    if (watch) {
-        return task;
-    } else {
-        const watchTask = () => _gulp.watch(paths, task);
-        watchTask.displayName = 'watch-lint';
-        watchTask.description = 'Automatically lint files on change';
-
-        return watchTask;
-    }
-};