create-gasket-app 7.0.4 → 7.0.9

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

@@ -2,10 +2,7 @@ import action from '../action-wrapper.js';
 
 /**
  * Links local packages using the selected package manager
- *
- * @param {CreateContext} context - Create context
- * @param {Spinner} spinner - Spinner
- * @returns {Promise} promise
+ * @type {import('../../internal').linkModules}
  */
 async function linkModules({ context, spinner }) {
   const { pkgLinks, pkgManager } = context;

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

@@ -1,7 +1,7 @@
 import path from 'path';
 import os from 'os';
 import action from '../action-wrapper.js';
-import { default as gasketUtils } from '@gasket/utils';
+import { PackageManager } from '@gasket/utils';
 import { mkdtemp } from 'fs/promises';
 import { createRequire } from 'module';
 const require = createRequire(import.meta.url);
@@ -9,14 +9,14 @@ const hasVersionOrTag = /@([\^~]?\d+\.\d+\.\d+(?:-[\d\w.-]+)?|[\^~]?\d+\.\d+\.\d
 
 /**
  * loadPresets - Load presets to temp directory
- * @param {CreateContext} context - Create context
+ * @type {import('../../internal').loadPresets}
  */
 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({
+  const pkgManager = new PackageManager({
     packageManager: context.packageManager,
     dest: tmpDir
   });

package/lib/scaffold/actions/mkdir.js

@@ -3,12 +3,9 @@ import action from '../action-wrapper.js';
 
 /**
  * Validates this instance can execute without common blockers:
- *   - Target destination on disk is available. Validate by acquiring
- *     a lock through `mkdir`.
- *
- * @param {CreateContext} context - Create context
- * @param {Spinner} spinner - Spinner
- * @returns {Promise} promise
+ * - Target destination on disk is available. Validate by acquiring
+ * a lock through `mkdir`.
+ * @type {import('../../internal').mkDir}
  */
 async function mkDir({ context, spinner }) {
   const { dest, relDest, extant, destOverride } = context;

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

@@ -3,17 +3,14 @@ import { runShellCommand } from '@gasket/utils';
 
 /**
  * Executes the `postCreate` hook for all registered plugins.
- *
- * @param {GasketEngine} gasket - Gasket API
- * @param {CreateContext} context - Create context
- * @returns {Promise} promise
+ * @type {import('../../internal').postCreateHooks}
  */
 async function postCreateHooks({ gasket, context }) {
   const { dest } = context;
 
   /**
    * Run an npm script in the context of the created application
-   * @param  {String} script name of script
+   * @param  {string} script name of script
    * @returns {Promise} A promise represents if npm succeeds or fails.
    */
   async function runScript(script) {

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

@@ -2,8 +2,7 @@ import action from '../action-wrapper.js';
 
 /**
  * presetConfigHooks - exec `presetConfig` hook
- * @param {Gasket} gasket - Preset gasket instance
- * @param {CreateContext} context - Create context
+ * @type {import('../../internal').presetConfigHooks}
  */
 async function presetConfigHooks({ gasket, context }) {
   const config = await gasket.execWaterfall('presetConfig', context);

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

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

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

@@ -13,8 +13,7 @@ const newline = () => {
 
 /**
  * Converts a camelCase string to Space Case
- * @see: https://stackoverflow.com/questions/4149276/javascript-camelcase-to-regular-form?answertab=active#tab-top
- *
+ * https://stackoverflow.com/questions/4149276/javascript-camelcase-to-regular-form?answertab=active#tab-top
  * @param {string} str - camelCase string to fixup
  * @returns {string} result
  * @private
@@ -24,17 +23,13 @@ const toSpaceCase = str => str.replace(/([A-Z])/g, ' $1')
 
 /**
  * Builds the report object from context
- *
- * @param {CreateContext} context - Create context
- * @returns {Object} report
+ * @type {import('../../internal').buildReport}
  * @private
  */
 function buildReport(context) {
   const {
     appName,
     dest,
-    fullPresets,
-    plugins,
     generatedFiles: generatedFilesSet,
     messages,
     warnings,
@@ -44,12 +39,9 @@ function buildReport(context) {
 
   const generatedFiles = Array.from(generatedFilesSet);
   generatedFiles.sort();
-
   return {
     appName,
     output: dest,
-    presets: fullPresets,
-    plugins,
     generatedFiles,
     messages,
     warnings,
@@ -60,8 +52,7 @@ function buildReport(context) {
 
 /**
  * Outputs create command details to the console
-
- * @param {CreateContext} context - Create context
+ * @type {import('../../internal').printReport}
  */
 async function printReport({ context }) {
   const report = buildReport(context);

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

@@ -4,12 +4,7 @@ import action from '../action-wrapper.js';
 /**
  * Initializes engine with provide preset and plugins
  * to execute their prompt lifecycle hooks.
- *
- * @param {CreateContext} context - Create context
- * @param {String[]} plugins - plugins to load
- * @param {String} [presets] - presets to load
- * @returns {Promise} promise
- * @private
+ * @type {import('../../internal').execPluginPrompts}
  */
 async function execPluginPrompts(gasket, context) {
   //
@@ -26,18 +21,14 @@ async function execPluginPrompts(gasket, context) {
 /**
  * Executes the `prompt` hook for all registered plugins.
  * Adds `prompt` util function for prompting features.
- *
- * @param {GasketEngine} gasket - Gasket API
- * @param {CreateContext} context - Create context
- * @returns {Promise} promise
+ * @type {import('../../internal').promptHooks}
  */
 async function promptHooks({ gasket, context }) {
   //
   // Because `execPluginPrompts` is recursively, we need to start it
   // with the processPlugins and presets from our initial context
   //
-  const { plugins } = context;
-  await execPluginPrompts(gasket, context, plugins);
+  await execPluginPrompts(gasket, context);
 }
 
 export default action('Plugin prompts', promptHooks, { startSpinner: false });

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

@@ -1,15 +1,13 @@
 import action from '../action-wrapper.js';
 import { ConfigBuilder } from '../config-builder.js';
-import { default as gasketUtils } from '@gasket/utils';
+import { PackageManager } from '@gasket/utils';
 import { createRequire } from 'module';
 const require = createRequire(import.meta.url);
 const { dependencies } = require('../../../package.json');
 
 /**
  * Initializes the ConfigBuilder builder and adds to context.
- *
- * @param {CreateContext} context - Create context
- * @returns {Promise} promise
+ * @type {import('../../internal').setupPkg}
  */
 async function setupPkg({ context }) {
   const { appName, appDescription, warnings } = context;
@@ -27,7 +25,7 @@ async function setupPkg({ context }) {
     '@gasket/utils': dependencies['@gasket/utils']
   });
 
-  const pkgManager = new gasketUtils.PackageManager(context);
+  const pkgManager = new PackageManager(context);
   Object.assign(context, { pkg, pkgManager });
 }
 

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

@@ -5,8 +5,7 @@ import action from '../action-wrapper.js';
 
 /**
  * writePluginImports - Write string imports as value(s)
- * @param {string[]} plugins - Array of plugin import names
- * @returns {string} - Array of plugin imports as string
+ * @type {import('../../internal').writePluginImports}
  */
 function writePluginImports(plugins) {
   return plugins.reduce((acc, cur, index) => {
@@ -17,8 +16,7 @@ function writePluginImports(plugins) {
 
 /**
  * writeImports - Write imports to file using key value pairs
- * @param {{[pluginImport: string]: string}[]} imports - Array of key value pairs for imports
- * @returns {string} - import declarations as string
+ * @type {import('../../internal').writeImports}
  */
 function writeImports(imports) {
   if (!imports) return '';
@@ -27,9 +25,7 @@ function writeImports(imports) {
 
 /**
  * createInjectionAssignments - replace object path with a temp string value
- * @param {GasketConfigDefinition} config - gasket config object
- * @param {{ [configKey]: string }} assignments - key value pairs of config keys to replace
- * @returns {string} - string if assignments is falsy
+ * @type {import('../../internal').createInjectionAssignments}
  */
 function createInjectionAssignments(config, assignments) {
   if (!assignments) return '';
@@ -48,9 +44,7 @@ function createInjectionAssignments(config, assignments) {
 
 /**
  * replaceInjectionAssignments - replace temp string value with actual value
- * @param {string} content
- * @param {{ [configKey]: string }} assignments - key value pairs of config keys to replace
- * @returns {string} - content with replaced values
+ * @type {import('../../internal').replaceInjectionAssignments}
  */
 function replaceInjectionAssignments(content, assignments) {
   if (!assignments) return content;
@@ -63,8 +57,7 @@ function replaceInjectionAssignments(content, assignments) {
 
 /**
  * writeExpressions - Write expressions to file
- * @param {string} expressions - programmatic expressions as string
- * @returns {string} - expressions as string
+ * @type {import('../../internal').writeExpressions}
  */
 function writeExpressions(expressions) {
   if (!expressions) return '';
@@ -73,7 +66,7 @@ function writeExpressions(expressions) {
 
 /**
  * cleanupFields - Remove fields from config object
- * @param {GasketConfigDefinition} config - gasket config object
+ * @type {import('../../internal').cleanupFields}
  */
 function cleanupFields(config) {
   delete config.fields.imports;
@@ -84,9 +77,7 @@ function cleanupFields(config) {
 
 /**
  * Writes the contents of `pkg` to the app's package.json.
- *
- * @param {CreateContext} context - Create context
- * @returns {Promise} promise
+ * @type {import('../../internal').writeGasketConfig}
  */
 async function writeGasketConfig({ context }) {
   const { dest, gasketConfig, generatedFiles, typescript } = context;

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

@@ -4,9 +4,7 @@ import action from '../action-wrapper.js';
 
 /**
  * Writes the contents of `pkg` to the app's package.json.
- *
- * @param {CreateContext} context - Create context
- * @returns {Promise} promise
+ * @type {import('../../internal').writePkg}
  */
 async function writePkg({ context }) {
   const { dest, pkg, generatedFiles } = context;

package/lib/scaffold/config-builder.js

@@ -7,9 +7,8 @@ const debug = diagnostics('gasket:cli:package');
 /**
  * Simple object check without bringing in a large
  * utility library.
- *
  * @param {*} value - What to test if an object
- * @returns {Boolean} results
+ * @returns {boolean} results
  */
 function isObject(value) {
   return value && typeof value === 'object';
@@ -35,7 +34,6 @@ const versionTypes = {
 /**
  * Validates if the version `v` is valid for `package.json`
  * dependencies, devDependencies, etc.
- *
  * @param  {string}  v Version in package.json field.
  * @returns {boolean} Value indicating if npm accepts the value
  */
@@ -48,25 +46,19 @@ function isValidVersion(v) {
   return v === 'latest'
     || v.match(versionTypes.uri) != null    // eslint-disable-line eqeqeq
     || v.match(versionTypes.github) != null // eslint-disable-line eqeqeq
-    || semver.validRange(v);
+    || !!semver.validRange(v);
 }
 
 /**
  * ConfigBuilder is an extensible data structure for **specifically**
  * managing `package.json` data.
- *
- * @type {ConfigBuilder}
+ * @type {import('../index').ConfigBuilder}
  */
 export class ConfigBuilder {
   /**
    * ConfigBuilder
-   *
-   * @param {Object} [fields] - Initial fields
-   * @param {Object} [options] - Additional setup options
-   * @param {String[]} [options.orderBy] - Preferred order to sort top-level keys
-   * @param {String[]} [options.orderedFields] - Fields that should be sorted
-   * @param {String[]} [options.objectFields] - Fields that are required to be object type
-   * @param {String[]} [options.semverFields] - Fields that are aware of semantic versioning
+   * @param fields
+   * @param options
    */
   constructor(fields = {}, options = {}) {
     this.fields = Object.assign({}, fields);
@@ -80,6 +72,7 @@ export class ConfigBuilder {
     this.objectFields = options.objectFields;
     this.semverFields = options.semverFields;
     this.warnings = options.warnings;
+    this.source = options.source;
 
     // Any semverFields are also object fields and ordered fields.
     if (Array.isArray(this.semverFields)) {
@@ -90,9 +83,8 @@ export class ConfigBuilder {
 
   /**
    * Creator method to get a new instance
-   *
-   * @param {Object} [fields] - Initial fields
-   * @param {Object} [options] - Additional setup options
+   * @param {object} [fields] - Initial fields
+   * @param {object} [options] - Additional setup options
    * @returns {ConfigBuilder} instance
    */
   static create(fields = {}, options = {}) {
@@ -101,9 +93,8 @@ export class ConfigBuilder {
 
   /**
    * Create an instance configured with options for package.json files
-   *
-   * @param {Object} [fields] - Initial fields
-   * @param {Object} [options] - Additional setup options
+   * @param {object} [fields] - Initial fields
+   * @param {object} [options] - Additional setup options
    * @returns {ConfigBuilder} instance
    */
   static createPackageJson(fields = {}, options = {}) {
@@ -143,9 +134,9 @@ export class ConfigBuilder {
 
   /**
    * Adds all `[key, value]` pairs in the `fields` provided.
-   * @param {object|function(current)} fields - Object to merge.
+   * @param {object|function(current):object} fields - Object to merge.
    *    Can be a function that accepts the current fields and object to merge.
-   * @param {Object} source Plugin to blame if conflicts arise from this operation.
+   * @param {object} source Plugin to blame if conflicts arise from this operation.
    *
    * Adapted from @vue/cli under MIT License:
    * https://github.com/vuejs/vue-cli/blob/f09722c/packages/%40vue/cli/lib/GeneratorAPI.js#L117-L150
@@ -171,7 +162,7 @@ export class ConfigBuilder {
    * the given `key` into the package.json fields associated with this instance.
    * @param {string} key - Field in package.json to add or extend.
    * @param {*} value - Target value to set for key provided.
-   * @param {Object} source - Plugin to blame if conflicts arise from this operation.
+   * @param {object} source - Plugin to blame if conflicts arise from this operation.
    * @param {object} [options] - Optional arguments for add behavior
    * @param {boolean} [options.force] - Should the semver version override other attempts
    *
@@ -305,9 +296,9 @@ export class ConfigBuilder {
 
   /**
    * Checks if a dependency has been already added
-   * @param  {String} key Dependency bucket
-   * @param  {String} value Dependency to search
-   * @returns {Bool} True if the dependency exists on the bucket
+   * @param  {string} key Dependency bucket
+   * @param  {string} value Dependency to search
+   * @returns {boolean} True if the dependency exists on the bucket
    */
   has(key, value) {
     const existing = this.fields[key];
@@ -352,10 +343,10 @@ export class ConfigBuilder {
    *   - If ¬∃ prev                 ––> set and blame [dep, ver]
    *   - If ver > prev              ––> set and blame [dep, ver]
    *   - If ¬(ver ∩ prev)           ––> Conflict. Print.
-   *
+   * @param {object} options
    * @param  {string} options.key      {devD,peerD,optionalD,d}ependencies
-   * @param  {Object} options.value    Updates for { name: version } pairs
-   * @param  {Object} options.existing Existing { name: version } pairs
+   * @param  {object} options.value    Updates for { name: version } pairs
+   * @param  {object} options.existing Existing { name: version } pairs
    * @param  {string} options.name     Plugin name providing merge `value``
    * @param {boolean} [options.force]  Should the semver version override other attempts
    *
@@ -366,6 +357,7 @@ export class ConfigBuilder {
 
     const setBlame = blameId => {
       this.blame.set(blameId, [name]);
+      // debugger;
       if (force) this.force.add(blameId);
     };
 
@@ -425,9 +417,9 @@ export class ConfigBuilder {
   /**
    * Normalizes a potential semver range into a semver string
    * and returns the newest version
-   * @param  {String} r1 Semver string (potentially invalid).
-   * @param  {String} r2 Semver string (potentially invalid).
-   * @returns {String|undefined} Newest semver version.
+   * @param  {string} r1 Semver string (potentially invalid).
+   * @param  {string} r2 Semver string (potentially invalid).
+   * @returns {string | undefined} Newest semver version.
    *
    * Adapted from @vue/cli under MIT License:
    * https://github.com/vuejs/vue-cli/blob/f09722c/packages/%40vue/cli/lib/util/mergeDeps.js#L58-L64
@@ -448,7 +440,6 @@ export class ConfigBuilder {
    * Performs a naive attempt to take a transform a semver range
    * into a concrete version that may be used for "newness"
    * comparison.
-   *
    * @param  {string} range Valid "basic" semver:   ^X.Y.Z, ~A.B.C, >=2.3.x, 1.x.x
    * @returns {string} Concrete as possible version: X.Y.Z,  A.B.C,   2.3.0, 1.0.0
    */
@@ -462,7 +453,7 @@ export class ConfigBuilder {
   /**
    * Orders top-level keys by `orderBy` options with any fields specified in
    * the `orderFields` options having their keys sorted.
-   * @returns {Object} Ready to be serialized JavaScript object.
+   * @returns {object} Ready to be serialized JavaScript object.
    */
   toJSON() {
     if (Array.isArray(this.orderedFields)) {
@@ -480,9 +471,9 @@ export class ConfigBuilder {
    * Orders the given object, `obj`, applying any (optional)
    * key order specified via `orderBy`. If no `orderBy` is provided
    * keys are ordered lexographically.
-   * @param  {Object}   obj       Object to transform to ordered keys
+   * @param  {object}   obj       Object to transform to ordered keys
    * @param  {string[]} [orderBy] Explicit key order to use.
-   * @returns {Object} Shallow clone of `obj` with ordered keys
+   * @returns {object} Shallow clone of `obj` with ordered keys
    *
    * Adapted from @vue/cli under MIT License:
    * https://github.com/vuejs/vue-cli/blob/f09722c/packages/%40vue/cli/lib/util/sortObject.js
@@ -502,6 +493,11 @@ export class ConfigBuilder {
     /*
      * Sorts based on the `order` defined above.
      */
+    /**
+     *
+     * @param a
+     * @param b
+     */
     function sortByOrder(a, b) {
       const indexA = typeof order[a] === 'undefined'
         ? Infinity

package/lib/scaffold/create-context.js

@@ -7,11 +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.
- *
- * @param {CreateContext} context - Create context.
- * @param {Plugin} source - Gasket plugin the create context is within.
- * @returns {Proxy} Shallow proxy to the `context` provided that will
- * pass `source` to `context.{files,pkg}.*` methods.
+ * @type {import('../internal').makeCreateRuntime}
  */
 function makeCreateRuntime(context, source) {
   //
@@ -47,6 +43,7 @@ function makeCreateRuntime(context, source) {
     set(obj, key, value) {
       if (key !== 'pkg' && key !== 'files' && key !== 'source') {
         obj[key] = value;
+        return true; // The set trap in a Proxy must return a boolean value indicating whether the property was successfully set
       }
     }
   });
@@ -56,57 +53,6 @@ function flatten(acc, values) {
   return acc.concat(values);
 }
 
-/**
- * Create Context
- *
- * @type {CreateContext}
- *
- * -- Added by command args and options
- *
- * @property {String} appName - Short name of the app
- * @property {String} cwd - Current work directory
- * @property {String} dest - Path to the target app (Default: cwd/appName)
- * @property {String} relDest - Relative path to the target app
- * @property {Boolean} extant - Whether or not target directory already exists
- * @property {[String]} localPresets - paths to the local presets packages
- * @property {PresetDesc[]} rawPresets - Raw preset desc from args. Can include version constraint. Added by load-preset if using localPresets.
- * @property {String[]} pkgLinks - Local packages that should be linked
- * @property {String[]} messages - non-error/warning messages to report
- * @property {String[]} warnings - warnings messages to report
- * @property {String[]} errors - error messages to report but do not exit process
- * @property {String[]} nextSteps - any next steps to report for user
- * @property {Set<String>} generatedFiles - any generated files to show in report
- * @property {any[]} presets - Default empty array, populated by load-preset with actual imports
- * @property {Object} presetConfig - Default to object w/empty plugins array to be populated by `presetConfig` hook
- *
- * -- Added by `global-prompts`
- *
- * @property {String} appDescription - Description of app
- * @property {Boolean} gitInit - Should a git repo be initialized and first commit
- * @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')
- * @property {Boolean} destOverride - Whether or not the user wants to override an extant directory
- *
- * -- Added by `load-preset`
- *
- * @property {PresetName[]} presets - Short name of presets
- *
- *
- * -- Added by `setup-pkg`
- *
- * @property {ConfigBuilder} pkg - package.json builder
- * @property {PackageManager} pkgManager - manager to execute npm or yarn commands
- *
- * -- Added by `setup-gasket-config`
- *
- * @property {ConfigBuilder} gasketConfig - gasket.config builder
- *
- * -- Added by `create-hooks`
- *
- * @property {Files} files - Use to add files and templates to generate
- */
 export class CreateContext {
   constructor(initContext = {}) {
     Object.assign(this, initContext);
@@ -117,13 +63,7 @@ export class CreateContext {
   }
 }
 
-/**
- * Makes the initial context used through the create command flow.
- *
- * @param {String[]} argv - Commands args
- * @param {Object} options - Command options
- * @returns {CreateContext} context
- */
+/** @type {import('../internal').makeCreateContext} */
 export function makeCreateContext(argv = [], options = {}) {
   const appName = argv[0] || 'templated-app';
   const {
@@ -149,9 +89,8 @@ export function makeCreateContext(argv = [], options = {}) {
 
   /**
    * Input context which will be appended by prompts and passed to create hooks
-   *
-   * @type {CreateContext}
-   */
+   * @type {import('../internal').PartialCreateContext}
+  */
   const context = new CreateContext({
     destOverride: true,
     cwd,

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

@@ -4,10 +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.
- *
- * @param {CreateContext} context - Create context
- * @param {Error} error - Exiting error
- * @returns {Promise<void>} promise
+ * @type {import('../internal').dumpErrorContext}
  */
 export async function dumpErrorContext(context, error) {
   const { cwd } = context;

package/lib/scaffold/files.js

@@ -1,16 +1,18 @@
 /**
  * Utility for plugins to add files and templates for generating
- *
- * @type {Files}
+ * @type {import('../index').Files}
  */
 export class Files {
   constructor() {
+  /**
+   * Array of glob sets, each containing an array of globs and a source object.
+   * @type {Array<{globs: string[], source: object}>}
+   */
     this.globSets = [];
   }
 
   /**
    * Return array of globs
-   *
    * @deprecated
    * @returns {string[]} `globby` compatible patterns
    */
@@ -21,8 +23,9 @@ export class Files {
   /**
    * Adds the specified `globby` compatible patterns, `globs`,
    * into the set of all sources for this set of files.
-   * @param {string[]} globs - `globby` compatible patterns
-   * @param {Object} source - Plugin to blame if conflicts arise from this operation.
+   * @param {object} params - Object containing `globs` and `source`
+   * @param {string[]} params.globs - `globby` compatible patterns
+   * @param {object} params.source - Plugin to blame if conflicts arise from this operation.
    */
   add({ globs, source }) {
     this.globSets.push({ globs, source });

package/lib/scaffold/utils.js

@@ -2,14 +2,7 @@ import path from 'path';
 import { createRequire } from 'module';
 const require = createRequire(import.meta.url);
 
-/**
- * Parses JSON file or string to assign to context
- *
- * @param {CreateContext} context - Create context.
- * @param {Object} configFlags - flags to read config from
- * @param {string} configFlags.config - JSON string of config values
- * @param {string} configFlags.configFile - path to JSON file of config values
- */
+/** @type {import('../internal').readConfig} */
 export function readConfig(context, { config, configFile }) {
   if (config) {
     const parsedConfig = JSON.parse(config);
@@ -19,4 +12,3 @@ export function readConfig(context, { config, configFile }) {
     Object.assign(context, parsedConfigFile);
   }
 }
-

package/lib/utils/create-option.js

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