create-gasket-app 7.0.0-next.6 → 7.0.0-next.60

package/README.md

@@ -100,38 +100,36 @@ The `prompt` lifecycle is fired using [execWaterfall] and hooks should return a
 modified `context` object.
 
 ```js
-module.exports = {
-  id: 'gasket-plugin-pizza',
-  hooks: {
-    async prompt(gasket, context, { prompt, addPlugins }) {
-      const answers = await prompt([
-        {
-          name: 'pizzaSize',
-          message: 'Choose a pizza size:',
-          type: 'list',
-          choices: ['small', 'medium', 'large']
-        },
-        {
-          name: 'pizzaSauce',
-          message: 'Choose a pizza sauce:',
-          type: 'list',
-          choices: ['red', 'white']
-        },
-        {
-          name: 'wantSoda',
-          message: 'Do you want a soda?',
-          type: 'confirm'
-        }
-      ]);
-
-      if (answers.wantSoda === true) {
-        await addPlugins('gasket-plugin-soda@^2.0.0')
+//  gasket-plugin-pizza.js
+
+const name = 'gasket-plugin-pizza';
+const hooks = {
+  async prompt(gasket, context, { prompt }) {
+    const answers = await prompt([
+      {
+        name: 'pizzaSize',
+        message: 'Choose a pizza size:',
+        type: 'list',
+        choices: ['small', 'medium', 'large']
+      },
+      {
+        name: 'pizzaSauce',
+        message: 'Choose a pizza sauce:',
+        type: 'list',
+        choices: ['red', 'white']
+      },
+      {
+        name: 'wantSoda',
+        message: 'Do you want a soda?',
+        type: 'confirm'
       }
+    ]);
 
-      return { ...context, ...answers };
-    }
+    return { ...context, ...answers };
   }
 };
+
+export default { name, hooks };
 ```
 
 The hook is passed the following parameters:
@@ -156,29 +154,31 @@ package.json or register files and templates to be generated.
 The `create` lifecycle is fired using [exec].
 
 ```js
-const path = require('path');
+//  gasket-plugin-pizza.js
 
-module.exports = {
-  id: 'gasket-plugin-pizza',
-  hooks: {
-    async create(gasket, context) {
-      const { pkg, files } = context; // utils from context
-      const { pizzaSize, pizzaSauce } = context; // data provided by prompt
+import path from 'path';
 
-      files.add(
-        path.join(__dirname, 'generator', 'ingredients', pizzaSauce)
-      );
+const name = 'gasket-plugin-pizza';
+const hooks = {
+  async create(gasket, context) {
+    const { pkg, files } = context; // utils from context
+    const { pizzaSize, pizzaSauce } = context; // data provided by prompt
 
-      pkg.add('devDependencies', {
-        'pizza-oven': '^1.0.0'
-      });
+    files.add(
+      path.join(__dirname, 'generator', 'ingredients', pizzaSauce)
+    );
 
-      pkg.add('scripts', {
-        bake: `pizza-oven --size ${ pizzaSize }`
-      });
-    }
+    pkg.add('devDependencies', {
+      'pizza-oven': '^1.0.0'
+    });
+
+    pkg.add('scripts', {
+      bake: `pizza-oven --size ${ pizzaSize }`
+    });
   }
 };
+
+export default { name, hooks };
 ```
 
 The hook is passed the following parameters:
@@ -206,9 +206,10 @@ generated. This is useful to use in conjunction with any scripts added in the
 The `postCreate` lifecycle is fired by [exec]:
 
 ```js
-module.exports = {
-  id: 'totally-a-good-idea',
-  hooks: {
+// totally-a-good-idea.js
+
+const name = 'totally-a-good-idea';
+const hooks = {
     async create(gasket, context) {
       const { pkg } = context;
 
@@ -221,6 +222,8 @@ module.exports = {
     }
   }
 };
+
+export default { name, hooks };
 ```
 
 The hook is passed the following parameters:

package/lib/commands/create.js

