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

package/lib/commands/create.js

@@ -1,26 +1,27 @@
-/* eslint-disable max-statements */
-const ora = require('ora');
-const chalk = require('chalk');
-const makeCreateContext = require('../scaffold/create-context');
-const dumpErrorContext = require('../scaffold/dump-error-context');
-const {
-  applyPresetConfig,
-  cliVersion,
+/* eslint-disable max-statements, no-unused-vars */
+import chalk from 'chalk';
+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 { defaultPlugins } from '../config/default-plugins.js';
+import {
   createHooks,
   generateFiles,
   globalPrompts,
   installModules,
   linkModules,
-  loadPkgForDebug,
   loadPreset,
   mkDir,
   postCreateHooks,
   printReport,
+  presetPromptHooks,
+  presetConfigHooks,
   promptHooks,
   setupPkg,
   writeGasketConfig,
   writePkg
-} = require('../scaffold/actions');
+} from '../scaffold/actions/index.js';
 
 /**
  * Parses comma separated option input to array
@@ -49,13 +50,6 @@ const createCommand = {
       Or other (multiple) custom presets (e.g. --presets my-gasket-preset@1.0.0.beta-1,nextjs@^1.0.0)`,
       parse: commasToArray
     },
-    {
-      name: 'plugins',
-      description: `Additional plugin(s) to install. Can be set as
-      multiple flags (e.g. --plugins jest --plugins zkconfig@^1.0.0)
-      comma-separated values: --plugins=jest,zkconfig^1.0.0`,
-      parse: commasToArray
-    },
     {
       name: 'package-manager',
       description: `Selects which package manager you would like to use during
@@ -67,18 +61,6 @@ const createCommand = {
       description: 'Require module(s) before Gasket is initialized',
       parse: commasToArray
     },
-    {
-      name: 'no-bootstrap',
-      description: '(INTERNAL) If provided, skip the bootstrap phase',
-      type: 'boolean',
-      hidden: true
-    },
-    {
-      name: 'no-generate',
-      description: '(INTERNAL) If provided, skip the generate phase',
-      type: 'boolean',
-      hidden: true
-    },
     {
       name: 'npm-link',
       description: `(INTERNAL) Local packages to be linked. Can be set as
@@ -105,46 +87,14 @@ const createCommand = {
       conflicts: ['config']
     },
     {
-      name: 'prompts',
+      name: 'no-prompts',
       description: '(INTERNAL) Disable to skip the prompts',
-      default: true,
       type: 'boolean',
       hidden: true
     }
   ]
 };
 
-/**
- * bootstrap - Bootstrap the application
- * @param {CreateContext} context - Create context
- */
-async function bootstrapHandler(context) {
-  await loadPreset(context);
-  cliVersion(context);
-  applyPresetConfig(context);
-  await globalPrompts(context);
-  await mkDir(context);
-  await setupPkg(context);
-  await writePkg(context);
-  await installModules(context);
-  await linkModules(context);
-}
-
-/**
- * generate - Generate the application
- * @param {CreateContext} context - Create context
- */
-async function generateHandler(context) {
-  await promptHooks(context);
-  await createHooks(context);
-  await generateFiles(context);
-  await writeGasketConfig(context);
-  await writePkg.update(context);
-  await installModules.update(context);
-  await linkModules.update(context); // relink any that were messed up by re-install
-  await postCreateHooks(context);
-}
-
 /**
  * createCommand action
  * @param {string} appname Required cmd arg - name of the app to create
@@ -153,35 +103,40 @@ async function generateHandler(context) {
  * @returns {Promise<void>} void
  */
 createCommand.action = async function run(appname, options, command) {
-  const argv = [appname];
-  const { bootstrap = true, generate = true } = options;
+  const context = makeCreateContext([appname], options);
+  const { rawPresets, localPresets } = context;
 
-  let context;
   try {
-    context = makeCreateContext(argv, options);
-  } catch (error) {
-    console.error(chalk.red(error) + '\n');
-    command.help();
-  }
+    await globalPrompts({ context });
 
-  try {
-    if (bootstrap) {
-      await bootstrapHandler(context);
-    } else {
-      ora('Bootstrap phase skipped.').warn();
-      if (generate) {
-        await loadPkgForDebug(context);
-      }
-    }
+    if (rawPresets.length || localPresets.length) {
+      await loadPreset({ context });
+
+      const presetGasket = makeGasket({
+        plugins: context.presets
+      });
 
-    if (generate) {
-      await generateHandler(context);
-    } else {
-      ora('Generate phase skipped.').warn();
+      await presetPromptHooks({ gasket: presetGasket, context });
+      await presetConfigHooks({ gasket: presetGasket, context });
     }
 
-    printReport(context);
+    const pluginGasket = makeGasket({
+      ...context.presetConfig,
+      plugins: context.presets.concat(context.presetConfig.plugins, defaultPlugins)
+    });
 
+    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({ context });
   } catch (err) {
     console.error(chalk.red('Exiting with errors.'));
     dumpErrorContext(context, err);
@@ -189,4 +144,4 @@ createCommand.action = async function run(appname, options, command) {
   }
 };
 
-module.exports = createCommand;
+export { createCommand };

package/lib/config/default-plugins.js

@@ -1,7 +1,7 @@
-module.exports = [
-  require('@gasket/plugin-lifecycle'),
-  require('@gasket/plugin-metadata'),
-  require('@gasket/plugin-start'),
-  require('@gasket/plugin-git'),
-  require('@gasket/plugin-logger')
+import pluginGit from '@gasket/plugin-git';
+import pluginLogger from '@gasket/plugin-logger';
+
+export const defaultPlugins = [
+  pluginLogger,
+  pluginGit
 ];

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-import type { GasketConfigDefinition, MaybeAsync } from '@gasket/engine';
+import type { GasketConfigDefinition, MaybeAsync, Plugin, GasketEngine } from '@gasket/engine';
 import type { PackageManager } from '@gasket/utils';
 
 export interface Dependencies {
@@ -62,6 +62,72 @@ export interface ConfigBuilder<Config> {
     value: Config[Key],
     options?: { force?: boolean }
   ): 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...`
+   * @param {string} pluginName - name of the plugin import/package - `from 'pluginName'`
+   * @example
+   * addPlugin('pluginA', '@gasket/plugin-a')
+   *
+   * // gasket.js
+   * import pluginA from '@gasket/plugin-a';
+   *
+   * export default makeGasket({
+   *  plugins: [
+   *    pluginA
+   *  ]
+   * });
+   */
+  addPlugin(pluginImport: string, pluginName: string): void;
+
+  /**
+   * addImport - Add a non-plugin import to the gasket file
+   * @param {string} importName - name of the import used as a value - `import fs...`
+   * @param {string} importPath - path of the import - `from 'fs'`
+   * @returns {ConfigBuilder} - instance for chaining
+   * @example
+   * Can be default or named import
+   * addImport('{ readFileSync }', 'fs')
+   * addImport('fs', 'fs')
+   *
+   * // gasket.js
+   * import { readFileSync } from 'fs';
+   * import fs from 'fs';
+   */
+  addImport(importName: string, importPath: string): ConfigBuilder<Config>;
+
+  /**
+   * addExpression - add programmatic expression to the gasket file
+   * @param {string} expression - expression to add after imports
+   * @returns {ConfigBuilder} - instance for chaining
+   * @example
+   *
+   * .addImport('fs', 'fs')
+   * .addExpression('const file = fs.readFileSync(\'./file.txt\')')
+   *
+   * // gasket.js
+   * import fs from 'fs';
+   * const file = fs.readFileSync('./file.txt');
+   */
+  addExpression(expression: string): ConfigBuilder<Config>;
+
+  /**
+   * injectValue - Inject a value into the gasket config object
+   * @param {string} configKey - collapsed object path to inject value into - `express.config.routes`
+   * @param {string} injectedValue - string used as a value
+   * @example
+   * .addImport('{ routes }', './routes')
+   * .injectValue('express.routes', 'routes');
+   *
+   * // gasket.js
+   * export default makeGasket({
+   *  express: {
+   *    routes: routes
+   *  }
+   * });
+   */
+  injectValue(configKey: string, injectedValue: string): void;
 }
 
 export interface PackageJsonBuilder extends ConfigBuilder<PackageJson> {
@@ -101,12 +167,6 @@ export interface CreateContext {
    * load-preset if using localPresets. */
   rawPresets: Array<string>;
 
-  /** Raw plugin desc from flags, prompts, etc. Can include constraints. */
-  rawPlugins: Array<string>;
-
-  /** Short names of plugins */
-  plugins: Array<string>;
-
   /** Local packages that should be linked */
   pkgLinks: Array<string>;
 
@@ -125,6 +185,12 @@ export interface CreateContext {
   /** any generated files to show in report */
   generatedFiles: Set<string>;
 
+  /** Default empty array, populated by load-preset with actual imports */
+  presets: Array<Plugin>;
+
+  /** Default to object w/empty plugins array to be populated by `presetConfig` hook */
+  presetConfig: GasketConfigDefinition;
+
   // Added by `global-prompts`
 
   /** Description of app */
@@ -148,23 +214,6 @@ export interface CreateContext {
   /** Whether or not the user wants to override an extant directory */
   destOverride: boolean;
 
-  // Added by `load-preset`
-
-  /** Short name of presets */
-  presets: Array<string>;
-
-  /** Shallow load of presets with meta data */
-  presetInfos: Array<PresetInfo>;
-
-  // Added by `cli-version`
-
-  /** Version of current CLI used to issue `create` command */
-  cliVersion: string;
-
-  /** Version of CLI to install, either current or min compatible version
-   * required by preset(s) */
-  cliVersionRequired: string;
-
   // Added by `setup-pkg`
 
   /** package.json builder */
@@ -184,13 +233,20 @@ export interface CreateContext {
   files: Files;
 }
 
+export interface ActionWrapperParams {
+  gasket: GasketEngine;
+  context: CreateContext;
+  spinner?: any;
+}
+
 declare module '@gasket/engine' {
   export interface HookExecTypes {
+    presetPrompt(context: CreateContext): Promise<void>;
+    presetConfig(context: CreateContext): Promise<CreateContext['presetConfig']>;
     prompt(
       context: CreateContext,
       utils: {
         prompt: (prompts: Array<Record<string, any>>) => Promise<Record<string, any>>,
-        addPlugins: (plugins: Array<string>) => Promise<void>
       }
     ): MaybeAsync<CreateContext>;
 

package/lib/index.js

@@ -1,11 +1,12 @@
 #!/usr/bin/env node
-require('./utils/setup');
+import { Command } from 'commander';
+import { createRequire } from 'module';
+import { createCommand } from './commands/create.js';
+import { processCommand, logo, warnIfOutdated } from './utils/index.js';
+
+const require = createRequire(import.meta.url);
 const pkg = require('../package.json');
-const { Command } = require('commander');
 const program = new Command();
-const CreateCommand = require('./commands/create');
-
-const { processCommand, logo, warnIfOutdated } = require('./utils');
 
 // Create Gasket CLI
 const gasketBin = program
@@ -17,7 +18,7 @@ const gasketBin = program
 
 
 async function main() {
-  const { command, hidden, isDefault } = processCommand(CreateCommand);
+  const { command, hidden, isDefault } = processCommand(createCommand);
   await warnIfOutdated(pkg.name, pkg.version);
   gasketBin.addCommand(command, { hidden, isDefault });
 

package/lib/main.js

@@ -1,4 +1,6 @@
-const { fork } = require('child_process');
+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.
@@ -6,7 +8,8 @@ const { fork } = require('child_process');
  * @param {string[]} args - create command arguments
  * @returns {ChildProcess} process
  */
-function main(...args) {
+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(
@@ -15,5 +18,3 @@ function main(...args) {
     { stdio: 'inherit', stdin: 'inherit', stderr: 'inherit' }
   );
 }
-
-module.exports = main;

package/lib/scaffold/action-wrapper.js

@@ -1,4 +1,4 @@
-const ora = require('ora');
+import ora from 'ora';
 
 /**
  * Decorate a create action with spinner.
@@ -10,19 +10,20 @@ const ora = require('ora');
  * @param {Boolean} startSpinner - Should the spinner start
  * @returns {Function} decorated action
  */
-module.exports = function withSpinner(label, fn, { startSpinner = true } = {}) {
-
+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(context) {
+  async function wrapper({ gasket = {}, context }) {
     const spinner = ora(label);
     if (startSpinner) spinner.start();
     try {
-      await fn(context, spinner);
+      await fn({ gasket, context, spinner });
       if (spinner.isSpinning) spinner.succeed();
     } catch (err) {
       spinner.fail();
@@ -33,4 +34,4 @@ module.exports = function withSpinner(label, fn, { startSpinner = true } = {}) {
 
   wrapper.wrapped = fn;
   return wrapper;
-};
+}

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

@@ -1,26 +1,25 @@
-const createEngine = require('../create-engine');
-const action = require('../action-wrapper');
-const ConfigBuilder = require('../config-builder');
-const Files = require('../files');
+import action from '../action-wrapper.js';
+import { ConfigBuilder } from '../config-builder.js';
+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(context) {
-  const { dest, presets = [], plugins = [], warnings } = context;
+async function createHooks({ gasket, context }) {
+  const { plugins = [], warnings } = context;
 
   const files = new Files();
-  const gasketConfig = ConfigBuilder.create({}, { orderBy: ['plugins'], warnings });
+  const gasketConfig = ConfigBuilder.create({}, { orderBy: ['plugins'], warnings, plugins });
   Object.assign(context, { files, gasketConfig });
 
-  const gasket = await createEngine({ dest, presets, plugins });
   await gasket.execApply('create', async function applyCreate(plugin, handler) {
     await handler(context.runWith(plugin));
   });
 }
 
-module.exports = action('Execute create hooks', createHooks);
+export default action('Execute create hooks', createHooks);

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

@@ -1,14 +1,16 @@
-/* eslint-disable max-statements */
-const debug = require('diagnostics')('gasket:create-gasket-app:generate-files');
-const fs = require('fs').promises;
-const { promisify } = require('util');
-const Handlebars = require('handlebars');
-const path = require('path');
-const mkdirp = require('mkdirp');
-const { dim } = require('chalk');
-const action = require('../action-wrapper');
-
-const glob = promisify(require('glob'));
+import { default as diagnostics } from 'diagnostics';
+const debug = diagnostics('gasket:cli:generate-files');
+import fs from 'fs/promises';
+import { promisify } from 'util';
+import Handlebars from 'handlebars';
+import path from 'path';
+import mkdirp from 'mkdirp';
+import chalk from 'chalk';
+const { dim } = chalk;
+import action from '../action-wrapper.js';
+import * as syncGlob from 'glob';
+const glob = promisify(syncGlob.default);
+
 const flatten = (acc, values) => (acc || []).concat(values);
 const reSep = /[/\\]+/;
 const joinSep = pthArr => pthArr.join(path.sep);
@@ -162,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) {
@@ -177,7 +179,7 @@ async function generateFiles(context, spinner) {
   if (hasError) spinner.fail();
 }
 
-module.exports = action('Generate app contents', generateFiles);
+export default action('Generate app contents', generateFiles);
 // exported for unit testing
-module.exports._getDescriptors = getDescriptors;
-module.exports._assembleDescriptors = assembleDescriptors;
+export const _getDescriptors = getDescriptors;
+export const _assembleDescriptors = assembleDescriptors;

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

@@ -1,7 +1,5 @@
-const inquirer = require('inquirer');
-const { pluginIdentifier, flattenPresets } = require('@gasket/resolve');
-const action = require('../action-wrapper');
-const { addPluginsToContext } = require('../utils');
+import inquirer from 'inquirer';
+import action from '../action-wrapper.js';
 
 /**
  * What is your app description?
@@ -70,22 +68,12 @@ async function choosePackageManager(context, prompt) {
  * @returns {Promise} promise
  */
 async function chooseTestPlugin(context, prompt) {
-  // Combine user-provided plugins with preset-provided plugins.
-  const { presetInfos = [], plugins = [] } = context;
-
-  // Flatten all plugins from presets and concat short names with cli plugins
-  const allPlugins = flattenPresets(presetInfos)
-    .map((presetInfo) => presetInfo.plugins || [])
-    .reduce((acc, arr) => acc.concat(arr), [])
-    .map((pluginInfo) => pluginIdentifier(pluginInfo.name).shortName)
-    .concat(plugins);
-
-  const knownTestPlugins = { mocha: '@gasket/mocha', jest: '@gasket/jest', cypress: '@gasket/cypress' };
+  const knownTestPlugins = { mocha: '@gasket/plugin-mocha', jest: '@gasket/plugin-jest', cypress: '@gasket/plugin-cypress' };
 
   if (!('testPlugin' in context)) {
-    let testPlugin = Object.values(knownTestPlugins).find((p) => allPlugins.includes(p));
+    let testPlugin;
 
-    if ('testSuite' in  context) {
+    if ('testSuite' in context) {
       testPlugin = knownTestPlugins[context.testSuite];
     }
 
@@ -97,16 +85,15 @@ async function chooseTestPlugin(context, prompt) {
           type: 'list',
           choices: [
             { name: 'none (not recommended)', value: 'none' },
-            { name: 'mocha + nyc + sinon + chai', value: '@gasket/mocha' },
-            { name: 'jest', value: '@gasket/jest' },
-            { name: 'cypress', value: '@gasket/cypress' }
+            { name: 'mocha + nyc + sinon + chai', value: '@gasket/plugin-mocha' },
+            { name: 'jest', value: '@gasket/plugin-jest' },
+            { name: 'cypress', value: '@gasket/plugin-cypress' }
           ]
         }
       ]));
     }
 
     if (testPlugin && testPlugin !== 'none') {
-      addPluginsToContext([testPlugin], context);
       Object.assign(context, { testPlugin });
     }
   }
@@ -136,7 +123,7 @@ async function allowExtantOverwriting(context, prompt) {
   }
 }
 
-const questions = [
+export const questions = [
   chooseAppDescription,
   choosePackageManager,
   chooseTestPlugin,
@@ -149,13 +136,11 @@ 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);
   }
 }
 
-module.exports = action('Global prompts', globalPrompts, { startSpinner: false });
-
-module.exports.questions = questions;
+export default action('Global prompts', globalPrompts, { startSpinner: false });

package/lib/scaffold/actions/index.js

@@ -1,36 +1,33 @@
+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';
 
-const mkDir = require('./mkdir');
-const loadPreset = require('./load-preset');
-const cliVersion = require('./cli-version');
-const globalPrompts = require('./global-prompts');
-const setupPkg = require('./setup-pkg');
-const writePkg = require('./write-pkg');
-const installModules = require('./install-modules');
-const linkModules = require('./link-modules');
-const writeGasketConfig = require('./write-gasket-config');
-const loadPkgForDebug = require('./load-pkg-for-debug');
-const promptHooks = require('./prompt-hooks');
-const createHooks = require('./create-hooks');
-const generateFiles = require('./generate-files');
-const postCreateHooks = require('./post-create-hooks');
-const applyPresetConfig = require('./apply-preset-config');
-const printReport = require('./print-report');
-
-module.exports = {
+export {
   mkDir,
   loadPreset,
-  cliVersion,
   globalPrompts,
   setupPkg,
   writePkg,
   installModules,
   linkModules,
   writeGasketConfig,
-  loadPkgForDebug,
+  presetPromptHooks,
+  presetConfigHooks,
   promptHooks,
   createHooks,
   postCreateHooks,
   generateFiles,
-  applyPresetConfig,
   printReport
 };