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

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,
+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
@@ -114,79 +96,42 @@ const createCommand = {
   ]
 };
 
-/**
- * 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
- * @param {object} options cmd options
- * @param {Command} command - the command instance
- * @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);
 
-  let context;
   try {
-    context = makeCreateContext(argv, options);
-  } catch (error) {
-    console.error(chalk.red(error) + '\n');
-    command.help();
-  }
+    await loadPreset(null, context);
+    await globalPrompts(null, context);
 
-  try {
-    if (bootstrap) {
-      await bootstrapHandler(context);
-    } else {
-      ora('Bootstrap phase skipped.').warn();
-      if (generate) {
-        await loadPkgForDebug(context);
-      }
-    }
+    const presetGasket = makeGasket({
+      plugins: context.presets
+    });
 
-    if (generate) {
-      await generateHandler(context);
-    } else {
-      ora('Generate phase skipped.').warn();
-    }
+    await presetPromptHooks(presetGasket, context);
+    await presetConfigHooks(presetGasket, context);
 
-    printReport(context);
+    const pluginGasket = makeGasket({
+      ...context.presetConfig,
+      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 rm(context.tmpDir, { recursive: true });
+    printReport(context);
   } catch (err) {
     console.error(chalk.red('Exiting with errors.'));
     dumpErrorContext(context, err);
     throw err;
   }
-};
+}
 
-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/config/utils.js

@@ -0,0 +1,59 @@
+import { default as diagnostics } from 'diagnostics';
+import { pluginIdentifier } from '@gasket/resolve';
+import { defaultPlugins } from './default-plugins.js';
+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';
+}
+
+/**
+ * Inject the default plugins into the loaded config
+ *
+ * @param {Object} gasketConfig - Gasket config
+ * @returns {Object} updated config
+ */
+export function addDefaultPlugins(gasketConfig) {
+  const pluginsConfig = gasketConfig.plugins || {};
+  const { add = [], remove = [] } = pluginsConfig;
+  const filteredNames = new Set(
+    add.concat(remove).map(p => {
+      const name = typeof p === 'string' ? p : p.name;
+      return pluginIdentifier(name).fullName;
+    })
+  );
+  const pluginsToAdd = defaultPlugins.filter(p => !filteredNames.has(pluginIdentifier(p.name).fullName));
+  return {
+    ...gasketConfig,
+    plugins: {
+      ...pluginsConfig,
+      add: (add).concat(pluginsToAdd)
+    }
+  };
+}

package/lib/index.d.ts

@@ -62,6 +62,12 @@ export interface ConfigBuilder<Config> {
     value: Config[Key],
     options?: { force?: boolean }
   ): void;
