create-gasket-app 7.2.1 → 7.2.3

package/lib/commands/create.js

@@ -4,23 +4,21 @@ import { makeCreateContext } from '../scaffold/create-context.js';
 import { dumpErrorContext } from '../scaffold/dump-error-context.js';
 import { rm } from 'fs/promises';
 import { makeGasket } from '@gasket/core';
-import {
-  createHooks,
-  generateFiles,
-  globalPrompts,
-  installModules,
-  linkModules,
-  loadPreset,
-  mkDir,
-  postCreateHooks,
-  printReport,
-  presetPromptHooks,
-  presetConfigHooks,
-  promptHooks,
-  setupPkg,
-  writeGasketConfig,
-  writePkg
-} from '../scaffold/actions/index.js';
+import globalPrompts from '../scaffold/actions/global-prompts.js';
+import loadPreset from '../scaffold/actions/load-preset.js';
+import presetPromptHooks from '../scaffold/actions/preset-prompt-hooks.js';
+import presetConfigHooks from '../scaffold/actions/preset-config-hooks.js';
+import promptHooks from '../scaffold/actions/prompt-hooks.js';
+import mkDir from '../scaffold/actions/mkdir.js';
+import setupPkg from '../scaffold/actions/setup-pkg.js';
+import createHooks from '../scaffold/actions/create-hooks.js';
+import writePkg from '../scaffold/actions/write-pkg.js';
+import generateFiles from '../scaffold/actions/generate-files.js';
+import writeGasketConfig from '../scaffold/actions/write-gasket-config.js';
+import installModules from '../scaffold/actions/install-modules.js';
+import linkModules from '../scaffold/actions/link-modules.js';
+import postCreateHooks from '../scaffold/actions/post-create-hooks.js';
+import printReport from '../scaffold/actions/print-report.js';
 
 /**
  * Parses comma separated option input to array
@@ -94,9 +92,10 @@ const createCommand = {
 
 /**
  * createCommand action
- * @type {import('../index').createCommandAction}
+ * @type {import('create-gasket-app').createCommandAction}
  */
 createCommand.action = async function run(appname, options, command) {
+  // eslint-disable-next-line no-process-env
   process.env.GASKET_ENV = 'create';
   const context = makeCreateContext([appname], options);
   const { rawPresets, localPresets } = context;
@@ -105,7 +104,6 @@ createCommand.action = async function run(appname, options, command) {
     await globalPrompts({ context });
 
     if (rawPresets.length || localPresets.length) {
-
       await loadPreset({ context });
 
       const presetGasket = makeGasket({
@@ -118,7 +116,7 @@ createCommand.action = async function run(appname, options, command) {
 
     const pluginGasket = makeGasket({
       ...context.presetConfig,
-      plugins: context.presets.concat(context.presetConfig.plugins)
+      plugins: context.presetConfig.plugins.concat(context.presets)
     });
 
     await promptHooks({ gasket: pluginGasket, context });
@@ -134,6 +132,7 @@ createCommand.action = async function run(appname, options, command) {
     if (context.tmpDir) await rm(context.tmpDir, { recursive: true });
     printReport({ context });
   } catch (err) {
+    // eslint-disable-next-line no-console
     console.error(chalk.red('Exiting with errors.'));
     dumpErrorContext(context, err);
     throw err;

package/lib/index.d.ts

@@ -1,7 +1,9 @@
-import type { GasketConfigDefinition, MaybeAsync, Plugin, GasketEngine } from '@gasket/core';
+/* eslint-disable no-use-before-define */
+import type { GasketConfigDefinition, MaybeAsync, Plugin, GasketEngine, CreateContext } from '@gasket/core';
 import type { PackageManager } from '@gasket/utils';
 import type { PromptModule } from 'inquirer';
 import type ora from 'ora';
+import type { Command } from 'commander';
 
 export interface Dependencies {
   dependencies?: Record<string, string>;
@@ -48,14 +50,14 @@ interface CommandOption {
 export function createCommandAction(
   appname: string,
   options: CreateCommandOptions,
-  command: Command 
+  command: Command
 ): Promise<void>;
 
 export interface CreateCommand {
   id: string;
   description: string;
   args: CommandArgument[];
-  action?: createGasketAction;
+  action?: typeof createCommandAction;
   options: CommandOption[];
   hidden?: boolean;
   default?: boolean;
@@ -100,7 +102,6 @@ export interface ConfigBuilder<Config> {
   /**
    * Performs an intelligent, domain-aware merge of the `value` for
    * the given `key` into the package.json fields associated with this instance.
-   *
    * @param key - Field in package.json to add or extend.
    * @param value - Target value to set for key provided.
    * @param source - Plugin to blame if conflicts arise from this operation.
@@ -118,6 +119,11 @@ export interface ConfigBuilder<Config> {
   ): void;
   add(key: string, value: object, options?: object): void;
 
+  /** Remove a key from fields
+   * @param {string[]} path - Array of strings representing the path to the field to remove
+  */
+  remove(path: string[]): void;
+
   /**
    * 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...`
@@ -136,6 +142,44 @@ export interface ConfigBuilder<Config> {
    */
   addPlugin(pluginImport: string, pluginName: string): void;
 
+  /**
+   * addEnvironment - Add environments to the gasket file
+   * @param {string} key - name of the environment - `local.analyze`
+   * @param {object} value - configuration for the environment - `{
+   *   dynamicPlugins: [
+   *     '@gasket/plugin-analyze',
+   *   ]
+   * }`
+   * @example
+   *   environments: {
+   *    'local.analyze': {
+   *      dynamicPlugins: [
+   *        '@gasket/plugin-analyze',
+   *      ]
+   *     }
+   *   },
+   */
+  addEnvironment(key:string, value: object): void;
+
+  /**
+   * addCommand - Add commands to the gasket file
+   * @param {string} key - name of the command - `docs`
+   * @param {object} value - configuration for the command - `{
+   *   dynamicPlugins: [
+   *     '@gasket/plugin-docs',
+   *   ]
+   * }`
+   * @example
+   *   commands: {
+   *    'docs': {
+   *      dynamicPlugins: [
+   *        '@gasket/plugin-docs',
+   *      ]
+   *     }
+   *   },
+   */
+  addCommand(key:string, value: object): void;
+
   /**
    * addImport - Add a non-plugin import to the gasket file
    * @param {string} importName - name of the import used as a value - `import fs...`
@@ -214,9 +258,9 @@ interface Files {
   /**
    * Adds the specified `globby` compatible patterns, `globs`,
    * into the set of all sources for this set of files.
-   * @param {Object} params - Object containing `globs` and `source`.
+   * @param {object} params - Object containing `globs` and `source`.
    * @param {string[]} params.globs - `globby` compatible patterns.
-   * @param {Object} params.source - Plugin to blame if conflicts arise from this operation.
+   * @param {object} params.source - Plugin to blame if conflicts arise from this operation.
    */
   add(params: { globs: string[], source: object }): void;
   add(...globs: string[]): void;
@@ -275,7 +319,7 @@ interface Files {
     force?: boolean;
   }): void;
 
-    /**
+  /**
    * Normalizes a potential semver range into a semver string
    * and returns the newest version
    * @param  {string} r1 Semver string (potentially invalid).
@@ -287,7 +331,7 @@ interface Files {
    */
   tryGetNewerRange(r1: string, r2: string): string | undefined;
 
-    /**
+  /**
    * Performs a naive attempt to take a transform a semver range
    * into a concrete version that may be used for "newness"
    * comparison.
@@ -301,9 +345,9 @@ interface Files {
    * the `orderFields` options having their keys sorted.
    * @returns {object} Ready to be serialized JavaScript object.
    */
-    toJSON(): object;
+  toJSON(): object;
 
-    /**
+  /**
    * Orders the given object, `obj`, applying any (optional)
    * key order specified via `orderBy`. If no `orderBy` is provided
    * keys are ordered lexographically.
@@ -384,8 +428,10 @@ declare module 'create-gasket-app' {
     /** paths to the local presets packages */
     localPresets: Array<string>;
 
-    /** Raw preset desc from args. Can include version constraint. Added by
-     * load-preset if using localPresets. */
+    /**
+     * Raw preset desc from args. Can include version constraint. Added by
+     * load-preset if using localPresets.
+     */
     rawPresets: Array<string>;
 
     /** Local packages that should be linked */
@@ -461,8 +507,8 @@ declare module 'create-gasket-app' {
 
     /** Use to add content to the README.md */
     readme: Readme;
-    
-    constructor(initContext?: Partial<T>);
+
+    constructor(initContext?: Partial<CreateContext>);
     runWith(plugin: Plugin): Proxy<CreateContext>;
     typescript?: boolean;
   }

package/lib/internal.d.ts

@@ -1,14 +1,14 @@
-import { Gasket } from '@gasket/core';
 import type {
   CreateContext,
   CreatePrompt,
   ConfigBuilder,
   CreateCommand,
   CommandArgument,
-  CommandOption
-} from './index';
-import type { GasketEngine, Plugin } from '@gasket/core';
-import type ora from 'ora';
+  CommandOption,
+  CreateCommandOptions
+} from 'create-gasket-app';
+import type { GasketEngine, Plugin, Gasket } from '@gasket/core';
+import type { Ora } from 'ora';
 import type { Command, Option } from 'commander';
 
 
@@ -29,47 +29,91 @@ export function makeCreateContext(argv?: string[], options?: CreateCommandOption
 
 export function makeCreateRuntime(context: PartialCreateContext, source: Plugin): Proxy<CreateContext>;
 
-export function spinnerAction({ gasket, context, spinner } : {
-  gasket?: GasketEngine;
-  context?: CreateContext;
-  spinner?: ora.Ora
-}): Promise<void>;
-export function withSpinnerWrapper({ gasket, context } : { gasket: GasketEngine, context: CreateContext }): Promise<void>; 
+/**
+ * Represents the execution context for a task.
+ */
+export interface SpinnerContext {
+  gasket?: Gasket;
+  context: PartialCreateContext;
+  spinner: Ora;
+}
+
+/**
+ * Task function type that runs within a spinner wrapper.
+ */
+export type SpinnerTask = (params: SpinnerContext) => Promise<void>;
+
+/**
+ * Options for the spinner wrapper.
+ */
+export interface SpinnerOptions {
+  startSpinner?: boolean;
+}
+
+/**
+ * Wraps a task with a spinner, handling success and failure states.
+ */
+export function wrapWithSpinner(
+  label: string,
+  task: SpinnerTask,
+  options?: SpinnerOptions
+): (context: { context: SpinnerContext['context'] } & {
+  errors?: Error[]
+}) => Promise<void>;
+
+/**
+ * Wraps a task with a spinner, using both gasket and context.
+ */
+export function withGasketSpinner(
+  label: string,
+  task: SpinnerTask,
+  options?: SpinnerOptions
+): (context: { gasket: any; context: SpinnerContext['context'] }) => Promise<void>;
+
+/**
+ * Wraps a task with a spinner, using only context.
+ */
 export function withSpinner(
   label: string,
-  fn: spinnerAction,
-  options?: { startSpinner?: boolean }
-): withSpinnerWrapper
+  task: SpinnerTask,
+  options?: SpinnerOptions
+): (context: { context: SpinnerContext['context'] }) => Promise<void>;
+
+export function spinnerAction(params: {
+  gasket?: GasketEngine;
+  context: PartialCreateContext;
+  spinner?: Ora
+}): Promise<void>;
+
+export function execute(params: { gasket: Gasket, context: PartialCreateContext } & {
+  errors?: Error[]
+}): Promise<void>;
 
 /** sacaffold/actions */
 
-export function createHooks({ gasket, context } : { gasket: GasketEngine; context: CreateContext }): Promise<void>;
+export function createHooks(params: { gasket?: Gasket; context: PartialCreateContext }): Promise<void>;
 
-export function chooseAppDescription(context: CreateContext, prompt: CreatePrompt): Promise<void>;
-export function choosePackageManager(context: CreateContext, prompt: CreatePrompt): Promise<void>;
-export function chooseTestPlugins(context: CreateContext, prompt: CreatePrompt): Promise<void>;
+export function chooseAppDescription(context: PartialCreateContext, prompt: CreatePrompt): Promise<void>;
+export function choosePackageManager(context: PartialCreateContext, prompt: CreatePrompt): Promise<void>;
+export function chooseTestPlugins(context: PartialCreateContext, prompt: CreatePrompt): Promise<void>;
 export function promptForTestPlugin(
-  prompt: CreatePrompt, 
-  message: string, 
+  prompt: CreatePrompt,
+  message: string,
   choices: { name: string; value: string; }[]
 ): Promise<string | null>;
-export function allowExtantOverwriting(context: CreateContext, prompt: CreatePrompt): Promise<void>;
-export function globalPrompts({ context } : { context: CreateContext }): Promise<void>;
-
-export function loadPresets({ context } : { context: CreateContext }): Promise<void>;
-
-export function presetPromptHooks({ gasket, context }: { gasket: GasketEngine; context: CreateContext }): Promise<void>;
+export function allowExtantOverwriting(context: PartialCreateContext, prompt: CreatePrompt): Promise<void>;
+export function globalPrompts(params: { context: PartialCreateContext }): Promise<void>;
+export function loadPresets(params: { context: PartialCreateContext }): Promise<void>;
+export function presetPromptHooks(params: { gasket?: Gasket; context: PartialCreateContext }): Promise<void>;
+export function presetConfigHooks(params: { gasket?: Gasket; context: PartialCreateContext }): Promise<void>;
+export function promptHooks(params: { gasket?: Gasket; context: PartialCreateContext }): Promise<void>;
+export function execPluginPrompts(gasket: Gasket, context: PartialCreateContext): Promise<void>;
 
-export function presetConfigHooks({ gasket, context }: { gasket: GasketEngine; context: CreateContext }): Promise<void>;
+export function mkDir({ context, spinner }: { context: CreateContext, spinner: Ora }): Promise<void>;
 
-export function promptHooks({ gasket, context }: { gasket: GasketEngine; context: CreateContext }): Promise<void>;
-export function execPluginPrompts(gasket: GasketEngine, context: CreateContext): Promise<void>;
+export function setupPkg(params: { context: PartialCreateContext }): Promise<void>;
 
-export function mkDir({ context, spinner }: { context: CreateContext, spinner: ora.Ora }): Promise<void>;
-
-export function setupPkg({ context }: { context: CreateContext }): Promise<void>;
-
-export function writePkg({ context }: { context: CreateContext }): Promise<void>;
+export function writePkg(params: { context: PartialCreateContext }): Promise<void>;
 
 export type Descriptior = {
   pattern: string;
@@ -80,13 +124,13 @@ export type Descriptior = {
   from: string;
   overrides?: string;
 }
-export function generateFiles({ context, spinner }: { context: CreateContext, spinner: ora.Ora }): Promise<void>;
+export function generateFiles({ context, spinner }: { context: CreateContext, spinner: Ora }): Promise<void>;
 export function performGenerate(context: CreateContext, descriptors: Descriptior[]): boolean[];
 export function getDescriptors(context: CreateContext): Promise<Descriptior[]>;
-export function assembleDescriptors(dest: string, from: string, pattern: string, srcPaths: sring[]): Descriptior[];
+export function assembleDescriptors(dest: string, from: string, pattern: string, srcPaths: string[]): Descriptior[];
 export function reduceDescriptors(descriptors: Descriptior[]): Descriptior[];
 
-export function writeGasketConfig({ context }: { context: CreateContext }): Promise<void>;
+export function writeGasketConfig(params: { context: PartialCreateContext }): Promise<void>;
 export function writeImports(imports: object | null): string;
 export function writeExpressions(expressions: string[] | null): string;
 export function createInjectionAssignments(config: object, assignments: (object | null)): string;
@@ -94,14 +138,16 @@ export function cleanupFields(config: ConfigBuilder): void;
 export function writePluginImports(plugins: string[]): string;
 export function replaceInjectionAssignments(content: string, assignments: (object | null)): string;
 
-export function installModules({ context }: { context: CreateContext }): Promise<void>;
+export function installModules(params: { context: PartialCreateContext }): Promise<void>;
 
-export function linkModules({context, spinner}: { context: CreateContext, spinner: ora.Ora }): Promise<void>;
+export function linkModules(params: { context: CreateContext, spinner: Ora }): Promise<void>;
 
-export function postCreateHooks({ gasket, context }: { gasket: GasketEngine, context: CreateContext }): Promise<void>;
+export function postCreateHooks(params: { gasket?: Gasket, context: PartialCreateContext }): Promise<void>;
 
-export function printReport({ context }: { context: CreateContext }): Promise<void>;
-export function buildReport(context: CreateContext): {
+export function printReport(params: {
+  context: PartialCreateContext
+}): Promise<void>;
+export function buildReport(context: PartialCreateContext): {
   appName?: string;
   output?: string;
   generatedFiles?: string[];
@@ -119,15 +165,14 @@ export function isValidCommand(command: CreateCommand): boolean;
 export function processArgs(args: CommandArgument[]): [string, string?, any?][];
 export function isValidArg(arg: CommandArgument): boolean;
 
-interface OptionDefinition { 
+interface OptionDefinition {
   options: [string, string];
   conflicts: CommandOption['conflicts'];
   hidden: CommandOption['hidden'];
   required: CommandOption['required'];
   defaultValue: CommandOption['default'];
   parse: CommandOption['parse']
-};
+}
 export function isValidOption(option: CommandOption): boolean;
-export function processOptions(options: CommandOption[]): OptionDefinition[]
-
-export function createOption(definition: OptionDefinition): Option
+export function processOptions(options: CommandOption[]): OptionDefinition[];
+export function createOption(definition: OptionDefinition): Option;

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

@@ -1,4 +1,4 @@
-import action from '../action-wrapper.js';
+import { withGasketSpinner } from '../with-spinner.js';
 import { ConfigBuilder } from '../config-builder.js';
 import { Files } from '../files.js';
 import Readme from '../readme.js';
@@ -20,4 +20,4 @@ async function createHooks({ gasket, context }) {
   });
 }
 
-export default action('Execute create hooks', createHooks);
+export default withGasketSpinner('Execute create hooks', createHooks);

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

@@ -7,7 +7,7 @@ import path from 'path';
 import mkdirp from 'mkdirp';
 import chalk from 'chalk';
 const { dim } = chalk;
-import action from '../action-wrapper.js';
+import { withSpinner } from '../with-spinner.js';
 import * as syncGlob from 'glob';
 const glob = promisify(syncGlob.default);
 
@@ -168,7 +168,7 @@ async function generateFiles({ context, spinner }) {
   if (hasError) spinner.fail();
 }
 
-export default action('Generate app contents', generateFiles);
+export default withSpinner('Generate app contents', generateFiles);
 // exported for unit testing
 export const _getDescriptors = getDescriptors;
 export const _assembleDescriptors = assembleDescriptors;

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

@@ -1,5 +1,5 @@
 import inquirer from 'inquirer';
-import action from '../action-wrapper.js';
+import { withSpinner } from '../with-spinner.js';
 
 /**
  * What is your app description?
@@ -150,4 +150,4 @@ async function globalPrompts({ context }) {
   }
 }
 
-export default action('Global prompts', globalPrompts, { startSpinner: false });
+export default withSpinner('Global prompts', globalPrompts, { startSpinner: false });

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

@@ -1,4 +1,4 @@
-import action from '../action-wrapper.js';
+import { withSpinner } from '../with-spinner.js';
 
 /**
  * Installs node_modules using the selected package manager
@@ -10,4 +10,4 @@ async function installModules({ context }) {
   await pkgManager.install();
 }
 
-export default action('Install node modules', installModules);
+export default withSpinner('Install node modules', installModules);

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

@@ -1,4 +1,4 @@
-import action from '../action-wrapper.js';
+import { withSpinner } from '../with-spinner.js';
 
 /**
  * Links local packages using the selected package manager
@@ -13,4 +13,4 @@ async function linkModules({ context, spinner }) {
   }
 }
 
-export default action('Link node modules', linkModules, { startSpinner: false });
+export default withSpinner('Link node modules', linkModules, { startSpinner: false });

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

@@ -1,6 +1,6 @@
 import path from 'path';
 import os from 'os';
-import action from '../action-wrapper.js';
+import { withSpinner } from '../with-spinner.js';
 import { PackageManager } from '@gasket/utils';
 import { mkdtemp } from 'fs/promises';
 import { createRequire } from 'module';
@@ -57,4 +57,4 @@ async function loadPresets({ context }) {
   context.presets = await Promise.all([...remotePresets, ...localPresets]);
 }
 
-export default action('Load presets', loadPresets);
+export default withSpinner('Load presets', loadPresets);

package/lib/scaffold/actions/mkdir.js

@@ -1,5 +1,5 @@
 import { mkdir } from 'fs/promises';
-import action from '../action-wrapper.js';
+import { withSpinner } from '../with-spinner.js';
 
 /**
  * Validates this instance can execute without common blockers:
@@ -24,4 +24,4 @@ async function mkDir({ context, spinner }) {
   }
 }
 
-export default action('Set up directory', mkDir);
+export default withSpinner('Set up directory', mkDir);

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

@@ -1,4 +1,4 @@
-import action from '../action-wrapper.js';
+import { withGasketSpinner } from '../with-spinner.js';
 import { runShellCommand } from '@gasket/utils';
 
 /**
@@ -25,4 +25,4 @@ async function postCreateHooks({ gasket, context }) {
   await gasket.exec('postCreate', context, utils);
 }
 
-export default action('Execute postCreate hooks', postCreateHooks);
+export default withGasketSpinner('Execute postCreate hooks', postCreateHooks);

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

@@ -1,4 +1,4 @@
-import action from '../action-wrapper.js';
+import { withGasketSpinner } from '../with-spinner.js';
 
 /**
  * presetConfigHooks - exec `presetConfig` hook
@@ -9,4 +9,4 @@ async function presetConfigHooks({ gasket, context }) {
   Object.assign(context.presetConfig, config);
 }
 
-export default action('Preset Config', presetConfigHooks, { startSpinner: false });
+export default withGasketSpinner('Preset Config', presetConfigHooks, { startSpinner: false });

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

@@ -1,5 +1,5 @@
 import inquirer from 'inquirer';
-import action from '../action-wrapper.js';
+import { withGasketSpinner } from '../with-spinner.js';
 
 /**
  * presetPromptHooks - exec `presetPrompt` hook
@@ -13,4 +13,4 @@ async function presetPromptHooks({ gasket, context }) {
   Object.assign(context, nextContext);
 }
 
-export default action('Preset prompts', presetPromptHooks, { startSpinner: false });
+export default withGasketSpinner('Preset prompts', presetPromptHooks, { startSpinner: false });

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

@@ -1,6 +1,6 @@
 import pkg from 'chalk';
 const { bold } = pkg;
-import action from '../action-wrapper.js';
+import { withSpinner } from '../with-spinner.js';
 import { logo } from '../../utils/index.js';
 
 /**
@@ -8,6 +8,7 @@ import { logo } from '../../utils/index.js';
  * @private
  */
 const newline = () => {
+  // eslint-disable-next-line no-console
   console.log('');
 };
 
@@ -58,6 +59,7 @@ async function printReport({ context }) {
   const report = buildReport(context);
   const { warnings, errors } = context;
 
+  // eslint-disable-next-line no-console
   console.log(`✨Success!
 
 Finished with ${warnings.length} warnings and ${errors.length} errors using
@@ -66,10 +68,13 @@ Finished with ${warnings.length} warnings and ${errors.length} errors using
   Object.entries(report).forEach(([k, v]) => {
     if (!v || !v.length) return;
     newline();
+    // eslint-disable-next-line no-console
     console.log(`${bold(toSpaceCase(k))}`);
     if (Array.isArray(v)) {
+      // eslint-disable-next-line no-console
       v.map(o => console.log(`  ${o}`));
     } else {
+      // eslint-disable-next-line no-console
       console.log(`  ${v}`);
     }
   });
@@ -77,4 +82,4 @@ Finished with ${warnings.length} warnings and ${errors.length} errors using
   newline();
 }
 
-export default action('Print report', printReport, { startSpinner: false });
+export default withSpinner('Print report', printReport, { startSpinner: false });

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

@@ -1,5 +1,5 @@
 import inquirer from 'inquirer';
-import action from '../action-wrapper.js';
+import { withGasketSpinner } from '../with-spinner.js';
 
 /**
  * Initializes engine with provide preset and plugins
@@ -31,4 +31,4 @@ async function promptHooks({ gasket, context }) {
   await execPluginPrompts(gasket, context);
 }
 
-export default action('Plugin prompts', promptHooks, { startSpinner: false });
+export default withGasketSpinner('Plugin prompts', promptHooks, { startSpinner: false });

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

@@ -1,4 +1,4 @@
-import action from '../action-wrapper.js';
+import { withSpinner } from '../with-spinner.js';
 import { ConfigBuilder } from '../config-builder.js';
 import { PackageManager } from '@gasket/utils';
 import { createRequire } from 'module';
@@ -30,4 +30,4 @@ async function setupPkg({ context }) {
   Object.assign(context, { pkg, pkgManager });
 }
 
-export default action('Set up package.json', setupPkg, { startSpinner: false });
+export default withSpinner('Set up package.json', setupPkg, { startSpinner: false });

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

@@ -1,7 +1,7 @@
 import { default as JSON5 } from 'json5';
 import path from 'path';
 import { writeFile } from 'fs/promises';
-import action from '../action-wrapper.js';
+import { withSpinner } from '../with-spinner.js';
 
 /**
  * writePluginImports - Write string imports as value(s)
@@ -107,4 +107,4 @@ async function writeGasketConfig({ context }) {
   generatedFiles.add(fileName);
 }
 
-export default action('Write gasket config', writeGasketConfig);
+export default withSpinner('Write gasket config', writeGasketConfig);

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

@@ -1,6 +1,6 @@
 import path from 'path';
 import { writeFile } from 'fs/promises';
-import action from '../action-wrapper.js';
+import { withSpinner } from '../with-spinner.js';
 
 /**
  * Writes the contents of `pkg` to the app's package.json.
@@ -14,4 +14,4 @@ async function writePkg({ context }) {
   generatedFiles.add(fileName);
 }
 
-export default action('Write package.json', writePkg);
+export default withSpinner('Write package.json', writePkg);

package/lib/scaffold/config-builder.js

@@ -52,7 +52,7 @@ function isValidVersion(v) {
 /**
  * ConfigBuilder is an extensible data structure for **specifically**
  * managing `package.json` data.
- * @type {import('../index').ConfigBuilder}
+ * @type {import('create-gasket-app').ConfigBuilder}
  */
 export class ConfigBuilder {
   /**
@@ -217,6 +217,29 @@ export class ConfigBuilder {
     }
   }
 
+  /** Remove a key from fields
+   * @param {string[]} path - Array of strings representing the path to the field to remove
+  */
+  remove(path) {
+    if (!Array.isArray(path) || path.length === 0) {
+      throw new Error('Path must be a non-empty array of strings');
+    }
+
+    let current = this.fields;
+    for (let i = 0; i < path.length - 1; i++) {
+      if (Object.prototype.hasOwnProperty.call(current, path[i])) {
+        current = current[path[i]];
+      } else {
+        return; // Path does not exist
+      }
+    }
+
+    const key = path[path.length - 1];
+    if (Object.prototype.hasOwnProperty.call(current, key)) {
+      delete current[key];
+    }
+  }
+
   /**
    * 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...`
@@ -238,6 +261,52 @@ export class ConfigBuilder {
     this.add('pluginImports', { [pluginImport]: pluginName });
   }
 
+  /**
+   * addEnvironment - Add environments to the gasket file
+   * @param {string} key - name of the environment - `local.analyze`
+   * @param {object} value - configuration for the environment - `{
+   *   dynamicPlugins: [
+   *     '@gasket/plugin-analyze',
+   *   ]
+   * }`
+   * @example
+   *   environments: {
+   *    'local.analyze': {
+   *      dynamicPlugins: [
+   *        '@gasket/plugin-analyze',
+   *      ]
+   *     }
+   *   },
+   */
+  addEnvironment(key, value) {
+    this.add('environments', {
+      [key]: value
+    });
+  }
+
+  /**
+   * addCommand - Add commands to the gasket file
+   * @param {string} key - name of the command - `docs`
+   * @param {object} value - configuration for the command - `{
+   *   dynamicPlugins: [
+   *     '@gasket/plugin-docs',
+   *   ]
+   * }`
+   * @example
+   *   commands: {
+   *    'docs': {
+   *      dynamicPlugins: [
+   *        '@gasket/plugin-docs',
+   *      ]
+   *     }
+   *   },
+   */
+  addCommand(key, value) {
+    this.add('commands', {
+      [key]: value
+    });
+  }
+
   /**
    * addImport - Add a non-plugin import to the gasket file
    * @param {string} importName - name of the import used as a value - `import fs...`

package/lib/scaffold/create-context.js

@@ -31,6 +31,9 @@ function makeCreateRuntime(context, source) {
 
       has(key, value) {
         return context.pkg.has(key, value);
+      },
+      remove(path) {
+        context.pkg.remove(path);
       }
     }
   };
@@ -90,7 +93,7 @@ export function makeCreateContext(argv = [], options = {}) {
   /**
    * Input context which will be appended by prompts and passed to create hooks
    * @type {import('../internal').PartialCreateContext}
-  */
+   */
   const context = new CreateContext({
     destOverride: true,
     cwd,

package/lib/scaffold/files.js

@@ -1,13 +1,13 @@
 /**
  * Utility for plugins to add files and templates for generating
- * @type {import('../index').Files}
+ * @type {import('create-gasket-app').Files}
  */
 export class Files {
   constructor() {
-  /**
-   * Array of glob sets, each containing an array of globs and a source object.
-   * @type {Array<{globs: string[], source: object}>}
-   */
+    /**
+     * Array of glob sets, each containing an array of globs and a source object.
+     * @type {Array<{globs: string[], source: object}>}
+     */
     this.globSets = [];
   }
 

package/lib/scaffold/readme.js

@@ -1,6 +1,6 @@
 import { readFile } from 'fs/promises';
 
-/** @type {import('../index').Readme} */
+/** @type {import('create-gasket-app').Readme} */
 export default class Readme {
   constructor() {
     this.markdown = [];

package/lib/scaffold/with-spinner.js

@@ -0,0 +1,48 @@
+import ora from 'ora';
+
+/**
+ * Base function to handle spinner logic
+ * @type {import('../internal').wrapWithSpinner}
+ */
+function wrapWithSpinner(label, task, { startSpinner = true } = {}) {
+  /** @type {import('../internal').execute} */
+  async function execute(context) {
+    const spinner = ora(label);
+    if (startSpinner) spinner.start();
+
+    try {
+      await task({ ...context, spinner });
+      if (spinner.isSpinning) spinner.succeed();
+    } catch (error) {
+      spinner.fail();
+      context.errors = context.errors || [];
+      context.errors.push(error.stack);
+      throw error;
+    }
+  }
+
+  execute.wrapped = task;
+  return execute;
+}
+
+/**
+ * Wrap a task with a spinner, including gasket and context.
+ * @type {import('../internal').withGasketSpinner}
+ */
+export function withGasketSpinner(label, task, options) {
+  return wrapWithSpinner(label, ({ gasket, context, spinner }) =>
+    task({ gasket, context, spinner }),
+  options
+  );
+}
+
+/**
+ * Wrap a task with a spinner, using only context.
+ * @type {import('../internal').withSpinner}
+ */
+export function withSpinner(label, task, options) {
+  return wrapWithSpinner(label, ({ context, spinner }) =>
+    task({ context, spinner }),
+  options
+  );
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-gasket-app",
-  "version": "7.2.1",
+  "version": "7.2.3",
   "description": "starter pack for creating a gasket app",
   "type": "module",
   "bin": {
@@ -35,16 +35,16 @@
   },
   "homepage": "https://github.com/godaddy/gasket/tree/main/packages/create-gasket-app",
   "dependencies": {
-    "@gasket/core": "^7.2.1",
-    "@gasket/plugin-command": "^7.2.1",
-    "@gasket/plugin-docs": "^7.2.1",
-    "@gasket/plugin-docusaurus": "^7.2.1",
-    "@gasket/plugin-dynamic-plugins": "^7.2.1",
-    "@gasket/plugin-git": "^7.2.1",
-    "@gasket/plugin-logger": "^7.2.1",
-    "@gasket/plugin-metadata": "^7.2.1",
-    "@gasket/request": "^7.2.0",
-    "@gasket/utils": "^7.2.1",
+    "@gasket/core": "^7.2.3",
+    "@gasket/plugin-command": "^7.2.3",
+    "@gasket/plugin-docs": "^7.2.3",
+    "@gasket/plugin-docusaurus": "^7.2.3",
+    "@gasket/plugin-dynamic-plugins": "^7.2.3",
+    "@gasket/plugin-git": "^7.2.3",
+    "@gasket/plugin-logger": "^7.2.3",
+    "@gasket/plugin-metadata": "^7.2.3",
+    "@gasket/request": "^7.2.3",
+    "@gasket/utils": "^7.2.3",
     "commander": "^12.0.0",
     "deepmerge": "^4.3.1",
     "diagnostics": "^2.0.2",
@@ -63,8 +63,8 @@
     "dotenv": "^16.4.5",
     "eslint": "^8.56.0",
     "eslint-config-godaddy": "^7.1.1",
+    "eslint-config-godaddy-typescript": "^4.0.3",
     "eslint-plugin-jest": "^28.6.0",
-    "eslint-plugin-json": "^3.1.0",
     "eslint-plugin-unicorn": "^55.0.0",
     "jest": "^29.7.0",
     "typescript": "^5.4.5"
@@ -81,7 +81,20 @@
     ],
     "rules": {
       "unicorn/filename-case": "error"
-    }
+    },
+    "overrides": [
+      {
+        "files": [
+          "lib/*.ts"
+        ],
+        "extends": [
+          "godaddy-typescript"
+        ],
+        "rules": {
+          "jsdoc/*": "off"
+        }
+      }
+    ]
   },
   "eslintIgnore": [
     "test/fixtures"
@@ -89,5 +102,5 @@
   "jest": {
     "transform": {}
   },
-  "gitHead": "8af41663d838cb00344ffbdabf64fc535b78dd3d"
+  "gitHead": "3fb21dbc6f75b8b9619a1e70073a504f84a29943"
 }

package/lib/scaffold/action-wrapper.js

@@ -1,29 +0,0 @@
-import ora from 'ora';
-
-/**
- * Decorate a create action with spinner.
- * If an action throws, a fail spinner will render for the step, regardless of
- * if the spinner was started or not.
- * @type {import('../internal').withSpinner}
- */
-export default function withSpinner(label, fn, { startSpinner = true } = {}) {
-  /**
-   * Decorated function
-   * @type {import('../internal').withSpinnerWrapper}
-   */
-  async function wrapper({ gasket = {}, context }) {
-    const spinner = ora(label);
-    if (startSpinner) spinner.start();
-    try {
-      await fn({ gasket, context, spinner });
-      if (spinner.isSpinning) spinner.succeed();
-    } catch (err) {
-      spinner.fail();
-      context.errors.push(err.stack);
-      throw err;
-    }
-  }
-
-  wrapper.wrapped = fn;
-  return wrapper;
-}

package/lib/scaffold/actions/index.js

@@ -1,33 +0,0 @@
-import mkDir from './mkdir.js';
-import loadPreset from './load-preset.js';
-import globalPrompts from './global-prompts.js';
-import setupPkg from './setup-pkg.js';
-import writePkg from './write-pkg.js';
-import installModules from './install-modules.js';
-import linkModules from './link-modules.js';
-import writeGasketConfig from './write-gasket-config.js';
-import presetPromptHooks from './preset-prompt-hooks.js';
-import presetConfigHooks from './preset-config-hooks.js';
-import promptHooks from './prompt-hooks.js';
-import createHooks from './create-hooks.js';
-import generateFiles from './generate-files.js';
-import postCreateHooks from './post-create-hooks.js';
-import printReport from './print-report.js';
-
-export {
-  mkDir,
-  loadPreset,
-  globalPrompts,
-  setupPkg,
-  writePkg,
-  installModules,
-  linkModules,
-  writeGasketConfig,
-  presetPromptHooks,
-  presetConfigHooks,
-  promptHooks,
-  createHooks,
-  postCreateHooks,
-  generateFiles,
-  printReport
-};