create-gasket-app 7.0.0-next.2 → 7.0.0-next.21

package/lib/scaffold/config-builder.js

@@ -1,7 +1,8 @@
 /* eslint-disable complexity, max-statements */
-const deepmerge = require('deepmerge');
-const semver = require('semver');
-const debug = require('diagnostics')('gasket:create-gasket-app:package');
+import deepmerge from 'deepmerge';
+import { default as semver } from 'semver';
+import { default as diagnostics } from 'diagnostics';
+const debug = diagnostics('gasket:cli:package');
 
 /**
  * Simple object check without bringing in a large
@@ -56,7 +57,7 @@ function isValidVersion(v) {
  *
  * @type {ConfigBuilder}
  */
-class ConfigBuilder {
+export class ConfigBuilder {
   /**
    * ConfigBuilder
    *
@@ -179,7 +180,6 @@ class ConfigBuilder {
    */
   add(key, value, source, options = {}) {
     if (typeof value === 'undefined') return;
-
     const existing = this.fields[key];
     const { name = 'Unknown plugin' } = (source || this.source || {});
 
@@ -226,6 +226,83 @@ class ConfigBuilder {
     }
   }
 
+  /**
+   * addPlugin - Add plugin import to the gasket file and use the value in the plugins array
+   * @param {string} pluginImport - name of the import used as a value - `import pluginImport...`
+   * @param {string} pluginName - name of the plugin import/package - `from 'pluginName'`
+   * @example
+   * addPlugin('pluginA', '@gasket/plugin-a')
+   *
+   * // gasket.js
+   * import pluginA from '@gasket/plugin-a';
+   *
+   * export default makeGasket({
+   *  plugins: [
+   *    pluginA
+   *  ]
+   * });
+   */
+  addPlugin(pluginImport, pluginName) {
+    this.add('plugins', [`${pluginImport}`]);
+    this.add('pluginImports', { [pluginImport]: pluginName });
+  }
+
+  /**
+   * addImport - Add a non-plugin import to the gasket file
+   * @param {string} importName - name of the import used as a value - `import fs...`
+   * @param {string} importPath - path of the import - `from 'fs'`
+   * @returns {ConfigBuilder} - instance for chaining
+   * @example
+   * Can be default or named import
+   * addImport('{ readFileSync }', 'fs')
+   * addImport('fs', 'fs')
+   *
+   * // gasket.js
+   * import { readFileSync } from 'fs';
+   * import fs from 'fs';
+   */
+  addImport(importName, importPath) {
+    this.add('imports', { [importName]: importPath });
+    return this;
+  }
+
+  /**
+   * addExpression - add programmatic expression to the gasket file
+   * @param {string} expression - expression to add after imports
+   * @returns {ConfigBuilder} - instance for chaining
+   * @example
+   *
+   * .addImport('fs', 'fs')
+   * .addExpression('const file = fs.readFileSync(\'./file.txt\')')
+   *
+   * // gasket.js
+   * import fs from 'fs';
+   * const file = fs.readFileSync('./file.txt');
+   */
+  addExpression(expression) {
+    this.add('expressions', [expression.trim()]);
+    return this;
+  }
+
+  /**
+   * injectValue - Inject a value into the gasket config object
+   * @param {string} configKey - collapsed object path to inject value into - `express.config.routes`
+   * @param {string} injectedValue - string used as a value
+   * @example
+   * .addImport('{ routes }', './routes')
+   * .injectValue('express.routes', 'routes');
+   *
+   * // gasket.js
+   * export default makeGasket({
+   *  express: {
+   *    routes: routes
+   *  }
+   * });
+   */
+  injectValue(configKey, injectedValue) {
+    this.add('injectionAssignments', { [configKey]: injectedValue });
+  }
+
   /**
    * Checks if a dependency has been already added
    * @param  {String} key Dependency bucket
@@ -444,5 +521,3 @@ class ConfigBuilder {
     }, {});
   }
 }
-
-module.exports = ConfigBuilder;

package/lib/scaffold/create-context.js

@@ -1,7 +1,7 @@
 /* eslint-disable max-len, max-statements */
-const fs = require('fs');
-const path = require('path');
-const { addPluginsToContext, readConfig } = require('../scaffold/utils');
+import fs from 'fs';
+import path from 'path';
+import { readConfig } from '../scaffold/utils.js';
 
 /**
  * The CreateRuntime represents a shallow proxy to a CreateContext
@@ -70,14 +70,14 @@ function flatten(acc, values) {
  * @property {Boolean} extant - Whether or not target directory already exists
  * @property {[String]} localPresets - paths to the local presets packages
  * @property {PresetDesc[]} rawPresets - Raw preset desc from args. Can include version constraint. Added by load-preset if using localPresets.
- * @property {PluginDesc[]} rawPlugins - Raw plugin desc from options, prompts, etc. Can include constraints.
- * @property {PluginName[]} plugins - Short names of plugins
  * @property {String[]} pkgLinks - Local packages that should be linked
  * @property {String[]} messages - non-error/warning messages to report
  * @property {String[]} warnings - warnings messages to report
  * @property {String[]} errors - error messages to report but do not exit process
  * @property {String[]} nextSteps - any next steps to report for user
  * @property {Set<String>} generatedFiles - any generated files to show in report
+ * @property {any[]} presets - Default empty array, populated by load-preset with actual imports
+ * @property {Object} presetConfig - Default to object w/empty plugins array to be populated by `presetConfig` hook
  *
  * -- Added by `global-prompts`
  *
@@ -92,12 +92,7 @@ function flatten(acc, values) {
  * -- Added by `load-preset`
  *
  * @property {PresetName[]} presets - Short name of presets
- * @property {PresetInfo[]} presetInfos - Shallow load of presets with meta data
  *
- * -- Added by `cli-version`
- *
- * @property {string} cliVersion - Version of current CLI used to issue `create` command
- * @property {string} cliVersionRequired - Version of CLI to install, either current or min compatible version required by preset(s)
  *
  * -- Added by `setup-pkg`
  *
@@ -112,7 +107,7 @@ function flatten(acc, values) {
  *
  * @property {Files} files - Use to add files and templates to generate
  */
-class CreateContext {
+export class CreateContext {
   constructor(initContext = {}) {
     Object.assign(this, initContext);
   }
@@ -129,24 +124,22 @@ class CreateContext {
  * @param {Object} options - Command options
  * @returns {CreateContext} context
  */
-module.exports = function makeCreateContext(argv = [], options = {}) {
+export function makeCreateContext(argv = [], options = {}) {
   const appName = argv[0] || 'templated-app';
   const {
-    plugins = [],
     presets = [],
     npmLink = [],
     presetPath = [],
     packageManager,
     prompts,
     config,
-    'config-file': configFile
+    configFile
   } = options;
 
-  // Flatten the array of array created by the plugins flag – it
+  // Flatten the array of array created by the plugins flag – it
   // supports both multiple instances as well as comma-separated lists.
   const rawPresets = presets.reduce(flatten, []);
   const localPresets = presetPath.reduce(flatten, []);
-  const rawPlugins = plugins.reduce(flatten, []);
   const pkgLinks = npmLink.reduce(flatten, []);
   const cwd = process.cwd();
   const dest = path.join(cwd, appName);
@@ -173,7 +166,11 @@ module.exports = function makeCreateContext(argv = [], options = {}) {
     errors: [],
     nextSteps: [],
     generatedFiles: new Set(),
-    prompts
+    prompts,
+    presets: [],
+    presetConfig: {
+      plugins: []
+    }
   });
 
   readConfig(context, { config, configFile });
@@ -185,9 +182,6 @@ module.exports = function makeCreateContext(argv = [], options = {}) {
     context.appName = appName;
   }
 
-  addPluginsToContext(rawPlugins, context);
-
   return context;
-};
+}
 
-module.exports.CreateContext = CreateContext;

package/lib/scaffold/dump-error-context.js

@@ -1,5 +1,5 @@
-const path = require('path');
-const fs = require('fs').promises;
+import path from 'path';
+import { writeFile } from 'fs/promises';
 
 /**
  * If an error occurs during create, dump the context for debugging.
@@ -9,7 +9,7 @@ const fs = require('fs').promises;
  * @param {Error} error - Exiting error
  * @returns {Promise<void>} promise
  */
-module.exports = async function dumpErrorContext(context, error) {
+export async function dumpErrorContext(context, error) {
   const { cwd } = context;
 
   try {
@@ -17,7 +17,7 @@ module.exports = async function dumpErrorContext(context, error) {
     const fileName = 'gasket-create-error.log';
 
     const filePath = path.join(cwd, fileName);
-    await fs.writeFile(filePath, JSON.stringify(report, null, 2), 'utf8');
+    await writeFile(filePath, JSON.stringify(report, null, 2), 'utf8');
     console.log(`Error log dumped to: ${filePath}`);
   } catch (err) {
     //
@@ -25,4 +25,4 @@ module.exports = async function dumpErrorContext(context, error) {
     //
     console.error(`Error writing error log: ${err}`);
   }
-};
+}

package/lib/scaffold/files.js

@@ -3,7 +3,7 @@
  *
  * @type {Files}
  */
-module.exports = class Files {
+export class Files {
   constructor() {
     this.globSets = [];
   }
@@ -27,4 +27,4 @@ module.exports = class Files {
   add({ globs, source }) {
     this.globSets.push({ globs, source });
   }
-};
+}

package/lib/scaffold/utils.js

@@ -1,91 +1,6 @@
-const path = require('path');
-const untildify = require('untildify');
-const { pluginIdentifier } = require('@gasket/resolve');
-
-/**
- * Pushes plugins short names for use in gasket.config.js
- * Pushes the original plugin identifiers under rawPlugins
- *
- * @param {PluginDesc[]} plugins - Plugins names
- * @param {CreateContext} context - Create context
- */
-function addPluginsToContext(plugins, context) {
-  context.rawPlugins = context.rawPlugins || [];
-  context.plugins = context.plugins || [];
-
-  context.rawPlugins = plugins.reduce((acc, cur) => {
-    const next = pluginIdentifier(cur);
-
-    // get the index of existing plugins by comparing short names
-    const idx = acc.map(p => pluginIdentifier(p).shortName).indexOf(next.shortName);
-
-    if (idx > -1) {
-      // if the existing plugin does not specify a version, use the next one
-      if (!pluginIdentifier(acc[idx]).version) {
-        acc[idx] = cur;
-      }
-    } else {
-      // if we don't already have an entry, push the next one
-      acc.push(cur);
-    }
-
-    return acc;
-  }, context.rawPlugins);
-
-  context.plugins = plugins.reduce((acc, cur) => {
-    const next = pluginIdentifier(cur).shortName;
-    if (!acc.includes(next)) acc.push(next);
-    return acc;
-  }, context.plugins);
-}
-
-/**
- * Adds plugins and dependencies of the app package
- *
- * @param {PluginDesc[]|pluginIdentifier[]} plugins - Plugins names
- * @param {PackageJson} pkg - Package builder
- * @param {String} [field] - Dependency type (Default: dependencies)
- */
-function addPluginsToPkg(plugins, pkg, field = 'dependencies') {
-  const pluginIds = plugins.map(p => pluginIdentifier(p).withVersion());
-  pkg.add(field, pluginIds.reduce((acc, p) => {
-    if (!acc[p.fullName]) {
-      acc[p.fullName] = p.version;
-    }
-    return acc;
-  }, {}));
-}
-
-/**
- * Look up registry version of provided plugin descriptions w/o versions set.
- *
- * @param {PluginDesc[]|pluginIdentifier[]} plugins - Plugins names
- * @param {PackageManager} pkgManager - Package manager instance
- * @returns {Promise<pluginIdentifier[]>} plugins
- */
-async function getPluginsWithVersions(plugins, pkgManager) {
-  return await Promise.all(
-    plugins.map(async name => {
-      const id = pluginIdentifier(name);
-      if (id.version != null) return id;
-      const version = (await pkgManager.info([id.fullName, 'version'])).data;
-      return id.withVersion(`^${version}`);
-    })
-  );
-}
-
-/**
- * Takes a file path and transforms it to be absolute if not already
- *
- * @param {string} filepath - Path to file that may be relative or have tildy
- * @returns {string} absolute filepath
- */
-function ensureAbsolute(filepath) {
-  filepath = untildify(filepath);
-  if (path.isAbsolute(filepath)) return filepath;
-  return path.resolve(process.cwd(), filepath);
-}
-
+import path from 'path';
+import { createRequire } from 'module';
+const require = createRequire(import.meta.url);
 
 /**
  * Parses JSON file or string to assign to context
@@ -95,7 +10,7 @@ function ensureAbsolute(filepath) {
  * @param {string} configFlags.config - JSON string of config values
  * @param {string} configFlags.configFile - path to JSON file of config values
  */
-function readConfig(context, { config, configFile }) {
+export function readConfig(context, { config, configFile }) {
   if (config) {
     const parsedConfig = JSON.parse(config);
     Object.assign(context, parsedConfig);
@@ -105,11 +20,3 @@ function readConfig(context, { config, configFile }) {
   }
 }
 
-
-module.exports = {
-  addPluginsToContext,
-  addPluginsToPkg,
-  getPluginsWithVersions,
-  ensureAbsolute,
-  readConfig
-};

package/lib/utils/create-option.js

@@ -1,11 +1,11 @@
-const { Option } = require('commander');
+import { Option } from 'commander';
 
 /**
  * createOption - Create a commander option
  * @param {CLICommandOption} definition - The option configuration
  * @returns {CommnaderOption} option
  */
-function createOption(definition) {
+export function createOption(definition) {
   const option = new Option(...definition.options);
   const { defaultValue, conflicts, parse, hidden, required } = definition;
 
@@ -16,5 +16,3 @@ function createOption(definition) {
   if (required) option.makeOptionMandatory();
   return option;
 }
-
-module.exports = createOption;

package/lib/utils/index.js

@@ -1,16 +1,6 @@
-const processCommand = require('./process-command');
-const processArgs = require('./process-args');
-const processOptions = require('./process-options');
-const createOption = require('./create-option');
-const logo = require('./logo');
-const warnIfOutdated = require('./warn-if-outdated');
-
-
-module.exports = {
-  processCommand,
-  processArgs,
-  processOptions,
-  createOption,
-  logo,
-  warnIfOutdated
-};
+export { processCommand } from './process-command.js';
+export { processArgs } from './process-args.js';
+export { processOptions } from './process-options.js';
+export { createOption } from './create-option.js';
+export { logo } from './logo.js';
+export { warnIfOutdated } from './warn-if-outdated.js';

package/lib/utils/logo.js

@@ -1,4 +1,4 @@
-const logo = `
+export const logo = `
           ▄▄▄▄████▀▀█▄
       ▄███▀▀▀▀▀▀▀█▄▄██
     ▄██▀   ▄▄▄▄▄   ▀██▌                  ▄▄▄
@@ -10,5 +10,3 @@ const logo = `
       ▀███▄▄▄▄▄▄▄█▀▀██
           ▀▀▀▀████▄▄█▀
 `;
-
-module.exports = logo;

package/lib/utils/process-args.js

@@ -16,7 +16,7 @@ function isValidArg(arg) {
  * @param {CLICommandArg[]} args Array of argument configurations
  * @returns {ProccesedCLICommandArg[]} Array of argument definitions
  */
-function processArgs(args) {
+export function processArgs(args) {
   if (!Array.isArray(args) || !args.every(isValidArg)) throw new Error('Invalid argument(s) configuration');
 
   return args.reduce((acc, arg) => {
@@ -35,5 +35,3 @@ function processArgs(args) {
 
   }, []);
 }
-
-module.exports = processArgs;

package/lib/utils/process-command.js

@@ -1,8 +1,6 @@
-const { Command } = require('commander');
+import { Command } from 'commander';
+import { processArgs, processOptions, createOption } from './index.js';
 const program = new Command();
-const processArgs = require('./process-args');
-const processOptions = require('./process-options');
-const createOption = require('./create-option');
 
 /**
  * isValidCommand - Validates the command configuration
@@ -25,7 +23,7 @@ function isValidCommand(command) {
  * @param {CLICommand} command The command configuration
  * @returns {ProccesedCLICommand} The command instance
  */
-function processCommand(command) {
+export function processCommand(command) {
   if (!isValidCommand(command)) throw new Error('Invalid command configuration');
   const { id, description, action, args, options, hidden = false, default: isDefault = false } = command;
   const cmd = program
@@ -48,5 +46,3 @@ function processCommand(command) {
 
   return { command: cmd, hidden, isDefault };
 }
-
-module.exports = processCommand;

package/lib/utils/process-options.js

@@ -16,7 +16,7 @@ function isValidOption(option) {
  * @param {CLICommandOption[]} options Array of option configurations
  * @returns {ProccesedCLICommandOption[]} Processed option definitions
  */
-function processOptions(options) {
+export function processOptions(options) {
   if (!Array.isArray(options) || !options.every(isValidOption)) throw new Error('Invalid option(s) configuration');
 
   return options.reduce((acc, option) => {
@@ -42,5 +42,3 @@ function processOptions(options) {
     return acc;
   }, []);
 }
-
-module.exports = processOptions;

package/lib/utils/warn-if-outdated.js

@@ -1,10 +1,12 @@
-const { runShellCommand } = require('@gasket/utils');
-const semver = require('semver');
-const chalk = require('chalk');
-const { readFile, writeFile } = require('fs/promises');
-const path = require('path');
+import { default as gasketUtils } from '@gasket/utils';
+import semver from 'semver';
+import chalk from 'chalk';
+import { readFile, writeFile } from 'fs/promises';
+import path from 'path';
+import { fileURLToPath } from 'url';
+const __dirname = fileURLToPath(import.meta.url);
 
-const cachePath = path.join(__dirname, '..', '..', '.cache'); // Place at root of gasket-cli
+const cachePath = path.join(__dirname, '..', '..', '..', '.cache'); // Place at root of gasket-cli
 const LATEST_VERSION = 'latestVersion';
 const LATEST_VERSION_UPDATE_TIME = 'latestVersionUpdateTime';
 
@@ -34,7 +36,7 @@ async function getLatestVersion(pkgName, currentTime, cache) {
     isOlderThanSevenDays(currentTime, cache[LATEST_VERSION_UPDATE_TIME])
   ) {
     try {
-      const cmdResult = await runShellCommand('npm', ['view', pkgName, 'version'], {});
+      const cmdResult = await gasketUtils.runShellCommand('npm', ['view', pkgName, 'version'], {});
       if (cmdResult?.stdout) {
         const latestVersion = cmdResult.stdout.trim();
         cache[LATEST_VERSION_UPDATE_TIME] = currentTime;
@@ -55,7 +57,7 @@ async function getLatestVersion(pkgName, currentTime, cache) {
  * @param {string} pkgName - package name
  * @param {string} currentVersion - current version of the package
  */
-module.exports = async function warnIfOutdated(pkgName, currentVersion) {
+export async function warnIfOutdated(pkgName, currentVersion) {
   const currentTime = new Date().getTime();
   let cache = {};
 
@@ -73,4 +75,4 @@ module.exports = async function warnIfOutdated(pkgName, currentVersion) {
       ` ${chalk.yellow('›')}   Warning: ${pkgName} update available from ${chalk.green(latestVersion)} to ${chalk.green(currentVersion)}`
     );
   }
-};
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-gasket-app",
-  "version": "7.0.0-next.2",
+  "version": "7.0.0-next.21",
   "description": "starter pack for creating a gasket app",
   "main": "lib",
   "bin": {
@@ -9,11 +9,12 @@
   "files": [
     "lib"
   ],
+  "type": "module",
   "scripts": {
     "lint": "eslint .",
     "lint:fix": "npm run lint -- --fix",
-    "test": "cross-env NODE_OPTIONS='--unhandled-rejections=strict' jest",
-    "test:watch": "jest --watch",
+    "test": "cross-env NODE_OPTIONS='--unhandled-rejections=strict --experimental-vm-modules' jest",
+    "test:watch": "npm run test -- --watch",
     "test:coverage": "jest --coverage",
     "posttest": "npm run lint"
   },
@@ -31,16 +32,14 @@
   },
   "homepage": "https://github.com/godaddy/gasket/tree/main/packages/create-gasket-app",
   "dependencies": {
-    "@gasket/engine": "^7.0.0-next.2",
-    "@gasket/plugin-git": "^7.0.0-next.2",
-    "@gasket/plugin-lifecycle": "^7.0.0-next.2",
-    "@gasket/plugin-logger": "^7.0.0-next.2",
-    "@gasket/plugin-metadata": "^7.0.0-next.2",
-    "@gasket/plugin-start": "^7.0.0-next.2",
-    "@gasket/resolve": "^7.0.0-next.2",
-    "@gasket/utils": "^7.0.0-next.2",
+    "@gasket/core": "^7.0.0-next.21",
+    "@gasket/engine": "^7.0.0-next.21",
+    "@gasket/plugin-git": "^7.0.0-next.21",
+    "@gasket/plugin-logger": "^7.0.0-next.21",
+    "@gasket/utils": "^7.0.0-next.21",
     "commander": "^12.0.0",
     "deepmerge": "^4.3.1",
+    "glob": "^8.1.0",
     "handlebars": "^4.7.8",
     "inquirer": "6.5.2",
     "json5": "^2.2.3",
@@ -77,5 +76,8 @@
   "eslintIgnore": [
     "test/fixtures"
   ],
-  "gitHead": "ae1c37abe63a7deea1431e37e57f2b14daa31bf5"
+  "jest": {
+    "transform": {}
+  },
+  "gitHead": "52718d035b5a33c04de7043587f89596dd6da6f4"
 }

package/lib/scaffold/actions/apply-preset-config.js

@@ -1,29 +0,0 @@
-const { flattenPresets } = require('@gasket/resolve');
-const action = require('../action-wrapper');
-
-/**
- * Extracts predefined createContext from presets and applies to context.
- * This allows presets to preemptively define fill in the create context.
- * This will prevent prompts from appearing for the associated prompts.
- *
- * For example, `presetContext` contains `appDescription`, the prompt for the
- * newly created app's description will not appear.
- *
- * We take whatever is in the context at a higher priority, because any
- * config that is the context at this point must come from CLI flags,
- * as none of the global prompts have run yet. Parent presets take priority
- * over extended presets.
- *
- * @param {CreateContext} context - Create context
- */
-function applyPresetConfig(context) {
-  const { presetInfos = [] } = context;
-
-  const presetContext = flattenPresets(presetInfos).reduce((acc, presetInfo) => {
-    return { ...(presetInfo.module && presetInfo.module.createContext || {}), ...acc };
-  }, context);
-
-  Object.assign(context, presetContext);
-}
-
-module.exports = action('Apply preset context', applyPresetConfig, { startSpinner: false });