create-gasket-app 7.3.0-canary.3 → 7.3.0

package/README.md

@@ -1,6 +1,6 @@
 # create-gasket-app
 
-Starter Pack for creating Gasket apps. 
+Starter Pack for creating Gasket apps.
 
 ### Get Started Immediately
 
@@ -43,9 +43,6 @@ Options:
   -p, --presets [presets]              Initial Gasket preset(s) to use.
         Can be set as short name with version (e.g. --presets nextjs@^1.0.0)
         Or other (multiple) custom presets (e.g. --presets my-gasket-preset@1.0.0.beta-1,nextjs@^1.0.0)
-  --plugins [plugins]                  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
   --package-manager [package-manager]  Selects which package manager you would like to use during
         installation. (e.g. --package-manager yarn)
   -r, --require [require]              Require module(s) before Gasket is initialized
@@ -84,7 +81,6 @@ Additional code style choices are prompted during the create command. Some
 predefined choices are provided from the [lint plugin], or you can specify your
 own config.
 
-
 ## Lifecycles
 
 Lifecycles for apps are enabled by plugins, however the CLI has some built-in
@@ -100,38 +96,36 @@ The `prompt` lifecycle is fired using [execWaterfall] and hooks should return a
 modified `context` object.
 
 ```js
-module.exports = {
-  id: 'gasket-plugin-pizza',
-  hooks: {
-    async prompt(gasket, context, { prompt, addPlugins }) {
-      const answers = await prompt([
-        {
-          name: 'pizzaSize',
-          message: 'Choose a pizza size:',
-          type: 'list',
-          choices: ['small', 'medium', 'large']
-        },
-        {
-          name: 'pizzaSauce',
-          message: 'Choose a pizza sauce:',
-          type: 'list',
-          choices: ['red', 'white']
-        },
-        {
-          name: 'wantSoda',
-          message: 'Do you want a soda?',
-          type: 'confirm'
-        }
-      ]);
-
-      if (answers.wantSoda === true) {
-        await addPlugins('gasket-plugin-soda@^2.0.0')
+//  gasket-plugin-pizza.js
+
+const name = 'gasket-plugin-pizza';
+const hooks = {
+  async prompt(gasket, context, { prompt }) {
+    const answers = await prompt([
+      {
+        name: 'pizzaSize',
+        message: 'Choose a pizza size:',
+        type: 'list',
+        choices: ['small', 'medium', 'large']
+      },
+      {
+        name: 'pizzaSauce',
+        message: 'Choose a pizza sauce:',
+        type: 'list',
+        choices: ['red', 'white']
+      },
+      {
+        name: 'wantSoda',
+        message: 'Do you want a soda?',
+        type: 'confirm'
       }
+    ]);
 
-      return { ...context, ...answers };
-    }
+    return { ...context, ...answers };
   }
 };
+
+export default { name, hooks };
 ```
 
 The hook is passed the following parameters:
@@ -156,29 +150,31 @@ package.json or register files and templates to be generated.
 The `create` lifecycle is fired using [exec].
 
 ```js
-const path = require('path');
+//  gasket-plugin-pizza.js
 
-module.exports = {
-  id: 'gasket-plugin-pizza',
-  hooks: {
-    async create(gasket, context) {
-      const { pkg, files } = context; // utils from context
-      const { pizzaSize, pizzaSauce } = context; // data provided by prompt
+import path from 'path';
 
-      files.add(
-        path.join(__dirname, 'generator', 'ingredients', pizzaSauce)
-      );
+const name = 'gasket-plugin-pizza';
+const hooks = {
+  async create(gasket, context) {
+    const { pkg, files } = context; // utils from context
+    const { pizzaSize, pizzaSauce } = context; // data provided by prompt
 
-      pkg.add('devDependencies', {
-        'pizza-oven': '^1.0.0'
-      });
+    files.add(
+      path.join(__dirname, 'generator', 'ingredients', pizzaSauce)
+    );
 
-      pkg.add('scripts', {
-        bake: `pizza-oven --size ${ pizzaSize }`
-      });
-    }
+    pkg.add('devDependencies', {
+      'pizza-oven': '^1.0.0'
+    });
+
+    pkg.add('scripts', {
+      bake: `pizza-oven --size ${ pizzaSize }`
+    });
   }
 };
+
+export default { name, hooks };
 ```
 
 The hook is passed the following parameters:
@@ -189,7 +185,7 @@ The hook is passed the following parameters:
 | `context`              | The CreateContext with data from flags, prompts, etc |
 | `context.pkg`          | Commonly used in create to add to package.json       |
 | `context.file`         | Commonly used to add files and templates for the app |
-| `context.gasketConfig` | Used to add config to the generated gasket.config.js |
+| `context.gasketConfig` | Used to add config to the generated gasket.js |
 | `context.messages`     | non-error/warning messages to report                 |
 | `context.warnings`     | warnings messages to report                          |
 | `context.errors`       | error messages to report but do not exit process     |
@@ -206,9 +202,10 @@ generated. This is useful to use in conjunction with any scripts added in the
 The `postCreate` lifecycle is fired by [exec]:
 
 ```js
-module.exports = {
-  id: 'totally-a-good-idea',
-  hooks: {
+// totally-a-good-idea.js
+
+const name = 'totally-a-good-idea';
+const hooks = {
     async create(gasket, context) {
       const { pkg } = context;
 
@@ -221,6 +218,8 @@ module.exports = {
     }
   }
 };
+
+export default { name, hooks };
 ```
 
 The hook is passed the following parameters:
@@ -232,7 +231,6 @@ The hook is passed the following parameters:
 | `utils`           | Functions that aid in post create hooks                                                                |
 | `utils.runScript` | run an `npm` script at the root of the generated `npm` package                                         |
 
-
 ## License
 
 [MIT](./LICENSE.md)
@@ -245,7 +243,7 @@ The hook is passed the following parameters:
 [yarn env vars]:https://yarnpkg.com/en/docs/envvars#toc-npm-config
 [Jest plugin]:/packages/gasket-plugin-jest/README.md
 [Mocha plugin]:/packages/gasket-plugin-mocha/README.md
-[execWaterfall]:/packages/gasket-engine/README.md#execwaterfallevent-value-args
-[exec]:/packages/gasket-engine/README.md#execevent-args
+[execWaterfall]:/packages/gasket-core/docs/gasket-engine.md#execwaterfallevent-value-args
+[exec]:/packages/gasket-core/docs/gasket-engine.md#execevent-args
 [inquirer questions]:https://github.com/SBoudrias/Inquirer.js#question
 [lint plugin]:/packages/gasket-plugin-lint/README.md

package/lib/commands/create.js

@@ -4,30 +4,25 @@ 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,
-  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
- *
- * @param {String} input - option argument
- * @returns {String[]} results
+ * @type {import('../internal').commasToArray}
  */
 const commasToArray = input => input.split(',').map(name => name.trim());
 
@@ -53,7 +48,7 @@ const createCommand = {
     {
       name: 'package-manager',
       description: `Selects which package manager you would like to use during
-      installation. (e.g. --package-manager yarn)`
+      installation. (e.g. --package-manager pnpm)`
     },
     {
       name: 'require',
@@ -97,12 +92,10 @@ const createCommand = {
 
 /**
  * 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
+ * @type {import('../index').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;
@@ -123,7 +116,7 @@ createCommand.action = async function run(appname, options, command) {
 
     const pluginGasket = makeGasket({
       ...context.presetConfig,
-      plugins: context.presets.concat(context.presetConfig.plugins, defaultPlugins)
+      plugins: context.presetConfig.plugins.concat(context.presets)
     });
 
     await promptHooks({ gasket: pluginGasket, context });
@@ -139,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;