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

package/lib/commands/create.js

@@ -1,4 +1,4 @@
-/* eslint-disable max-statements */
+/* 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';
@@ -87,28 +87,38 @@ const createCommand = {
       conflicts: ['config']
     },
     {
-      name: 'prompts',
+      name: 'no-prompts',
       description: '(INTERNAL) Disable to skip the prompts',
-      default: true,
       type: 'boolean',
       hidden: true
     }
   ]
 };
 
+/**
+ * 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 context = makeCreateContext([appname], options);
+  const { rawPresets, localPresets } = context;
 
   try {
-    await loadPreset(null, context);
     await globalPrompts(null, context);
 
-    const presetGasket = makeGasket({
-      plugins: context.presets
-    });
+    if (rawPresets.length || localPresets.length) {
+      await loadPreset(null, context);
 
-    await presetPromptHooks(presetGasket, context);
-    await presetConfigHooks(presetGasket, context);
+      const presetGasket = makeGasket({
+        plugins: context.presets
+      });
+
+      await presetPromptHooks(presetGasket, context);
+      await presetConfigHooks(presetGasket, context);
+    }
 
     const pluginGasket = makeGasket({
       ...context.presetConfig,
@@ -125,13 +135,13 @@ createCommand.action = async function run(appname, options, command) {
     await installModules(null, context);
     await linkModules(null, context);
     await postCreateHooks(pluginGasket, context);
-    await rm(context.tmpDir, { recursive: true });
-    printReport(context);
+    if (context.tmpDir) await rm(context.tmpDir, { recursive: true });
+    printReport(null, context);
   } catch (err) {
     console.error(chalk.red('Exiting with errors.'));
     dumpErrorContext(context, err);
     throw err;
   }
-}
+};
 
 export { createCommand };

package/lib/config/utils.js

@@ -1,6 +1,4 @@
 import { default as diagnostics } from 'diagnostics';
-import { pluginIdentifier } from '@gasket/resolve';
-import { defaultPlugins } from './default-plugins.js';
 const debug = diagnostics('gasket:cli:config:utils');
 
 /**
@@ -32,28 +30,3 @@ export function getEnvironment(options, commandId, warn) {
   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

@@ -63,11 +63,71 @@ export interface ConfigBuilder<Config> {
     options?: { force?: boolean }
   ): void;
 
-  // TODO Document
+  /**
+   * 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(importName: string, importPath: string, isDefault?: boolean): ConfigBuilder;
-  useImport(configPath: string, importName: 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;
+
+  /**
+   * 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;
+
+  /**
+   * 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: any): void;
 }
 
 export interface PackageJsonBuilder extends ConfigBuilder<PackageJson> {
@@ -107,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>;
 
@@ -131,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<any>;
+
+  /** Default to object w/empty plugins array to be populated by `presetConfig` hook */
+  presetConfig: GasketConfigDefinition;
+
   // Added by `global-prompts`
 
   /** Description of app */