+
+  // TODO Document
+  addPlugin(pluginImport: string, pluginName: string): void;
+  addImport(importName: string, importPath: string, isDefault?: boolean): ConfigBuilder;
+  useImport(configPath: string, importName: string): void;
+
 }
 
 export interface PackageJsonBuilder extends ConfigBuilder<PackageJson> {

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,8 +18,8 @@ const gasketBin = program
 
 
 async function main() {
-  const { command, hidden, isDefault } = processCommand(CreateCommand);
-  await warnIfOutdated(pkg.name, pkg.version);
+  const { command, hidden, isDefault } = processCommand(createCommand);
+  // await warnIfOutdated(pkg.name, pkg.version);
   gasketBin.addCommand(command, { hidden, isDefault });
 
   process.argv.splice(2, 0, 'create');

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,18 @@ 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
    * @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();

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

@@ -1,5 +1,5 @@
-const { flattenPresets } = require('@gasket/resolve');
-const action = require('../action-wrapper');
+import { flattenPresets } from '@gasket/resolve';
+import action from '../action-wrapper.js';
 
 /**
  * Extracts predefined createContext from presets and applies to context.
@@ -26,4 +26,4 @@ function applyPresetConfig(context) {
   Object.assign(context, presetContext);
 }
 
-module.exports = action('Apply preset context', applyPresetConfig, { startSpinner: false });
+export default action('Apply preset context', applyPresetConfig, { startSpinner: false });

package/lib/scaffold/actions/cli-version.js

@@ -1,7 +1,11 @@
-const semver = require('semver');
-const { flattenPresets } = require('@gasket/resolve');
-const action = require('../action-wrapper');
-const pkgVersion = require('../../../package.json').version;
+import semver from 'semver';
+import { flattenPresets } from '@gasket/resolve';
+import action from '../action-wrapper.js';
+import { createRequire } from 'node:module';
+const require = createRequire(import.meta.url);
+const pkg = require('../../../package.json');
+
+const pkgVersion = pkg.version;
 const pkgVersionCompatible = `^${pkgVersion}`;
 
 /**
@@ -81,4 +85,4 @@ function resolveCliVersion(context, spinner) {
   });
 }
 
-module.exports = action('Resolve CLI versions', resolveCliVersion, { startSpinner: false });
+export default action('Resolve CLI versions', resolveCliVersion, { startSpinner: false });

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

@@ -1,7 +1,7 @@
-const createEngine = require('../create-engine');
-const action = require('../action-wrapper');
-const ConfigBuilder = require('../config-builder');
-const Files = require('../files');
+import { createEngine } from '../create-engine.js';
+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.
@@ -10,17 +10,16 @@ const Files = require('../files');
  * @param {CreateContext} context - Create context
  * @returns {Promise} promise
  */
-async function createHooks(context) {
+async function createHooks(gasket, context) {
   const { dest, presets = [], 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(gasket, 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,8 @@
-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';
+
+import { pluginIdentifier, flattenPresets } from '@gasket/resolve';
+import { addPluginsToContext } from '../utils.js';
 
 /**
  * What is your app description?
@@ -74,16 +75,17 @@ async function chooseTestPlugin(context, prompt) {
   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 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 = Object.values(knownTestPlugins).find((p) => allPlugins.includes(p));
+    let testPlugin;
 
     if ('testSuite' in  context) {
       testPlugin = knownTestPlugins[context.testSuite];
@@ -97,16 +99,16 @@ 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);
+      // addPluginsToContext([testPlugin], context);
       Object.assign(context, { testPlugin });
     }
   }
@@ -136,7 +138,7 @@ async function allowExtantOverwriting(context, prompt) {
   }
 }
 
-const questions = [
+export const questions = [
   chooseAppDescription,
   choosePackageManager,
   chooseTestPlugin,
@@ -149,13 +151,11 @@ const questions = [
  * @param {CreateContext} context - Create context
  * @returns {Promise} promise
  */
-async function globalPrompts(context) {
+async function globalPrompts(gasket, 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,32 +1,38 @@
+import mkDir from './mkdir.js';
+import loadPreset from './load-preset.js';
+import cliVersion from './cli-version.js';
+import globalPrompts from './global-prompts.js';
+import setupPkg from './setup-pkg.js';
+import writePkg, { writePkgUpdate } from './write-pkg.js';
+import installModules, { installModulesUpdate } from './install-modules.js';
+import linkModules, { linkModulesUpdate } from './link-modules.js';
+import writeGasketConfig from './write-gasket-config.js';
+import loadPkgForDebug from './load-pkg-for-debug.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 applyPresetConfig from './apply-preset-config.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,
+  writePkgUpdate,
   installModules,
+  installModulesUpdate,
   linkModules,
+  linkModulesUpdate,
   writeGasketConfig,
   loadPkgForDebug,
+  presetPromptHooks,
+  presetConfigHooks,
   promptHooks,
   createHooks,
   postCreateHooks,

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

@@ -1,4 +1,4 @@
-const action = require('../action-wrapper');
+import action from '../action-wrapper.js';
 
 /**
  * Installs node_modules using the selected package manager
@@ -6,13 +6,13 @@ const action = require('../action-wrapper');
  * @param {CreateContext} context - Create context
  * @returns {Promise} promise
  */
-async function installModules(context) {
+async function installModules(gasket, context) {
   const { pkgManager } = context;
 
   await pkgManager.install();
 }
 
 
-module.exports = action('Install node modules', installModules);
+export default action('Install node modules', installModules);
 
-module.exports.update = action('Update node modules', installModules);
+export const installModulesUpdate = action('Update node modules', installModules);

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

@@ -1,4 +1,4 @@
-const action = require('../action-wrapper');
+import action from '../action-wrapper.js';
 
 /**
  * Links local packages using the selected package manager
@@ -7,7 +7,7 @@ const action = require('../action-wrapper');
  * @param {Spinner} spinner - Spinner
  * @returns {Promise} promise
  */
-async function linkModules(context, spinner) {
+async function linkModules(gasket, context, spinner) {
   const { pkgLinks, pkgManager } = context;
 
   if (pkgLinks && pkgLinks.length) {
@@ -16,6 +16,6 @@ async function linkModules(context, spinner) {
   }
 }
 
-module.exports = action('Link node modules', linkModules, { startSpinner: false });
+export default action('Link node modules', linkModules, { startSpinner: false });
 
-module.exports.update = action('Relink node modules', linkModules, { startSpinner: false });
+export const linkModulesUpdate = action('Relink node modules', linkModules, { startSpinner: false });

package/lib/scaffold/actions/load-pkg-for-debug.js

@@ -1,7 +1,7 @@
-const path = require('path');
-const fs = require('fs').promises;
-const action = require('../action-wrapper');
-const ConfigBuilder = require('../config-builder');
+import path from 'path';
+import fs from 'fs/promises';
+import action from '../action-wrapper.js';
+import { ConfigBuilder } from '../config-builder.js';
 
 /**
  * Debug-only load existing app package.json for context.pkg
@@ -21,4 +21,4 @@ async function loadPkForDebug(context) {
   Object.assign(context, { pkg });
 }
 
-module.exports = action('Load package.json for debug. 🐲 Here be dragons!', loadPkForDebug);
+export default action('Load package.json for debug. 🐲 Here be dragons!', loadPkForDebug);