create-gasket-app 7.3.11 → 7.4.0

package/lib/commands/create.js

@@ -22,7 +22,7 @@ import printReport from '../scaffold/actions/print-report.js';
 
 /**
  * Parses comma separated option input to array
- * @type {import('../internal').commasToArray}
+ * @type {import('../internal.js').commasToArray}
  */
 const commasToArray = input => input.split(',').map(name => name.trim());
 
@@ -92,7 +92,7 @@ const createCommand = {
 
 /**
  * createCommand action
- * @type {import('../index').createCommandAction}
+ * @type {import('../index.js').createCommandAction}
  */
 createCommand.action = async function run(appname, options, command) {
   // eslint-disable-next-line no-process-env

package/lib/internal.d.ts

@@ -99,7 +99,7 @@ export function chooseTestPlugins(context: PartialCreateContext, prompt: CreateP
 export function promptForTestPlugin(
   prompt: CreatePrompt,
   message: string,
-  choices: { name: string; value: string; }[]
+  isDefault: boolean
 ): Promise<string | null>;
 export function allowExtantOverwriting(context: PartialCreateContext, prompt: CreatePrompt): Promise<void>;
 export function globalPrompts(params: { context: PartialCreateContext }): Promise<void>;

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

@@ -6,7 +6,7 @@ import Readme from '../readme.js';
 /**
  * Executes the `create` hook for all registered plugins.
  * Adds `files` to context for plugins to add their files and templates.
- * @type {import('../../internal').createHooks}
+ * @type {import('../../internal.js').createHooks}
  */
 async function createHooks({ gasket, context }) {
   const { warnings } = context;

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

@@ -20,7 +20,7 @@ const splitSep = pthStr => pthStr.split(reSep);
  * Find all duplicate target files and reduce to single descriptor.
  * Keeps track of overrides.
  * Last in wins.
- * @type {import('../../internal').reduceDescriptors}
+ * @type {import('../../internal.js').reduceDescriptors}
  */
 function reduceDescriptors(descriptors) {
   const reduced = descriptors.reduce((acc, desc) => {
@@ -41,7 +41,7 @@ function reduceDescriptors(descriptors) {
 
 /**
  * Assemble the description objects from glob results
- * @type {import('../../internal').assembleDescriptors}
+ * @type {import('../../internal.js').assembleDescriptors}
  */
 function assembleDescriptors(dest, from, pattern, srcPaths) {
   const output = joinSep(splitSep(dest));
@@ -64,7 +64,7 @@ function assembleDescriptors(dest, from, pattern, srcPaths) {
 
 /**
  * Build a list of descriptions of all files we want to generate
- * @type {import('../../internal').getDescriptors}
+ * @type {import('../../internal.js').getDescriptors}
  */
 async function getDescriptors(context) {
   const { dest, files } = context;
@@ -85,7 +85,7 @@ async function getDescriptors(context) {
 
 /**
  * Read file content, apply templating, then write out target file.
- * @type {import('../../internal').performGenerate}
+ * @type {import('../../internal.js').performGenerate}
  */
 async function performGenerate(context, descriptors) {
   const { warnings, errors, generatedFiles } = context;
@@ -151,7 +151,7 @@ async function performGenerate(context, descriptors) {
 
 /**
  * Generate the app files and templates using context
- * @type {import('../../internal').generateFiles}
+ * @type {import('../../internal.js').generateFiles}
  */
 async function generateFiles({ context, spinner }) {
   const { files } = context;

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

@@ -3,7 +3,7 @@ import { withSpinner } from '../with-spinner.js';
 
 /**
  * What is your app description?
- * @type {import('../../internal').chooseAppDescription}
+ * @type {import('../../internal.js').chooseAppDescription}
  */
 async function chooseAppDescription(context, prompt) {
   if (!('appDescription' in context)) {
@@ -22,7 +22,7 @@ async function chooseAppDescription(context, prompt) {
 
 /**
  * What package manager do you want to use?
- * @type {import('../../internal').choosePackageManager}
+ * @type {import('../../internal.js').choosePackageManager}
  */
 async function choosePackageManager(context, prompt) {
   const packageManager =
@@ -56,13 +56,14 @@ async function choosePackageManager(context, prompt) {
 
 /**
  * Choose your unit test suite and integration test suite
- * @type {import('../../internal').chooseTestPlugins}
+ * @type {import('../../internal.js').chooseTestPlugins}
  */
 async function chooseTestPlugins(context, prompt) {
   const knownTestPlugins = {
     unit: {
       jest: '@gasket/plugin-jest',
-      mocha: '@gasket/plugin-mocha'
+      mocha: '@gasket/plugin-mocha',
+      vitest: '@gasket/plugin-vitest'
     },
     integration: {
       cypress: '@gasket/plugin-cypress'
@@ -72,19 +73,33 @@ async function chooseTestPlugins(context, prompt) {
   const testTypes = ['unit', 'integration'];
   const testPlugins = [];
 
+  const testPromptOptions = {
+    unit: {
+      name: 'Vitest',
+      plugin: '@gasket/plugin-vitest',
+      isDefault: true
+    },
+    integration: {
+      name: 'Cypress',
+      plugin: '@gasket/plugin-cypress',
+      isDefault: false
+    }
+  };
+
   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 { name, isDefault, plugin: testPlugin } = testPromptOptions[type];
         const plugin = await promptForTestPlugin(
           prompt,
-          `Choose your ${type} test suite`,
-          Object.entries(knownTestPlugins[type]).map(([name, value]) => ({ name, value }))
+          `Do you want to use ${name} for ${type} testing?`,
+          isDefault
         );
 
-        if (plugin) testPlugins.push(plugin);
+        if (plugin) testPlugins.push(testPlugin);
       }
     }
 
@@ -96,15 +111,15 @@ async function chooseTestPlugins(context, prompt) {
 
 /**
  *
- * @type {import('../../internal').promptForTestPlugin}
+ * @type {import('../../internal.js').promptForTestPlugin}
  */
-async function promptForTestPlugin(prompt, message, choices) {
+async function promptForTestPlugin(prompt, message, isDefault) {
   const { testPlugin } = await prompt([
     {
       name: 'testPlugin',
       message,
-      type: 'list',
-      choices: [{ name: 'none', value: 'none' }, ...choices]
+      type: 'confirm',
+      default: isDefault
     }
   ]);
 
@@ -114,7 +129,7 @@ async function promptForTestPlugin(prompt, message, choices) {
 /**
  * Given that gasket is creating in an already existing directory, it should
  * confirm with the user that it's intentionally overwriting that directory
- * @type {import('../../internal').allowExtantOverwriting}
+ * @type {import('../../internal.js').allowExtantOverwriting}
  */
 async function allowExtantOverwriting(context, prompt) {
   const { dest, extant } = context;
@@ -141,7 +156,7 @@ export const questions = [
 
 /**
  * Fire off prompts for user input
- * @type {import('../../internal').globalPrompts}
+ * @type {import('../../internal.js').globalPrompts}
  */
 async function globalPrompts({ context }) {
   const prompt = context.prompts ? inquirer.createPromptModule() : () => ({});

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

@@ -2,7 +2,7 @@ import { withSpinner } from '../with-spinner.js';
 
 /**
  * Installs node_modules using the selected package manager
- * @type {import('../../internal').installModules}
+ * @type {import('../../internal.js').installModules}
  */
 async function installModules({ context }) {
   const { pkgManager } = context;

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

@@ -2,7 +2,7 @@ import { withSpinner } from '../with-spinner.js';
 
 /**
  * Links local packages using the selected package manager
- * @type {import('../../internal').linkModules}
+ * @type {import('../../internal.js').linkModules}
  */
 async function linkModules({ context, spinner }) {
   const { pkgLinks, pkgManager } = context;

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

@@ -9,7 +9,7 @@ const hasVersionOrTag = /@([\^~]?\d+\.\d+\.\d+(?:-[\d\w.-]+)?|[\^~]?\d+\.\d+\.\d
 
 /**
  * loadPresets - Load presets to temp directory
- * @type {import('../../internal').loadPresets}
+ * @type {import('../../internal.js').loadPresets}
  */
 async function loadPresets({ context }) {
   const tmpDir = await mkdtemp(path.join(os.tmpdir(), `gasket-create-${context.appName}`));

package/lib/scaffold/actions/mkdir.js

@@ -5,7 +5,7 @@ import { withSpinner } from '../with-spinner.js';
  * Validates this instance can execute without common blockers:
  * - Target destination on disk is available. Validate by acquiring
  * a lock through `mkdir`.
- * @type {import('../../internal').mkDir}
+ * @type {import('../../internal.js').mkDir}
  */
 async function mkDir({ context, spinner }) {
   const { dest, relDest, extant, destOverride } = context;

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

@@ -3,7 +3,7 @@ import { runShellCommand } from '@gasket/utils';
 
 /**
  * Executes the `postCreate` hook for all registered plugins.
- * @type {import('../../internal').postCreateHooks}
+ * @type {import('../../internal.js').postCreateHooks}
  */
 async function postCreateHooks({ gasket, context }) {
   const { dest, packageManager } = context;

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

@@ -2,7 +2,7 @@ import { withGasketSpinner } from '../with-spinner.js';
 
 /**
  * presetConfigHooks - exec `presetConfig` hook
- * @type {import('../../internal').presetConfigHooks}
+ * @type {import('../../internal.js').presetConfigHooks}
  */
 async function presetConfigHooks({ gasket, context }) {
   const config = await gasket.execWaterfall('presetConfig', context);

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

@@ -3,7 +3,7 @@ import { withGasketSpinner } from '../with-spinner.js';
 
 /**
  * presetPromptHooks - exec `presetPrompt` hook
- * @type {import('../../internal').presetPromptHooks}
+ * @type {import('../../internal.js').presetPromptHooks}
  */
 async function presetPromptHooks({ gasket, context }) {
   const prompt = context.prompts ? inquirer.createPromptModule() : () => ({});

package/lib/scaffold/actions/print-report.js

@@ -24,7 +24,7 @@ const toSpaceCase = str => str.replace(/([A-Z])/g, ' $1')
 
 /**
  * Builds the report object from context
- * @type {import('../../internal').buildReport}
+ * @type {import('../../internal.js').buildReport}
  * @private
  */
 function buildReport(context) {
@@ -53,7 +53,7 @@ function buildReport(context) {
 
 /**
  * Outputs create command details to the console
- * @type {import('../../internal').printReport}
+ * @type {import('../../internal.js').printReport}
  */
 async function printReport({ context }) {
   const report = buildReport(context);

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

@@ -4,7 +4,7 @@ import { withGasketSpinner } from '../with-spinner.js';
 /**
  * Initializes engine with provide preset and plugins
  * to execute their prompt lifecycle hooks.
- * @type {import('../../internal').execPluginPrompts}
+ * @type {import('../../internal.js').execPluginPrompts}
  */
 async function execPluginPrompts(gasket, context) {
   //
@@ -21,7 +21,7 @@ async function execPluginPrompts(gasket, context) {
 /**
  * Executes the `prompt` hook for all registered plugins.
  * Adds `prompt` util function for prompting features.
- * @type {import('../../internal').promptHooks}
+ * @type {import('../../internal.js').promptHooks}
  */
 async function promptHooks({ gasket, context }) {
   //

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

@@ -7,7 +7,7 @@ const { dependencies } = require('../../../package.json');
 
 /**
  * Initializes the ConfigBuilder builder and adds to context.
- * @type {import('../../internal').setupPkg}
+ * @type {import('../../internal.js').setupPkg}
  */
 async function setupPkg({ context }) {
   const { appName, appDescription, warnings } = context;

package/lib/scaffold/actions/write-gasket-config.js

@@ -5,7 +5,7 @@ import { withSpinner } from '../with-spinner.js';
 
 /**
  * writePluginImports - Write string imports as value(s)
- * @type {import('../../internal').writePluginImports}
+ * @type {import('../../internal.js').writePluginImports}
  */
 function writePluginImports(plugins) {
   return plugins.reduce((acc, cur, index) => {
@@ -16,7 +16,7 @@ function writePluginImports(plugins) {
 
 /**
  * writeImports - Write imports to file using key value pairs
- * @type {import('../../internal').writeImports}
+ * @type {import('../../internal.js').writeImports}
  */
 function writeImports(imports) {
   if (!imports) return '';
@@ -25,7 +25,7 @@ function writeImports(imports) {
 
 /**
  * createInjectionAssignments - replace object path with a temp string value
- * @type {import('../../internal').createInjectionAssignments}
+ * @type {import('../../internal.js').createInjectionAssignments}
  */
 function createInjectionAssignments(config, assignments) {
   if (!assignments) return '';
@@ -44,7 +44,7 @@ function createInjectionAssignments(config, assignments) {
 
 /**
  * replaceInjectionAssignments - replace temp string value with actual value
- * @type {import('../../internal').replaceInjectionAssignments}
+ * @type {import('../../internal.js').replaceInjectionAssignments}
  */
 function replaceInjectionAssignments(content, assignments) {
   if (!assignments) return content;
@@ -57,7 +57,7 @@ function replaceInjectionAssignments(content, assignments) {
 
 /**
  * writeExpressions - Write expressions to file
- * @type {import('../../internal').writeExpressions}
+ * @type {import('../../internal.js').writeExpressions}
  */
 function writeExpressions(expressions) {
   if (!expressions) return '';
@@ -66,7 +66,7 @@ function writeExpressions(expressions) {
 
 /**
  * cleanupFields - Remove fields from config object
- * @type {import('../../internal').cleanupFields}
+ * @type {import('../../internal.js').cleanupFields}
  */
 function cleanupFields(config) {
   delete config.fields.imports;
@@ -77,7 +77,7 @@ function cleanupFields(config) {
 
 /**
  * Writes the contents of `pkg` to the app's package.json.
- * @type {import('../../internal').writeGasketConfig}
+ * @type {import('../../internal.js').writeGasketConfig}
  */
 async function writeGasketConfig({ context }) {
   const { dest, gasketConfig, generatedFiles, typescript } = context;

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

@@ -4,7 +4,7 @@ import { withSpinner } from '../with-spinner.js';
 
 /**
  * Writes the contents of `pkg` to the app's package.json.
- * @type {import('../../internal').writePkg}
+ * @type {import('../../internal.js').writePkg}
  */
 async function writePkg({ context }) {
   const { dest, pkg, generatedFiles } = context;

package/lib/scaffold/config-builder.js

@@ -52,7 +52,7 @@ function isValidVersion(v) {
 /**
  * ConfigBuilder is an extensible data structure for **specifically**
  * managing `package.json` data.
- * @type {import('../index').ConfigBuilder}
+ * @type {import('../index.js').ConfigBuilder}
  */
 export class ConfigBuilder {
   /**

package/lib/scaffold/create-context.js

@@ -7,7 +7,7 @@ import { readConfig } from '../scaffold/utils.js';
  * The CreateRuntime represents a shallow proxy to a CreateContext
  * that automatically adds transactional information for providing
  * CLI users with blame information in the event of conflicts.
- * @type {import('../internal').makeCreateRuntime}
+ * @type {import('../internal.js').makeCreateRuntime}
  */
 function makeCreateRuntime(context, source) {
   //
@@ -38,6 +38,7 @@ function makeCreateRuntime(context, source) {
     }
   };
 
+  // @ts-ignore - Proxy for CreateContext
   return new Proxy(context, {
     get(obj, key) {
       if (overrides[key]) return overrides[key];
@@ -62,11 +63,12 @@ export class CreateContext {
   }
 
   runWith(plugin) {
+    // @ts-ignore - partial context at this point
     return makeCreateRuntime(this, plugin);
   }
 }
 
-/** @type {import('../internal').makeCreateContext} */
+/** @type {import('../internal.js').makeCreateContext} */
 export function makeCreateContext(argv = [], options = {}) {
   const appName = argv[0] || 'templated-app';
   const {
@@ -92,8 +94,9 @@ export function makeCreateContext(argv = [], options = {}) {
 
   /**
    * Input context which will be appended by prompts and passed to create hooks
-   * @type {import('../internal').PartialCreateContext}
+   * @type {import('../index.js').CreateContext}
    */
+  // @ts-ignore - some properties not defined in constructor will be added later
   const context = new CreateContext({
     destOverride: true,
     cwd,

package/lib/scaffold/dump-error-context.js

@@ -4,7 +4,7 @@ import { writeFile } from 'fs/promises';
 /**
  * If an error occurs during create, dump the context for debugging.
  * The error which cause the exit is also included in the log.
- * @type {import('../internal').dumpErrorContext}
+ * @type {import('../internal.js').dumpErrorContext}
  */
 export async function dumpErrorContext(context, error) {
   const { cwd } = context;

package/lib/scaffold/files.js

@@ -1,6 +1,6 @@
 /**
  * Utility for plugins to add files and templates for generating
- * @type {import('../index').Files}
+ * @type {import('../index.js').Files}
  */
 export class Files {
   constructor() {

package/lib/scaffold/readme.js

@@ -1,6 +1,6 @@
 import { readFile } from 'fs/promises';
 
-/** @type {import('../index').Readme} */
+/** @type {import('../index.js').Readme} */
 export default class Readme {
   constructor() {
     this.markdown = [];

package/lib/scaffold/utils.js

@@ -2,7 +2,7 @@ import path from 'path';
 import { createRequire } from 'module';
 const require = createRequire(import.meta.url);
 
-/** @type {import('../internal').readConfig} */
+/** @type {import('../internal.js').readConfig} */
 export function readConfig(context, { config, configFile }) {
   if (config) {
     const parsedConfig = JSON.parse(config);

package/lib/scaffold/with-spinner.js

@@ -2,10 +2,10 @@ import ora from 'ora';
 
 /**
  * Base function to handle spinner logic
- * @type {import('../internal').wrapWithSpinner}
+ * @type {import('../internal.js').wrapWithSpinner}
  */
 function wrapWithSpinner(label, task, { startSpinner = true } = {}) {
-  /** @type {import('../internal').execute} */
+  /** @type {import('../internal.js').execute} */
   async function execute(context) {
     const spinner = ora(label);
     if (startSpinner) spinner.start();
@@ -27,7 +27,7 @@ function wrapWithSpinner(label, task, { startSpinner = true } = {}) {
 
 /**
  * Wrap a task with a spinner, including gasket and context.
- * @type {import('../internal').withGasketSpinner}
+ * @type {import('../internal.js').withGasketSpinner}
  */
 export function withGasketSpinner(label, task, options) {
   return wrapWithSpinner(label, ({ gasket, context, spinner }) =>
@@ -38,7 +38,7 @@ export function withGasketSpinner(label, task, options) {
 
 /**
  * Wrap a task with a spinner, using only context.
- * @type {import('../internal').withSpinner}
+ * @type {import('../internal.js').withSpinner}
  */
 export function withSpinner(label, task, options) {
   return wrapWithSpinner(label, ({ context, spinner }) =>

package/lib/utils/create-option.js

@@ -2,7 +2,7 @@ import { Option } from 'commander';
 
 /**
  * createOption - Create a commander option
- * @type {import('../internal').createOption}
+ * @type {import('../internal.js').createOption}
  */
 export function createOption(definition) {
   const option = new Option(...definition.options);

package/lib/utils/process-args.js

@@ -1,6 +1,6 @@
 /**
  * isValidArg - Validates the argument configuration
- * @type {import('../internal').isValidArg}
+ * @type {import('../internal.js').isValidArg}
  */
 function isValidArg(arg) {
   const keys = Object.keys(arg);
@@ -12,7 +12,7 @@ function isValidArg(arg) {
 
 /**
  * processArgs - Process the arguments configuration
- * @type {import('../internal').processArgs}
+ * @type {import('../internal.js').processArgs}
  */
 export function processArgs(args) {
   if (!Array.isArray(args) || !args.every(isValidArg)) throw new Error('Invalid argument(s) configuration');

package/lib/utils/process-command.js

@@ -6,7 +6,7 @@ const program = new Command();
 
 /**
  * isValidCommand - Validates the command configuration
- * @type {import('../internal').isValidCommand}
+ * @type {import('../internal.js').isValidCommand}
  */
 function isValidCommand(command) {
   const keys = Object.keys(command);
@@ -21,7 +21,7 @@ function isValidCommand(command) {
 
 /**
  * processCommand - Process the command configuration
- * @type {import('../internal').processCommand}
+ * @type {import('../internal.js').processCommand}
  */
 export function processCommand(command) {
   if (!isValidCommand(command)) throw new Error('Invalid command configuration');

package/lib/utils/process-options.js

@@ -1,6 +1,6 @@
 /**
  * isValidOption - Validate the option
- * @type {import('../internal').isValidOption}
+ * @type {import('../internal.js').isValidOption}
  */
 function isValidOption(option) {
   const keys = Object.keys(option);
@@ -12,7 +12,7 @@ function isValidOption(option) {
 
 /**
  * processOptions - Process the options configuration
- * @type {import('../internal').processOptions}
+ * @type {import('../internal.js').processOptions}
  */
 export function processOptions(options) {
   if (!Array.isArray(options) || !options.every(isValidOption)) throw new Error('Invalid option(s) configuration');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-gasket-app",
-  "version": "7.3.11",
+  "version": "7.4.0",
   "description": "starter pack for creating a gasket app",
   "type": "module",
   "bin": {
@@ -31,16 +31,16 @@
     "mkdirp": "^1.0.4",
     "ora": "^3.4.0",
     "semver": "^7.7.1",
-    "@gasket/core": "7.4.1",
-    "@gasket/plugin-command": "7.3.8",
-    "@gasket/plugin-docs": "7.3.8",
+    "@gasket/core": "7.5.0",
+    "@gasket/plugin-command": "7.4.0",
+    "@gasket/plugin-docs": "7.4.0",
     "@gasket/plugin-docusaurus": "7.4.2",
     "@gasket/plugin-dynamic-plugins": "7.3.7",
-    "@gasket/plugin-git": "7.3.4",
+    "@gasket/plugin-git": "7.4.0",
     "@gasket/plugin-logger": "7.3.4",
-    "@gasket/plugin-metadata": "7.3.11",
-    "@gasket/request": "7.3.5",
-    "@gasket/utils": "7.3.4"
+    "@gasket/plugin-metadata": "7.4.0",
+    "@gasket/request": "7.4.0",
+    "@gasket/utils": "7.4.0"
   },
   "devDependencies": {
     "@jest/globals": "^29.7.0",
@@ -56,7 +56,7 @@
     "eslint-plugin-unicorn": "^55.0.0",
     "jest": "^29.7.0",
     "typescript": "^5.8.2",
-    "@gasket/request": "7.3.5"
+    "@gasket/request": "7.4.0"
   },
   "eslintConfig": {
     "extends": [
@@ -94,7 +94,7 @@
   "scripts": {
     "lint": "eslint .",
     "lint:fix": "pnpm run lint --fix",
-    "posttest": "pnpm run lint",
+    "posttest": "pnpm run lint && pnpm run typecheck",
     "test": "cross-env NODE_OPTIONS='--unhandled-rejections=strict --experimental-vm-modules' jest",
     "test:coverage": "jest --coverage",
     "test:watch": "pnpm run test --watch",