create-gasket-app 7.0.0-next.23 → 7.0.0-next.26

package/lib/commands/create.js

@@ -103,6 +103,7 @@ const createCommand = {
  * @returns {Promise<void>} void
  */
 createCommand.action = async function run(appname, options, command) {
+  process.env.GASKET_ENV = 'create';
   const context = makeCreateContext([appname], options);
   const { rawPresets, localPresets } = context;
 

package/lib/index.d.ts

@@ -9,17 +9,18 @@ export interface Dependencies {
 
 export interface PackageJson extends Dependencies {
   name: string;
-  version: string;
+  version?: string;
   description?: string;
   license?: string;
   repository?:
   | string
   | {
-    type: 'git';
-    url: string;
-  };
+        type: 'git';
+        url: string;
+      };
   scripts?: Record<string, string>;
   optionalDependencies?: Record<string, string>;
+  homepage?: string;
 }
 
 export interface ModuleInfo {
@@ -30,11 +31,9 @@ export interface ModuleInfo {
   version?: string;
 }
 
-export interface PresetInfo extends ModuleInfo {
-}
+export interface PresetInfo extends ModuleInfo {}
 
-export interface PluginInfo extends ModuleInfo {
-}
+export interface PluginInfo extends ModuleInfo {}
 
 export interface ConfigBuilder<Config> {
   /**
@@ -132,16 +131,16 @@ export interface ConfigBuilder<Config> {
 
 export interface PackageJsonBuilder extends ConfigBuilder<PackageJson> {
   /**
-   * Checks if a dependency has been already added
-   * @param  key - Dependency bucket
-   * @param  value - Dependency to search
-   * @returns True if the dependency exists on the bucket
+   * Checks if a property exists on the package.json fields.
+   * @param  key - Field to search
+   * @param  value - Value to search for
+   * @returns True if the property exists and matches the value
    */
-  has(key: keyof Dependencies, value: string): boolean;
+  has(key: keyof PackageJson, value: string): boolean;
 }
 
 export interface Files {
-  add(...args: string[]): void
+  add(...args: string[]): void;
 }
 
 export interface CreateContext {
@@ -199,8 +198,8 @@ export interface CreateContext {
   /** Should a git repo be initialized and first commit */
   gitInit: boolean;
 
-  /** Name of the plugin for unit tests */
-  testPlugin: string;
+  /** Names of the plugins that add unit and integration tests */
+  testPlugins: Array<string>;
 
   /** Which package manager to use (Default: 'npm') */
   packageManager: string;
@@ -246,7 +245,10 @@ declare module '@gasket/core' {
     prompt(
       context: CreateContext,
       utils: {
-        prompt: (prompts: Array<Record<string, any>>) => Promise<Record<string, any>>,
+        prompt: (
+          prompts: Array<Record<string, any>>
+        ) => Promise<Record<string, any>>;
+        addPlugins: (plugins: Array<string>) => Promise<void>;
       }
     ): MaybeAsync<CreateContext>;
 
@@ -255,7 +257,8 @@ declare module '@gasket/core' {
     postCreate(
       context: CreateContext,
       utils: {
-        runScript: (script: string) => Promise<void>
-      }): MaybeAsync<void>;
+        runScript: (script: string) => Promise<void>;
+      }
+    ): MaybeAsync<void>;
   }
 }

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

@@ -61,42 +61,54 @@ async function choosePackageManager(context, prompt) {
 }
 
 /**
- * Choose your unit test suite
+ * Choose your unit test suite and integration test suite
  *
  * @param {CreateContext} context - Create context
  * @param {function} prompt - function to prompt user
  * @returns {Promise} promise
  */
-async function chooseTestPlugin(context, prompt) {
-  const knownTestPlugins = { mocha: '@gasket/plugin-mocha', jest: '@gasket/plugin-jest', cypress: '@gasket/plugin-cypress' };
-
-  if (!('testPlugin' in context)) {
-    let testPlugin;
+async function chooseTestPlugins(context, prompt) {
+  const knownTestPlugins = {
+    unit: { mocha: '@gasket/plugin-mocha', jest: '@gasket/plugin-jest' },
+    integration: { cypress: '@gasket/plugin-cypress' }
+  };
 
-    if ('testSuite' in context) {
-      testPlugin = knownTestPlugins[context.testSuite];
+  const testTypes = ['unit', 'integration'];
+  const testPlugins = [];
+
+  if (!('testPlugins' in context)) {
+    for (const type of testTypes) {
+      if (type + 'TestSuite' in context) {
+        const testSuite = knownTestPlugins[type][context[type + 'TestSuite']];
+        if (testSuite) testPlugins.push(testSuite);
+      } else {
+        const plugin = await promptForTestPlugin(
+          prompt,
+          `Choose your ${type} test suite`,
+          Object.entries(knownTestPlugins[type]).map(([name, value]) => ({ name, value }))
+        );
+
+        if (plugin) testPlugins.push(plugin);
+      }
     }
 
-    if (!testPlugin) {
-      ({ testPlugin } = await prompt([
-        {
-          name: 'testPlugin',
-          message: 'Choose your unit test suite',
-          type: 'list',
-          choices: [
-            { name: 'none (not recommended)', value: 'none' },
-            { name: 'mocha + nyc + sinon + chai', value: '@gasket/plugin-mocha' },
-            { name: 'jest', value: '@gasket/plugin-jest' },
-            { name: 'cypress', value: '@gasket/plugin-cypress' }
-          ]
-        }
-      ]));
+    if (testPlugins.length > 0) {
+      Object.assign(context, { testPlugins });
     }
+  }
+}
 
-    if (testPlugin && testPlugin !== 'none') {
-      Object.assign(context, { testPlugin });
+async function promptForTestPlugin(prompt, message, choices) {
+  const { testPlugin } = await prompt([
+    {
+      name: 'testPlugin',
+      message,
+      type: 'list',
+      choices: [{ name: 'none', value: 'none' }, ...choices]
     }
-  }
+  ]);
+
+  return testPlugin !== 'none' ? testPlugin : null;
 }
 
 /**
@@ -126,7 +138,7 @@ async function allowExtantOverwriting(context, prompt) {
 export const questions = [
   chooseAppDescription,
   choosePackageManager,
-  chooseTestPlugin,
+  chooseTestPlugins,
   allowExtantOverwriting
 ];
 

package/lib/scaffold/create-context.js

@@ -83,7 +83,7 @@ function flatten(acc, values) {
  *
  * @property {String} appDescription - Description of app
  * @property {Boolean} gitInit - Should a git repo be initialized and first commit
- * @property {String} testPlugin - Name of the plugin for unit tests
+ * @property {String} testPlugins - Array of testing plugins
  * @property {String} packageManager - Which package manager to use (Default: 'npm')
  * @property {String} installCmd - Derived install command (Default: 'npm install')
  * @property {String} localCmd - Derived local run command (Default: 'npx gasket local')

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "create-gasket-app",
-  "version": "7.0.0-next.23",
+  "version": "7.0.0-next.26",
   "description": "starter pack for creating a gasket app",
-  "main": "lib",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "bin": {
     "create-gasket-app": "./lib/index.js"
   },
@@ -32,10 +33,10 @@
   },
   "homepage": "https://github.com/godaddy/gasket/tree/main/packages/create-gasket-app",
   "dependencies": {
-    "@gasket/core": "^7.0.0-next.23",
-    "@gasket/plugin-git": "^7.0.0-next.23",
-    "@gasket/plugin-logger": "^7.0.0-next.23",
-    "@gasket/utils": "^7.0.0-next.23",
+    "@gasket/core": "^7.0.0-next.26",
+    "@gasket/plugin-git": "^7.0.0-next.26",
+    "@gasket/plugin-logger": "^7.0.0-next.26",
+    "@gasket/utils": "^7.0.0-next.26",
     "commander": "^12.0.0",
     "deepmerge": "^4.3.1",
     "glob": "^8.1.0",
@@ -54,7 +55,7 @@
     "diagnostics": "^2.0.2",
     "dotenv": "^16.4.5",
     "eslint": "^8.56.0",
-    "eslint-config-godaddy": "^7.0.2",
+    "eslint-config-godaddy": "^7.1.0",
     "eslint-plugin-jest": "^27.6.3",
     "eslint-plugin-json": "^3.1.0",
     "eslint-plugin-unicorn": "^44.0.0",
@@ -78,5 +79,5 @@
   "jest": {
     "transform": {}
   },
-  "gitHead": "0ba753c8764138e300be1c464065280bcc801239"
+  "gitHead": "b885d3f60fc68f944186105b1c4adb6440817581"
 }