create-gasket-app 7.0.0-next.20 → 7.0.0-next.23

package/lib/commands/create.js

@@ -107,17 +107,17 @@ createCommand.action = async function run(appname, options, command) {
   const { rawPresets, localPresets } = context;
 
   try {
-    await globalPrompts(null, context);
+    await globalPrompts({ context });
 
     if (rawPresets.length || localPresets.length) {
-      await loadPreset(null, context);
+      await loadPreset({ context });
 
       const presetGasket = makeGasket({
         plugins: context.presets
       });
 
-      await presetPromptHooks(presetGasket, context);
-      await presetConfigHooks(presetGasket, context);
+      await presetPromptHooks({ gasket: presetGasket, context });
+      await presetConfigHooks({ gasket: presetGasket, context });
     }
 
     const pluginGasket = makeGasket({
@@ -125,18 +125,18 @@ createCommand.action = async function run(appname, options, command) {
       plugins: context.presets.concat(context.presetConfig.plugins, defaultPlugins)
     });
 
-    await promptHooks(pluginGasket, context);
-    await mkDir(null, context);
-    await setupPkg(null, context);
-    await createHooks(pluginGasket, context);
-    await writePkg(null, context);
-    await generateFiles(null, context);
-    await writeGasketConfig(null, context);
-    await installModules(null, context);
-    await linkModules(null, context);
-    await postCreateHooks(pluginGasket, context);
+    await promptHooks({ gasket: pluginGasket, context });
+    await mkDir({ context });
+    await setupPkg({ context });
+    await createHooks({ gasket: pluginGasket, context });
+    await writePkg({ context });
+    await generateFiles({ context });
+    await writeGasketConfig({ context });
+    await installModules({ context });
+    await linkModules({ context });
+    await postCreateHooks({ gasket: pluginGasket, context });
     if (context.tmpDir) await rm(context.tmpDir, { recursive: true });
-    printReport(null, context);
+    printReport({ context });
   } catch (err) {
     console.error(chalk.red('Exiting with errors.'));
     dumpErrorContext(context, err);

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-import type { GasketConfigDefinition, MaybeAsync } from '@gasket/engine';
+import type { GasketConfigDefinition, MaybeAsync, Plugin, GasketEngine } from '@gasket/core';
 import type { PackageManager } from '@gasket/utils';
 
 export interface Dependencies {
@@ -95,7 +95,7 @@ export interface ConfigBuilder<Config> {
    * import { readFileSync } from 'fs';
    * import fs from 'fs';
    */
-  addImport(importName: string, importPath: string): ConfigBuilder;
+  addImport(importName: string, importPath: string): ConfigBuilder<Config>;
 
   /**
    * addExpression - add programmatic expression to the gasket file
@@ -110,7 +110,7 @@ export interface ConfigBuilder<Config> {
    * import fs from 'fs';
    * const file = fs.readFileSync('./file.txt');
    */
-  addExpression(expression: string): ConfigBuilder;
+  addExpression(expression: string): ConfigBuilder<Config>;
 
   /**
    * injectValue - Inject a value into the gasket config object
@@ -127,7 +127,7 @@ export interface ConfigBuilder<Config> {
    *  }
    * });
    */
-  injectValue(configKey: string, injectedValue: any): void;
+  injectValue(configKey: string, injectedValue: string): void;
 }
 
 export interface PackageJsonBuilder extends ConfigBuilder<PackageJson> {
@@ -186,7 +186,7 @@ export interface CreateContext {
   generatedFiles: Set<string>;
 
   /** Default empty array, populated by load-preset with actual imports */
-  presets: Array<any>;
+  presets: Array<Plugin>;
 
   /** Default to object w/empty plugins array to be populated by `presetConfig` hook */
   presetConfig: GasketConfigDefinition;
@@ -233,10 +233,16 @@ export interface CreateContext {
   files: Files;
 }
 
-declare module '@gasket/engine' {
+export interface ActionWrapperParams {
+  gasket: GasketEngine;
+  context: CreateContext;
+  spinner?: any;
+}
+
+declare module '@gasket/core' {
   export interface HookExecTypes {
     presetPrompt(context: CreateContext): Promise<void>;
-    presetConfig(context: CreateContext): Promise<void>;
+    presetConfig(context: CreateContext): Promise<CreateContext['presetConfig']>;
     prompt(
       context: CreateContext,
       utils: {

package/lib/index.js

@@ -2,7 +2,8 @@
 import { Command } from 'commander';
 import { createRequire } from 'module';
 import { createCommand } from './commands/create.js';
-import { processCommand, logo, warnIfOutdated } from './utils/index.js';
+import { processCommand, logo } from './utils/index.js';
+import { warnIfOutdated } from '@gasket/utils';
 
 const require = createRequire(import.meta.url);
 const pkg = require('../package.json');

package/lib/scaffold/action-wrapper.js

@@ -14,14 +14,16 @@ export default function withSpinner(label, fn, { startSpinner = true } = {}) {
   /**
    * Decorated function
    *
-   * @param {CreateContext} context - Create context
+   * @param {ActionWrapperParams} params - ActionWrapperParams
+   * @param {GasketEngine} params.gasket - Gasket config
+   * @param {CreateContext} params.context - Create context
    * @returns {Promise} promise
    */
-  async function wrapper(gasket = {}, context) {
+  async function wrapper({ gasket = {}, context }) {
     const spinner = ora(label);
     if (startSpinner) spinner.start();
     try {
-      await fn(gasket, context, spinner);
+      await fn({ gasket, context, spinner });
       if (spinner.isSpinning) spinner.succeed();
     } catch (err) {
       spinner.fail();

package/lib/scaffold/actions/create-hooks.js

@@ -6,10 +6,11 @@ import { Files } from '../files.js';
  * Executes the `create` hook for all registered plugins.
  * Adds `files` to context for plugins to add their files and templates.
  *
+ * @param {GasketEngine} gasket - Gasket API
  * @param {CreateContext} context - Create context
  * @returns {Promise} promise
  */
-async function createHooks(gasket, context) {
+async function createHooks({ gasket, context }) {
   const { plugins = [], warnings } = context;
 
   const files = new Files();

package/lib/scaffold/actions/generate-files.js

@@ -164,7 +164,7 @@ async function performGenerate(context, descriptors) {
  * @param {Spinner} spinner - Spinner
  * @returns {Promise} promise
  */
-async function generateFiles(_, context, spinner) {
+async function generateFiles({ context, spinner }) {
   const { files } = context;
 
   if (!files.globSets.length) {

package/lib/scaffold/actions/global-prompts.js

@@ -73,7 +73,7 @@ async function chooseTestPlugin(context, prompt) {
   if (!('testPlugin' in context)) {
     let testPlugin;
 
-    if ('testSuite' in  context) {
+    if ('testSuite' in context) {
       testPlugin = knownTestPlugins[context.testSuite];
     }
 
@@ -136,7 +136,7 @@ export const questions = [
  * @param {CreateContext} context - Create context
  * @returns {Promise} promise
  */
-async function globalPrompts(_, context) {
+async function globalPrompts({ context }) {
   const prompt = context.prompts ? inquirer.prompt : () => ({});
   for (var fn of questions) {
     await fn(context, prompt);

package/lib/scaffold/actions/install-modules.js

@@ -6,7 +6,7 @@ import action from '../action-wrapper.js';
  * @param {CreateContext} context - Create context
  * @returns {Promise} promise
  */
-async function installModules(_, context) {
+async function installModules({ context }) {
   const { pkgManager } = context;
 
   await pkgManager.install();

package/lib/scaffold/actions/link-modules.js

@@ -7,7 +7,7 @@ import action from '../action-wrapper.js';
  * @param {Spinner} spinner - Spinner
  * @returns {Promise} promise
  */
-async function linkModules(_, context, spinner) {
+async function linkModules({ context, spinner }) {
   const { pkgLinks, pkgManager } = context;
 
   if (pkgLinks && pkgLinks.length) {

package/lib/scaffold/actions/load-preset.js

@@ -5,13 +5,13 @@ import { default as gasketUtils } from '@gasket/utils';
 import { mkdtemp } from 'fs/promises';
 import { createRequire } from 'module';
 const require = createRequire(import.meta.url);
+const hasVersion = /@(\^[0-9]\.|[0-9]).+/;
 
 /**
  * loadPresets - Load presets to temp directory
- * @param {null} _ - no input
  * @param {CreateContext} context - Create context
  */
-async function loadPresets(_, context) {
+async function loadPresets({ context }) {
   const tmpDir = await mkdtemp(path.join(os.tmpdir(), `gasket-create-${context.appName}`));
   context.tmpDir = tmpDir;
 
@@ -23,7 +23,7 @@ async function loadPresets(_, context) {
   const pkgVerb = pkgManager.isYarn ? 'add' : 'install';
 
   const remotePresets = context.rawPresets.map(async preset => {
-    const parts = /@(\^[0-9]\.|[0-9]).+/.test(preset) && preset.split('@').filter(Boolean);
+    const parts = hasVersion.test(preset) && preset.split('@').filter(Boolean);
     const name = parts ? `@${parts[0]}` : preset;
     const version = parts ? `@${parts[1]}` : '@latest';
 

package/lib/scaffold/actions/mkdir.js

@@ -10,7 +10,7 @@ import action from '../action-wrapper.js';
  * @param {Spinner} spinner - Spinner
  * @returns {Promise} promise
  */
-async function mkDir(_, context, spinner) {
+async function mkDir({ context, spinner }) {
   const { dest, relDest, extant, destOverride } = context;
 
   // At this point, either the directory does not exist, or the user has

package/lib/scaffold/actions/post-create-hooks.js

@@ -4,10 +4,11 @@ import { runShellCommand } from '@gasket/utils';
 /**
  * Executes the `postCreate` hook for all registered plugins.
  *
+ * @param {GasketEngine} gasket - Gasket API
  * @param {CreateContext} context - Create context
  * @returns {Promise} promise
  */
-async function postCreateHooks(gasket, context) {
+async function postCreateHooks({ gasket, context }) {
   const { dest } = context;
 
   /**

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

@@ -5,7 +5,7 @@ import action from '../action-wrapper.js';
  * @param {Gasket} gasket - Preset gasket instance
  * @param {CreateContext} context - Create context
  */
-async function presetConfigHooks(gasket, context) {
+async function presetConfigHooks({ gasket, context }) {
   const config = await gasket.execWaterfall('presetConfig', context);
   Object.assign(context.presetConfig, config);
 }

package/lib/scaffold/actions/preset-prompt-hooks.js

@@ -6,7 +6,7 @@ import action from '../action-wrapper.js';
  * @param {Gasket} gasket - Preset gasket instance
  * @param {CreateContext} context - Create context
  */
-async function presetPromptHooks(gasket, context) {
+async function presetPromptHooks({ gasket, context }) {
   const prompt = context.prompts ? inquirer.createPromptModule() : () => ({});
 
   const nextContext = await gasket.execWaterfall('presetPrompt', context, { prompt });

package/lib/scaffold/actions/print-report.js

@@ -63,7 +63,7 @@ function buildReport(context) {
 
  * @param {CreateContext} context - Create context
  */
-async function printReport(_, context) {
+async function printReport({ context }) {
   const report = buildReport(context);
   const { warnings, errors } = context;
 

package/lib/scaffold/actions/prompt-hooks.js

@@ -27,10 +27,11 @@ async function execPluginPrompts(gasket, context) {
  * Executes the `prompt` hook for all registered plugins.
  * Adds `prompt` util function for prompting features.
  *
+ * @param {GasketEngine} gasket - Gasket API
  * @param {CreateContext} context - Create context
  * @returns {Promise} promise
  */
-async function promptHooks(gasket, context) {
+async function promptHooks({ gasket, context }) {
   //
   // Because `execPluginPrompts` is recursively, we need to start it
   // with the processPlugins and presets from our initial context

package/lib/scaffold/actions/setup-pkg.js

@@ -11,7 +11,7 @@ const { dependencies } = require('../../../package.json');
  * @param {CreateContext} context - Create context
  * @returns {Promise} promise
  */
-async function setupPkg(gasket, context) {
+async function setupPkg({ context }) {
   const { appName, appDescription, warnings } = context;
 
   const pkg = ConfigBuilder.createPackageJson({
@@ -24,7 +24,6 @@ async function setupPkg(gasket, context) {
   // Add critical dependencies
   pkg.add('dependencies', {
     '@gasket/core': dependencies['@gasket/core'],
-    '@gasket/engine': dependencies['@gasket/engine'],
     '@gasket/utils': dependencies['@gasket/utils']
   });
 

package/lib/scaffold/actions/write-gasket-config.js

@@ -88,7 +88,7 @@ function cleanupFields(config) {
  * @param {CreateContext} context - Create context
  * @returns {Promise} promise
  */
-async function writeGasketConfig(gasket, context) {
+async function writeGasketConfig({ context }) {
   const { dest, gasketConfig, generatedFiles } = context;
   const fileName = context.typescript ? 'gasket.ts' : 'gasket.js';
   const filePath = path.join(dest, fileName);

package/lib/scaffold/actions/write-pkg.js

@@ -6,10 +6,9 @@ import action from '../action-wrapper.js';
  * Writes the contents of `pkg` to the app's package.json.
  *
  * @param {CreateContext} context - Create context
- * @param {Boolean} update - Is an update step
  * @returns {Promise} promise
  */
-async function writePkg(gasket, context) {
+async function writePkg({ context }) {
   const { dest, pkg, generatedFiles } = context;
   const fileName = 'package.json';
   const filePath = path.join(dest, fileName);
@@ -18,5 +17,3 @@ async function writePkg(gasket, context) {
 }
 
 export default action('Write package.json', writePkg);
-
-export const writePkgUpdate = action('Update package.json', writePkg);

package/lib/utils/index.js

@@ -3,4 +3,3 @@ 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-gasket-app",
-  "version": "7.0.0-next.20",
+  "version": "7.0.0-next.23",
   "description": "starter pack for creating a gasket app",
   "main": "lib",
   "bin": {
@@ -14,7 +14,7 @@
     "lint": "eslint .",
     "lint:fix": "npm run lint -- --fix",
     "test": "cross-env NODE_OPTIONS='--unhandled-rejections=strict --experimental-vm-modules' jest",
-    "test:watch": "jest --watch",
+    "test:watch": "npm run test -- --watch",
     "test:coverage": "jest --coverage",
     "posttest": "npm run lint"
   },
@@ -32,11 +32,10 @@
   },
   "homepage": "https://github.com/godaddy/gasket/tree/main/packages/create-gasket-app",
   "dependencies": {
-    "@gasket/core": "^7.0.0-next.20",
-    "@gasket/engine": "^7.0.0-next.20",
-    "@gasket/plugin-git": "^7.0.0-next.20",
-    "@gasket/plugin-logger": "^7.0.0-next.20",
-    "@gasket/utils": "^7.0.0-next.20",
+    "@gasket/core": "^7.0.0-next.23",
+    "@gasket/plugin-git": "^7.0.0-next.23",
+    "@gasket/plugin-logger": "^7.0.0-next.23",
+    "@gasket/utils": "^7.0.0-next.23",
     "commander": "^12.0.0",
     "deepmerge": "^4.3.1",
     "glob": "^8.1.0",
@@ -79,5 +78,5 @@
   "jest": {
     "transform": {}
   },
-  "gitHead": "9c464bc32c8eade218b6ae094e1a0819e84af7ad"
+  "gitHead": "0ba753c8764138e300be1c464065280bcc801239"
 }

package/lib/config/utils.js

@@ -1,32 +0,0 @@
-import { default as diagnostics } from 'diagnostics';
-const debug = diagnostics('gasket:cli:config:utils');
-
-/**
- * Returns specified env option if set or appropriate fallback
- *
- * @param {Object} options - CLI Option
- * @param {string} commandId - Name of the command
- * @param {function} warn - Warning logger
- * @returns {string} environment
- */
-export function getEnvironment(options, commandId, warn) {
-  if (options.env) {
-    debug('Environment was passed through command line options', options.env);
-    return options.env;
-  }
-
-  // special snowflake case to match up `local` env with command unless set
-  if (commandId === 'local') {
-    debug('Environment defaulting to `local` due to `local` command');
-    return 'local';
-  }
-
-  const { NODE_ENV } = process.env;
-  if (NODE_ENV) {
-    warn(`No env specified, falling back to NODE_ENV: "${ NODE_ENV }".`);
-    return NODE_ENV;
-  }
-
-  warn('No env specified, falling back to "development".');
-  return 'development';
-}

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

@@ -1,78 +0,0 @@
-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 LATEST_VERSION = 'latestVersion';
-const LATEST_VERSION_UPDATE_TIME = 'latestVersionUpdateTime';
-
-/**
- * Checks if the latest version update time is older than seven days
- * @param {number} currentTime - current time in milliseconds
- * @param {number} latestVersionUpdateTime - latest version update time in milliseconds
- * @returns {boolean} - true if latestVersionUpdateTime is older than seven days
- */
-function isOlderThanSevenDays(currentTime, latestVersionUpdateTime) {
-  const sevenDaysInMillis = 7 * 24 * 60 * 60 * 1000; // Seven days in milliseconds
-  const timeDifference = Math.abs(currentTime - latestVersionUpdateTime);
-  return timeDifference > sevenDaysInMillis;
-}
-
-/**
- * Fetches the latest version of a package from npm
- * @param {string} pkgName - package name
- * @param {number} currentTime - current time in milliseconds
- * @param {object} cache - cache object
- * @returns {string} - latest version of the package
- */
-async function getLatestVersion(pkgName, currentTime, cache) {
-  if (
-    !cache[LATEST_VERSION_UPDATE_TIME] ||
-    !cache[LATEST_VERSION] ||
-    isOlderThanSevenDays(currentTime, cache[LATEST_VERSION_UPDATE_TIME])
-  ) {
-    try {
-      const cmdResult = await gasketUtils.runShellCommand('npm', ['view', pkgName, 'version'], {});
-      if (cmdResult?.stdout) {
-        const latestVersion = cmdResult.stdout.trim();
-        cache[LATEST_VERSION_UPDATE_TIME] = currentTime;
-        cache[LATEST_VERSION] = latestVersion;
-        await writeFile(cachePath, JSON.stringify(cache));
-        return latestVersion;
-      }
-    } catch (error) {
-      console.error('Error fetching latest version:', error);
-    }
-  } else {
-    return cache[LATEST_VERSION];
-  }
-}
-
-/**
- * Warns if the package is outdated
- * @param {string} pkgName - package name
- * @param {string} currentVersion - current version of the package
- */
-export async function warnIfOutdated(pkgName, currentVersion) {
-  const currentTime = new Date().getTime();
-  let cache = {};
-
-  try {
-    const file = await readFile(cachePath, 'utf8');
-    cache = JSON.parse(file);
-  } catch (error) {
-    // console.error('Error reading cache file:', error);
-  }
-
-  const latestVersion = await getLatestVersion(pkgName, currentTime, cache);
-
-  if (typeof latestVersion === 'string' && semver.gt(latestVersion, currentVersion)) {
-    console.warn(
-      ` ${chalk.yellow('›')}   Warning: ${pkgName} update available from ${chalk.green(latestVersion)} to ${chalk.green(currentVersion)}`
-    );
-  }
-}