@@ -154,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 */
@@ -192,11 +235,12 @@ export interface CreateContext {
 
 declare module '@gasket/engine' {
   export interface HookExecTypes {
+    presetPrompt(context: CreateContext): Promise<void>;
+    presetConfig(context: CreateContext): Promise<void>;
     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

@@ -19,7 +19,7 @@ const gasketBin = program
 
 async function main() {
   const { command, hidden, isDefault } = processCommand(createCommand);
-  // await warnIfOutdated(pkg.name, pkg.version);
+  await warnIfOutdated(pkg.name, pkg.version);
   gasketBin.addCommand(command, { hidden, isDefault });
 
   process.argv.splice(2, 0, 'create');

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

@@ -32,4 +32,4 @@ export default function withSpinner(label, fn, { startSpinner = true } = {}) {
 
   wrapper.wrapped = fn;
   return wrapper;
-};
+}

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

@@ -1,4 +1,3 @@
-import { createEngine } from '../create-engine.js';
 import action from '../action-wrapper.js';
 import { ConfigBuilder } from '../config-builder.js';
 import { Files } from '../files.js';
@@ -11,7 +10,7 @@ import { Files } from '../files.js';
  * @returns {Promise} promise
  */
 async function createHooks(gasket, context) {
-  const { dest, presets = [], plugins = [], warnings } = context;
+  const { plugins = [], warnings } = context;
 
   const files = new Files();
   const gasketConfig = ConfigBuilder.create({}, { orderBy: ['plugins'], warnings, plugins });

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

@@ -10,7 +10,7 @@ const { dim } = chalk;
 import action from '../action-wrapper.js';
 import * as syncGlob from 'glob';
 const glob = promisify(syncGlob.default);
-
+// TODOfollowup - look at deps
 const flatten = (acc, values) => (acc || []).concat(values);
 const reSep = /[/\\]+/;
 const joinSep = pthArr => pthArr.join(path.sep);
@@ -164,7 +164,7 @@ async function performGenerate(context, descriptors) {
  * @param {Spinner} spinner - Spinner
  * @returns {Promise} promise
  */
-async function generateFiles(gasket, context, spinner) {
+async function generateFiles(_, context, spinner) {
   const { files } = context;
 
   if (!files.globSets.length) {

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

@@ -1,9 +1,6 @@
 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?
  *
@@ -71,20 +68,9 @@ 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/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) {
@@ -108,7 +94,6 @@ async function chooseTestPlugin(context, prompt) {
     }
 
     if (testPlugin && testPlugin !== 'none') {
-      // addPluginsToContext([testPlugin], context);
       Object.assign(context, { testPlugin });
     }
   }
@@ -151,7 +136,7 @@ export const questions = [
  * @param {CreateContext} context - Create context
  * @returns {Promise} promise
  */
-async function globalPrompts(gasket, context) {
+async function globalPrompts(_, context) {
   const prompt = context.prompts ? inquirer.prompt : () => ({});
   for (var fn of questions) {
     await fn(context, prompt);

package/lib/scaffold/actions/index.js

@@ -1,42 +1,33 @@
 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 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 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';
 
 export {
   mkDir,
   loadPreset,
-  cliVersion,
   globalPrompts,
   setupPkg,
   writePkg,
-  writePkgUpdate,
   installModules,
-  installModulesUpdate,
   linkModules,
-  linkModulesUpdate,
   writeGasketConfig,
-  loadPkgForDebug,
   presetPromptHooks,
   presetConfigHooks,
   promptHooks,
   createHooks,
   postCreateHooks,
   generateFiles,
-  applyPresetConfig,
   printReport
 };

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

@@ -6,13 +6,10 @@ import action from '../action-wrapper.js';
  * @param {CreateContext} context - Create context
  * @returns {Promise} promise
  */
-async function installModules(gasket, context) {
+async function installModules(_, context) {
   const { pkgManager } = context;
 
   await pkgManager.install();
 }
 
-
 export default action('Install node modules', installModules);
-
-export const installModulesUpdate = action('Update node modules', installModules);

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(gasket, context, spinner) {
+async function linkModules(_, context, spinner) {
   const { pkgLinks, pkgManager } = context;
 
   if (pkgLinks && pkgLinks.length) {
@@ -17,5 +17,3 @@ async function linkModules(gasket, context, spinner) {
 }
 
 export default action('Link node modules', linkModules, { startSpinner: false });
-
-export const linkModulesUpdate = action('Relink node modules', linkModules, { startSpinner: false });

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

@@ -6,27 +6,35 @@ import { mkdtemp } from 'fs/promises';
 import { createRequire } from 'module';
 const require = createRequire(import.meta.url);
 
-async function loadPresets(gasket, context) {
+/**
+ * loadPresets - Load presets to temp directory
+ * @param {null} _ - no input
+ * @param {CreateContext} context - Create 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 pkgManager = new gasketUtils.PackageManager({
+    packageManager: context.packageManager,
+    dest: tmpDir
+  });
   const pkgVerb = pkgManager.isYarn ? 'add' : 'install';
 
   const remotePresets = context.rawPresets.map(async preset => {
-    const parts = /@([0-9]\.|[0-9]).+/.test(preset) && preset.split('@').filter(Boolean);
+    const parts = /@(\^[0-9]\.|[0-9]).+/.test(preset) && preset.split('@').filter(Boolean);
     const name = parts ? `@${parts[0]}` : preset;
     const version = parts ? `@${parts[1]}` : '@latest';
     await pkgManager.exec(pkgVerb, [`${name}${version}`]);
-    const mod = await import(name, { from: modPath });
+    // eslint-disable-next-line
+    const mod = await import(name);
     return mod.default || mod;
   });
 
   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, { from: modPath });
+    const mod = await import(pkgFile.name);
     return mod.default || mod;
   });
 

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(gasket, 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

@@ -1,5 +1,4 @@
 import action from '../action-wrapper.js';
-import { createEngine } from '../create-engine.js';
 import { runShellCommand } from '@gasket/utils';
 
 /**
@@ -9,7 +8,7 @@ import { runShellCommand } from '@gasket/utils';
  * @returns {Promise} promise
  */
 async function postCreateHooks(gasket, context) {
-  const { dest, presets = [], plugins = [] } = context;
+  const { dest } = context;
 
   /**
    * Run an npm script in the context of the created application

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

@@ -1,12 +1,12 @@
 import action from '../action-wrapper.js';
 
+/**
+ * presetConfigHooks - exec `presetConfig` hook
+ * @param {Gasket} gasket - Preset gasket instance
+ * @param {CreateContext} context - Create context
+ */
 async function presetConfigHooks(gasket, context) {
-  if (!context.presetConig) {
-    context.presetConfig = {};
-  }
-
   const config = await gasket.execWaterfall('presetConfig', context);
-
   Object.assign(context.presetConfig, config);
 }
 

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

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

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

@@ -1,47 +1,5 @@
 import inquirer from 'inquirer';
 import action from '../action-wrapper.js';
-import { addPluginsToContext, addPluginsToPkg, getPluginsWithVersions } from '../utils.js';
-import { createEngine } from '../create-engine.js';
-
-/**
- * Create the `addPlugins` function with context
- *
- * @param {CreateContext} context - Create context
- * @returns {addPlugins} addPlugins
- */
-const createAddPlugins = context => {
-  /**
-   * Allows plugins to add plugins based on user input.
-   *
-   * @typedef {Function} addPlugins
-   *
-   * @param {...PluginDesc} pluginsToAdd - Additional plugins to add
-   * @returns {Promise} promise
-   */
-  return async function addPlugins(...pluginsToAdd) {
-    const { pkg, pkgLinks = [], pkgManager } = context;
-
-    addPluginsToContext(pluginsToAdd, context);
-    const pluginIds = await getPluginsWithVersions(pluginsToAdd, pkgManager);
-    addPluginsToPkg(pluginIds, pkg);
-
-    //
-    // Install new plugins if not already linked
-    //
-    const toInstall = pluginIds.filter(p => !pkgLinks.includes(p.fullName));
-    if (toInstall.length) {
-      await pkgManager.install(toInstall.map(p => p.full));
-      //
-      // relink because npm blows them away on installs...
-      //
-      if (pkgLinks.length) {
-        await pkgManager.link(pkgLinks);
-      }
-    }
-
-    await execPluginPrompts(context, pluginIds.map(p => p.shortName));
-  };
-};
 
 /**
  * Initializes engine with provide preset and plugins
@@ -53,14 +11,12 @@ const createAddPlugins = context => {
  * @returns {Promise} promise
  * @private
  */
-async function execPluginPrompts(gasket, context, plugins = [], presets = []) {
+async function execPluginPrompts(gasket, context) {
   //
   // @see: https://github.com/SBoudrias/Inquirer.js/#inquirercreatepromptmodule---prompt-function
   //
   const prompt = context.prompts ? inquirer.createPromptModule() : () => ({});
-  const addPlugins = createAddPlugins(context);
-
-  const nextContext = await gasket.execWaterfall('prompt', context, { prompt, addPlugins });
+  const nextContext = await gasket.execWaterfall('prompt', context, { prompt });
   //
   // Ensure the original context is transformed in case a prompt returns a new object
   //
@@ -69,7 +25,7 @@ async function execPluginPrompts(gasket, context, plugins = [], presets = []) {
 
 /**
  * Executes the `prompt` hook for all registered plugins.
- * Adds `prompt` and `addPlugins` util functions for prompting features.
+ * Adds `prompt` util function for prompting features.
  *
  * @param {CreateContext} context - Create context
  * @returns {Promise} promise

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

@@ -1,8 +1,6 @@
 import action from '../action-wrapper.js';
 import { ConfigBuilder } from '../config-builder.js';
-import { addPluginsToPkg, getPluginsWithVersions } from '../utils.js';
 import { default as gasketUtils } from '@gasket/utils';
-import { presetIdentifier } from '@gasket/resolve';
 
 /**
  * Initializes the ConfigBuilder builder and adds to context.
@@ -11,9 +9,7 @@ import { presetIdentifier } from '@gasket/resolve';
  * @returns {Promise} promise
  */
 async function setupPkg(gasket, context) {
-  // console.log(context);
-  // throw new Error('Not implemented');
-  const { appName, appDescription, presetInfos = [], rawPlugins = [], cliVersionRequired, warnings } = context;
+  const { appName, appDescription, warnings } = context;
 
   const pkg = ConfigBuilder.createPackageJson({
     name: appName,
@@ -22,23 +18,7 @@ async function setupPkg(gasket, context) {
     type: context.typescript ? 'commonjs' : 'module'
   }, { warnings });
 
-  // The preset package itself must be included in the dependencies
-  // of the `pkg` to be bootstrapped.
-  // pkg.add('dependencies', presetInfos.reduce((acc, presetInfo) => {
-  //   // Use rawName in case version or file path was set in cli args
-  //   // Otherwise fallback to resolved version
-  //   const { fullName, version } = presetIdentifier(presetInfo.rawName).withVersion(`^${presetInfo.version}`);
-
-  //   acc[fullName] = version;
-  //   return acc;
-  // }, {
-  //   // '@gasket/cli': cliVersionRequired
-  // }));
-
   const pkgManager = new gasketUtils.PackageManager(context);
-  const pluginIds = await getPluginsWithVersions(rawPlugins, pkgManager);
-  addPluginsToPkg(pluginIds, pkg);
-
   Object.assign(context, { pkg, pkgManager });
 }