@vamship/build-utils 1.0.4 → 1.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vamship/build-utils",
-    "version": "1.0.4",
+    "version": "1.4.0",
     "description": "Utility library for build tooling",
     "main": "src/index.js",
     "scripts": {
@@ -41,26 +41,26 @@
     },
     "homepage": "https://github.com/vamship/build-utils#readme",
     "devDependencies": {
-        "chai": "^4.3.4",
+        "chai": "^4.3.6",
         "chai-as-promised": "^7.1.1",
-        "eslint": "^7.32.0",
-        "jsdoc": "^3.6.7",
-        "mocha": "^9.1.2",
-        "nodemon": "^2.0.13",
+        "eslint": "^8.10.0",
+        "jsdoc": "^3.6.10",
+        "mocha": "^9.2.2",
+        "nodemon": "^2.0.15",
         "nyc": "^15.1.0",
-        "prettier": "^2.4.1",
-        "rewire": "^5.0.0",
-        "sinon": "^11.1.2",
+        "prettier": "^2.5.1",
+        "rewire": "^6.0.0",
+        "sinon": "^13.0.1",
         "sinon-chai": "^3.7.0"
     },
     "dependencies": {
-        "camelcase": "^6.2.0",
+        "camelcase": "^6.3.0",
         "delete": "^1.1.0",
         "docdash": "^1.2.0",
-        "dotenv": "^10.0.0",
-        "dotenv-expand": "^5.1.0",
+        "dotenv": "^16.0.0",
+        "dotenv-expand": "^8.0.2",
         "execa": "^5.1.1",
-        "fancy-log": "^1.3.3",
+        "fancy-log": "^2.0.0",
         "mkdirp": "^1.0.4",
         "semver": "^7.3.5"
     },
@@ -82,8 +82,8 @@
     },
     "optionalDependencies": {
         "gulp-jsdoc3": "= 3.0.0",
-        "typedoc": ">= 0.22.5",
-        "typescript": ">= 4.4.4"
+        "typedoc": ">=0.22.13",
+        "typescript": ">=4.6.2"
     },
     "engines": {
         "node": ">= 14.18.1",

package/src/project.js

@@ -12,6 +12,7 @@ const SUPPORTED_PROJECT_TYPES = [
     'api',
     'aws-microservice',
     'container',
+    'ui',
 ];
 const SUPPORTED_LANGUAGES = ['js', 'ts'];
 
@@ -121,6 +122,7 @@ module.exports = class Project {
             requiredEnv,
             exportedTypes,
             aws,
+            staticFilePatterns,
         } = buildMetadata;
 
         if (SUPPORTED_PROJECT_TYPES.indexOf(projectType) < 0) {
@@ -143,6 +145,8 @@ module.exports = class Project {
         this._projectType = projectType;
         this._language = language;
         this._exportedTypes = exportedTypes;
+        this._staticFilePatterns =
+            staticFilePatterns instanceof Array ? staticFilePatterns : [];
 
         this._hasTypescript = this._language === 'ts';
         this._hasServer = this._projectType === 'api';
@@ -438,6 +442,16 @@ module.exports = class Project {
         return this._exportedTypes;
     }
 
+    /**
+     * Additional files to copy from the source directory to the build
+     * directory.
+     *
+     * @return {String}
+     */
+    get staticFilePatterns() {
+        return this._staticFilePatterns;
+    }
+
     /**
      * Determines whether or not the project can be packaged up as a docker
      * image.

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

@@ -36,9 +36,13 @@ module.exports = (project, options) => {
         extras.push('Dockerfile*');
     }
 
+    const staticFilePatterns = ['js', 'json'].concat(
+        project.staticFilePatterns
+    );
+
     const paths = dirs
         .map((dir) => rootDir.getChild(dir))
-        .map((dir) => ['js', 'json'].map((ext) => dir.getAllFilesGlob(ext)))
+        .map((dir) => staticFilePatterns.map((ext) => dir.getAllFilesGlob(ext)))
         .reduce((result, arr) => result.concat(arr), [])
         .concat(extras.map((item) => rootDir.getFileGlob(item)));
 

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

@@ -0,0 +1,67 @@
+'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

@@ -27,18 +27,26 @@ module.exports = (project, options) => {
         return;
     }
 
-    const jsBuild = require('./build-js');
-    const 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));
+    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)];
     }
 
-    const task = _gulp.parallel(tasks);
+    task = _gulp.parallel(tasks);
     if (!watch) {
         task.displayName = 'build';
         task.description = 'Transpile/copy source files into working directory';

package/src/task-builders/format.js

@@ -29,7 +29,9 @@ module.exports = (project, options) => {
     const paths = dirs
         .map((dir) => rootDir.getChild(dir))
         .map((dir) =>
-            ['ts', 'js', 'json', 'py'].map((ext) => dir.getAllFilesGlob(ext))
+            ['ts', 'js', 'json', 'py', 'tsx', 'jsx'].map((ext) =>
+                dir.getAllFilesGlob(ext)
+            )
         )
         .reduce((result, arr) => result.concat(arr), [])
         .concat(extras.map((file) => rootDir.getFileGlob(file)));

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

@@ -0,0 +1,39 @@
+'use strict';
+
+const _gulp = require('gulp');
+
+/**
+ * Builder function that can be used to generate a gulp task to execute
+ * instrumented unit/api tests.
+ *
+ * @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 { testType, watch } = Object.assign(
+        { testType: 'unit', watch: false },
+        options
+    );
+    const tasks = [];
+    if (project.projectType !== 'ui') {
+        const nonUiTests = require('./test');
+        tasks.push(nonUiTests(project, options));
+    } else {
+        const uiTests = require('./test-ui');
+        tasks.push(uiTests(project, options));
+    }
+    const task = _gulp.parallel(tasks);
+    if (!watch) {
+        task.displayName = `test-${testType}`;
+        task.description = `Execute ${testType} tests`;
+    } else {
+        task.displayName = `watch-test-${testType}`;
+        task.description = `Automatically execute ${testType} tests on change`;
+    }
+
+    return task;
+};

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

@@ -0,0 +1,39 @@
+'use strict';
+
+const _gulp = require('gulp');
+const _execa = require('execa');
+
+/**
+ * Builder function that can be used to generate a gulp task to execute
+ * instrumented unit/api tests.
+ *
+ * @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 { testType, watch } = Object.assign(
+        { testType: 'unit', watch: false },
+        options
+    );
+
+    const rootDir = project.jsRootDir;
+    const jestBin = project.rootDir.getFilePath('node_modules/.bin/jest');
+    let args = ['--config', 'jest.config.js', '--coverage'];
+
+    if (watch) {
+        args.push('--watchAll');
+        const watchTask = () => _execa(jestBin, args, { stdio: 'inherit' });
+        watchTask.displayName = `watch-test-${testType}`;
+        watchTask.description = `Automatically execute ${testType} tests on change`;
+        return watchTask;
+    }
+
+    const task = () => _execa(jestBin, args, { stdio: 'inherit' });
+    task.displayName = `test-${testType}`;
+    task.description = `Execute ${testType} tests`;
+    return task;
+};