@@ -103,21 +103,23 @@ const createCommand = {
  * @returns {Promise<void>} void
  */
 createCommand.action = async function run(appname, options, command) {
+  process.env.GASKET_ENV = 'create';
   const context = makeCreateContext([appname], options);
   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 +127,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/config/default-plugins.js

@@ -1,7 +1,15 @@
 import pluginGit from '@gasket/plugin-git';
 import pluginLogger from '@gasket/plugin-logger';
+import pluginMetadata from '@gasket/plugin-metadata';
+import pluginCommand from '@gasket/plugin-command';
+import pluginDocs from '@gasket/plugin-docs';
+import pluginDocusaurus from '@gasket/plugin-docusaurus';
 
 export const defaultPlugins = [
   pluginLogger,
-  pluginGit
+  pluginGit,
+  pluginMetadata,
+  pluginCommand,
+  pluginDocs,
+  pluginDocusaurus
 ];

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 {
@@ -9,17 +9,18 @@ export interface Dependencies {
 
 export interface PackageJson extends Dependencies {
   name: string;
-  version: string;
+  version?: string;
   description?: string;
   license?: string;
   repository?:
   | string
   | {
-    type: 'git';
-    url: string;
-  };
+        type: 'git';
+        url: string;
+      };
   scripts?: Record<string, string>;
   optionalDependencies?: Record<string, string>;
+  homepage?: string;
 }
 
 export interface ModuleInfo {
@@ -30,13 +31,16 @@ export interface ModuleInfo {
   version?: string;
 }
 
-export interface PresetInfo extends ModuleInfo {
-}
+export interface PresetInfo extends ModuleInfo {}
 
-export interface PluginInfo extends ModuleInfo {
-}
+export interface PluginInfo extends ModuleInfo {}
 
 export interface ConfigBuilder<Config> {
+  /**
+   * fields object 
+   */
+  fields: { [key: string]: any };
+
   /**
    * Adds all `[key, value]` pairs in the `fields` provided.
    * @param fields - Object to merge. Can be a function that accepts the current fields and object to merge.
@@ -95,7 +99,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 +114,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,21 +131,21 @@ export interface ConfigBuilder<Config> {
    *  }
    * });
    */
-  injectValue(configKey: string, injectedValue: any): void;
+  injectValue(configKey: string, injectedValue: string): void;
 }
 
 export interface PackageJsonBuilder extends ConfigBuilder<PackageJson> {
   /**
-   * Checks if a dependency has been already added
-   * @param  key - Dependency bucket
-   * @param  value - Dependency to search
-   * @returns True if the dependency exists on the bucket
+   * Checks if a property exists on the package.json fields.
+   * @param  key - Field to search
+   * @param  value - Value to search for
+   * @returns True if the property exists and matches the value
    */
-  has(key: keyof Dependencies, value: string): boolean;
+  has(key: keyof PackageJson, value: string): boolean;
 }
 
 export interface Files {
-  add(...args: string[]): void
+  add(...args: string[]): void;
 }
 
 export interface CreateContext {
@@ -186,7 +190,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;
@@ -199,8 +203,8 @@ export interface CreateContext {
   /** Should a git repo be initialized and first commit */
   gitInit: boolean;
 
-  /** Name of the plugin for unit tests */
-  testPlugin: string;
+  /** Names of the plugins that add unit and integration tests */
+  testPlugins: Array<string>;
 
   /** Which package manager to use (Default: 'npm') */
   packageManager: string;
@@ -233,14 +237,23 @@ 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: {
-        prompt: (prompts: Array<Record<string, any>>) => Promise<Record<string, any>>,
+        prompt: (
+          prompts: Array<Record<string, any>>
+        ) => Promise<Record<string, any>>;
+        addPlugins: (plugins: Array<string>) => Promise<void>;
       }
     ): MaybeAsync<CreateContext>;
 
@@ -249,7 +262,8 @@ declare module '@gasket/engine' {
     postCreate(
       context: CreateContext,
       utils: {
-        runScript: (script: string) => Promise<void>
-      }): MaybeAsync<void>;
+        runScript: (script: string) => Promise<void>;
+      }
+    ): MaybeAsync<void>;
   }
 }

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

@@ -109,6 +109,7 @@ async function performGenerate(context, descriptors) {
   handlebars.registerHelper('jspretty', (data) => {
     return JSON.stringify(data).replace(/"/g, '\'');
   });
+  handlebars.registerHelper('eq', (a, b) => a === b)
 
   debug('descriptors', JSON.stringify(descriptors, null, 2));
 
@@ -164,7 +165,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

@@ -61,42 +61,54 @@ async function choosePackageManager(context, prompt) {
 }
 
 /**
- * Choose your unit test suite
+ * Choose your unit test suite and integration test suite
  *
  * @param {CreateContext} context - Create context
  * @param {function} prompt - function to prompt user
  * @returns {Promise} promise
  */
-async function chooseTestPlugin(context, prompt) {
-  const knownTestPlugins = { mocha: '@gasket/plugin-mocha', jest: '@gasket/plugin-jest', cypress: '@gasket/plugin-cypress' };
-
-  if (!('testPlugin' in context)) {
-    let testPlugin;
+async function chooseTestPlugins(context, prompt) {
+  const knownTestPlugins = {
+    unit: { mocha: '@gasket/plugin-mocha', jest: '@gasket/plugin-jest' },
+    integration: { cypress: '@gasket/plugin-cypress' }
+  };
 
-    if ('testSuite' in  context) {
-      testPlugin = knownTestPlugins[context.testSuite];
+  const testTypes = ['unit', 'integration'];
+  const testPlugins = [];
+
+  if (!('testPlugins' in context)) {
+    for (const type of testTypes) {
+      if (type + 'TestSuite' in context) {
+        const testSuite = knownTestPlugins[type][context[type + 'TestSuite']];
+        if (testSuite) testPlugins.push(testSuite);
+      } else {
+        const plugin = await promptForTestPlugin(
+          prompt,
+          `Choose your ${type} test suite`,
+          Object.entries(knownTestPlugins[type]).map(([name, value]) => ({ name, value }))
+        );
+
+        if (plugin) testPlugins.push(plugin);
+      }
     }
 
-    if (!testPlugin) {
-      ({ testPlugin } = await prompt([
-        {
-          name: 'testPlugin',
-          message: 'Choose your unit test suite',
-          type: 'list',
-          choices: [
-            { name: 'none (not recommended)', value: 'none' },
-            { name: 'mocha + nyc + sinon + chai', value: '@gasket/plugin-mocha' },
-            { name: 'jest', value: '@gasket/plugin-jest' },
-            { name: 'cypress', value: '@gasket/plugin-cypress' }
-          ]
-        }
-      ]));
+    if (testPlugins.length > 0) {
+      Object.assign(context, { testPlugins });
     }
+  }
+}
 
-    if (testPlugin && testPlugin !== 'none') {
-      Object.assign(context, { testPlugin });
+async function promptForTestPlugin(prompt, message, choices) {
+  const { testPlugin } = await prompt([
+    {
+      name: 'testPlugin',
+      message,
+      type: 'list',
+      choices: [{ name: 'none', value: 'none' }, ...choices]
     }
-  }
+  ]);
+
+  return testPlugin !== 'none' ? testPlugin : null;
 }
 
 /**
@@ -126,7 +138,7 @@ async function allowExtantOverwriting(context, prompt) {
 export const questions = [
   chooseAppDescription,
   choosePackageManager,
-  chooseTestPlugin,
+  chooseTestPlugins,
   allowExtantOverwriting
 ];
 
@@ -136,7 +148,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,37 +5,53 @@ import { default as gasketUtils } from '@gasket/utils';
 import { mkdtemp } from 'fs/promises';
 import { createRequire } from 'module';
 const require = createRequire(import.meta.url);
+const hasVersionOrTag = /@([\^~]?\d+\.\d+\.\d+(?:-[\d\w.-]+)?|[\^~]?\d+\.\d+\.\d+|[a-zA-Z]+)$/;
 
 /**
  * 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;
 
+  const modPath = path.join(tmpDir, 'node_modules');
   const pkgManager = new gasketUtils.PackageManager({
     packageManager: context.packageManager,
     dest: tmpDir
   });
-  const pkgVerb = pkgManager.isYarn ? 'add' : 'install';
+  const pkgVerb = pkgManager.manager === 'yarn' ? 'add' : 'install';
 
   const remotePresets = context.rawPresets.map(async preset => {
-    const parts = /@(\^[0-9]\.|[0-9]).+/.test(preset) && preset.split('@').filter(Boolean);
+    const parts = hasVersionOrTag.test(preset) && preset.split('@').filter(Boolean);
     const name = parts ? `@${parts[0]}` : preset;
     const version = parts ? `@${parts[1]}` : '@latest';
-    await pkgManager.exec(pkgVerb, [`${name}${version}`]);
-    // eslint-disable-next-line
-    const mod = await import(name);
-    return mod.default || mod;
+
+    try {
+      // Install the preset
+      await pkgManager.exec(pkgVerb, [`${name}${version}`]);
+      // Get the package file
+      const pkgFile = require(path.join(modPath, name, 'package.json'));
+      // Import the preset via the package file attrs, name and main
+      // We can't specify the cwd for the import, so we need to use the full path
+      // expects type:module & "main": "lib/fullpath.js"
+      const mod = await import(`${modPath}/${name}/${pkgFile.main}`);
+      return mod.default || mod;
+    } catch (err) {
+      throw new Error(`Failed to install preset ${name}${version}: ${err.message}`);
+    }
   });
 
   const localPresets = context.localPresets.map(async localPresetPath => {
-    await pkgManager.exec(pkgVerb, [localPresetPath]);
-    const pkgFile = require(path.join(localPresetPath, 'package.json'));
-    const mod = await import(pkgFile.name);
-    return mod.default || mod;
+
+    try {
+      await pkgManager.exec(pkgVerb, [localPresetPath]);
+      const pkgFile = require(path.join(localPresetPath, 'package.json'));
+      const mod = await import(`${modPath}/${pkgFile.name}/${pkgFile.main}`);
+      return mod.default || mod;
+    } catch (err) {
+      throw new Error(`Failed to install local preset ${localPresetPath}`);
+    }
   });
 
   context.presets = await Promise.all([...remotePresets, ...localPresets]);

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

@@ -1,6 +1,9 @@
 import action from '../action-wrapper.js';
 import { ConfigBuilder } from '../config-builder.js';
 import { default as gasketUtils } from '@gasket/utils';
+import { createRequire } from 'module';
+const require = createRequire(import.meta.url);
+const { dependencies } = require('../../../package.json');
 
 /**
  * Initializes the ConfigBuilder builder and adds to context.
@@ -8,16 +11,22 @@ import { default as gasketUtils } from '@gasket/utils';
  * @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({
     name: appName,
     version: '0.0.0',
     description: appDescription,
-    type: context.typescript ? 'commonjs' : 'module'
+    type: 'module'
   }, { warnings });
 
+  // Add critical dependencies
+  pkg.add('dependencies', {
+    '@gasket/core': dependencies['@gasket/core'],
+    '@gasket/utils': dependencies['@gasket/utils']
+  });
+
   const pkgManager = new gasketUtils.PackageManager(context);
   Object.assign(context, { pkg, pkgManager });
 }

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

@@ -88,9 +88,9 @@ function cleanupFields(config) {
  * @param {CreateContext} context - Create context
  * @returns {Promise} promise
  */
-async function writeGasketConfig(gasket, context) {
-  const { dest, gasketConfig, generatedFiles } = context;
-  const fileName = context.typescript ? 'gasket.ts' : 'gasket.js';
+async function writeGasketConfig({ context }) {
+  const { dest, gasketConfig, generatedFiles, typescript } = context;
+  const fileName = typescript ? 'gasket.ts' : 'gasket.js';
   const filePath = path.join(dest, fileName);
   const plugins = gasketConfig.fields.plugins;
   const assignments = gasketConfig.fields.injectionAssignments || null;
@@ -98,6 +98,7 @@ async function writeGasketConfig(gasket, context) {
   gasketConfig.fields.plugins = 'PLUGIN_REPLACE';
 
   let contents = '';
+  if (typescript) contents += `import type { GasketConfigDefinition } from '@gasket/core';\n`;
   contents += `import { makeGasket } from '@gasket/core';\n`;
   contents += writeImports(gasketConfig.fields.pluginImports);
   contents += writeImports(gasketConfig.fields.imports);
@@ -105,8 +106,9 @@ async function writeGasketConfig(gasket, context) {
   createInjectionAssignments(gasketConfig.fields, assignments);
   cleanupFields(gasketConfig);
 
-  const pluginImports = `[\n${writePluginImports(plugins)}\n\t]`;
-  contents += `\nexport default makeGasket(${JSON5.stringify(gasketConfig.fields, null, 2)});\n`;
+  const pluginImports = `[\n${writePluginImports(plugins)}\n  ]`;
+  const typeCoercion = typescript ? ' as GasketConfigDefinition' : '';
+  contents += `\nexport default makeGasket(${JSON5.stringify(gasketConfig.fields, null, 2)}${typeCoercion});\n`;
   contents = contents.replace('\'PLUGIN_REPLACE\'', pluginImports);
   contents = replaceInjectionAssignments(contents, assignments);
 

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/scaffold/config-builder.js

@@ -376,9 +376,12 @@ export class ConfigBuilder {
         return;
       }
 
+      // If a prerelease version, strip the range prefix
+      const version = ver.includes('-') ? ver.replace(/^[\^~]/, '') : ver;
+
       const blameId = `${key}.${dep}`;
       if (!prev) {
-        existing[dep] = ver;
+        existing[dep] = version;
         setBlame(blameId);
         return;
       }
@@ -386,7 +389,7 @@ export class ConfigBuilder {
       const blamed = this.blame.get(blameId);
       const forced = this.force.has(blameId);
 
-      if (prev === ver) {
+      if (prev === version) {
         if (forced) return;
         if (force) {
           setBlame(blameId);
@@ -398,21 +401,21 @@ export class ConfigBuilder {
 
       const prevName = blamed.join(', ');
       if (!forced) {
-        const newer = force ? ver : this.tryGetNewerRange(prev, ver);
-        const overridden = newer === ver;
+        const newer = force ? version : this.tryGetNewerRange(prev, version);
+        const overridden = newer === version;
         if (overridden) {
-          existing[dep] = ver;
+          existing[dep] = version;
           setBlame(blameId);
         }
       }
 
-      if (!semver.validRange(prev) || !semver.validRange(ver) || !semver.intersects(prev, ver)) {
+      if (!semver.validRange(prev) || !semver.validRange(version) || !semver.intersects(prev, version)) {
         let forceMsg = force ? '(forced)' : '';
         forceMsg = forced && force ? '(cannot be forced)' : forceMsg;
         this.warn(`
   Conflicting versions for ${dep} in "${key}":
     - ${prev} provided by ${prevName} ${forced && '(forced)' || ''}
-    - ${ver} provided by ${name} ${forceMsg}
+    - ${version} provided by ${name} ${forceMsg}
     Using ${existing[dep]}, but this may cause unexpected behavior.
 `);
       }

package/lib/scaffold/create-context.js

@@ -83,7 +83,7 @@ function flatten(acc, values) {
  *
  * @property {String} appDescription - Description of app
  * @property {Boolean} gitInit - Should a git repo be initialized and first commit
- * @property {String} testPlugin - Name of the plugin for unit tests
+ * @property {String} testPlugins - Array of testing plugins
  * @property {String} packageManager - Which package manager to use (Default: 'npm')
  * @property {String} installCmd - Derived install command (Default: 'npm install')
  * @property {String} localCmd - Derived local run command (Default: 'npx gasket local')

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/lib/utils/logo.js

@@ -1,12 +1,12 @@
 export const logo = `
-          ▄▄▄▄████▀▀█▄
-      ▄███▀▀▀▀▀▀▀█▄▄██
-    ▄██▀   ▄▄▄▄▄   ▀██▌                  ▄▄▄
-  ▄██▀   ███▀▀▀▀█    ██                   ██              ██
- █▀▀█   ██▌          ▐█▌  ▄▀▀▀█▄  ▄█▀▀▀▄  ██ ▐██▀ ▄█▀▀█▄ ▀██▀▀
- █▄▄█   ██▌   ▀▀██   ▐█▌  ▄▄▄▄██  ▀▀█▄▄▄  █████   ██▄▄██  ██
-  ▀██▄   ███▄▄▄▄██   ██   ▀▄▄▄▀█▄ ▀▄▄▄█▀ ▄██▄ ██▄ ▀█▄▄▄▄  ▀█▄▄
-    ▀██▄   ▀▀▀  ▀▀ ▄██▌
-      ▀███▄▄▄▄▄▄▄█▀▀██
-          ▀▀▀▀████▄▄█▀
+         ▄▄▄▄████▀▀█▄
+     ▄████▀▀▀▀▀▀█▄▄██
+    ███▀  ▄▄▄▄▄   ▀██▌                 ▄▄▄
+  ▄███  ███▀▀▀▀██   ██                  ██              ██
+ █▀▀█  ██▌          ▐█▌ ▄▀▀▀█▄  ▄█▀▀▀▄  ██ ▐██▀ ▄█▀▀█▄ ▀██▀▀
+ █▄▄█  ██▌   ▀▀██   ▐█▌ ▄▄▄▄██  ▀▀█▄▄▄  █████   ██▄▄██  ██
+  ▀███  ███▄▄▄▄██   ██  ▀▄▄▄▀█▄ ▀▄▄▄█▀ ▄██▄ ██▄ ▀█▄▄▄▄  ▀█▄▄
+    ███▄  ▀▀▀  ▀▀ ▄██▌
+     ▀████▄▄▄▄▄▄█▀▀██
+         ▀▀▀▀████▄▄█▀
 `;

package/lib/utils/process-command.js

@@ -1,5 +1,7 @@
 import { Command } from 'commander';
-import { processArgs, processOptions, createOption } from './index.js';
+import { processArgs } from './process-args.js';
+import { processOptions } from './process-options.js';
+import { createOption } from './create-option.js';
 const program = new Command();
 
 /**

package/package.json

@@ -1,20 +1,21 @@
 {
   "name": "create-gasket-app",
-  "version": "7.0.0-next.6",
+  "version": "7.0.0-next.60",
   "description": "starter pack for creating a gasket app",
-  "main": "lib",
+  "type": "module",
   "bin": {
     "create-gasket-app": "./lib/index.js"
   },
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "files": [
     "lib"
   ],
-  "type": "module",
   "scripts": {
     "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,17 +33,17 @@
   },
   "homepage": "https://github.com/godaddy/gasket/tree/main/packages/create-gasket-app",
   "dependencies": {
-    "@gasket/core": "^7.0.0-next.6",
-    "@gasket/engine": "^7.0.0-next.6",
-    "@gasket/plugin-git": "^7.0.0-next.6",
-    "@gasket/plugin-lifecycle": "^7.0.0-next.6",
-    "@gasket/plugin-logger": "^7.0.0-next.6",
-    "@gasket/plugin-metadata": "^7.0.0-next.6",
-    "@gasket/plugin-start": "^7.0.0-next.6",
-    "@gasket/resolve": "^7.0.0-next.6",
-    "@gasket/utils": "^7.0.0-next.6",
+    "@gasket/core": "7.0.0-next.60",
+    "@gasket/plugin-command": "7.0.0-next.60",
+    "@gasket/plugin-docs": "7.0.0-next.60",
+    "@gasket/plugin-docusaurus": "7.0.0-next.60",
+    "@gasket/plugin-git": "7.0.0-next.60",
+    "@gasket/plugin-logger": "7.0.0-next.60",
+    "@gasket/plugin-metadata": "7.0.0-next.60",
+    "@gasket/utils": "7.0.0-next.60",
     "commander": "^12.0.0",
     "deepmerge": "^4.3.1",
+    "glob": "^8.1.0",
     "handlebars": "^4.7.8",
     "inquirer": "6.5.2",
     "json5": "^2.2.3",
@@ -58,10 +59,10 @@
     "diagnostics": "^2.0.2",
     "dotenv": "^16.4.5",
     "eslint": "^8.56.0",
-    "eslint-config-godaddy": "^7.0.2",
-    "eslint-plugin-jest": "^27.6.3",
+    "eslint-config-godaddy": "^7.1.1",
+    "eslint-plugin-jest": "^28.6.0",
     "eslint-plugin-json": "^3.1.0",
-    "eslint-plugin-unicorn": "^44.0.0",
+    "eslint-plugin-unicorn": "^55.0.0",
     "jest": "^29.7.0"
   },
   "eslintConfig": {
@@ -82,5 +83,5 @@
   "jest": {
     "transform": {}
   },
-  "gitHead": "805a1026959d8aa783ee32be8a8ff76c06badd2f"
+  "gitHead": "ea9feae6cd291d4361c06e09659e50dbec19bcea"
 }

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/main.js

@@ -1,20 +0,0 @@
-import { fork } from 'child_process';
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-
-/**
- * Executes the @gasket/cli passing through the create command and any arguments.
- *
- * @param {string[]} args - create command arguments
- * @returns {ChildProcess} process
- */
-export default function main(...args) {
-  // import.meta.resolve is not available in Jest without babel transform
-  const gasketBin = require.resolve('@gasket/cli/bin/run');
-
-  return fork(
-    gasketBin,
-    ['create', ...args],
-    { stdio: 'inherit', stdin: 'inherit', stderr: 'inherit' }
-  );
-}

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)}`
-    );
-  }
-}