create-gasket-app 7.0.3-cli.0 → 7.0.4

package/lib/scaffold/create-context.js

@@ -0,0 +1,188 @@
+/* eslint-disable max-len, max-statements */
+import fs from 'fs';
+import path from 'path';
+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.
+ */
+function makeCreateRuntime(context, source) {
+  //
+  // Create a set of overrides for our Proxy
+  //
+  const overrides = {
+    source,
+    files: {
+      add(...globs) {
+        context.files.add({ globs, source });
+      }
+    },
+    pkg: {
+      extend(fields) {
+        context.pkg.extend(fields, source);
+      },
+
+      add(key, value, options) {
+        context.pkg.add(key, value, source, options);
+      },
+
+      has(key, value) {
+        return context.pkg.has(key, value);
+      }
+    }
+  };
+
+  return new Proxy(context, {
+    get(obj, key) {
+      if (overrides[key]) return overrides[key];
+      return obj[key];
+    },
+    set(obj, key, value) {
+      if (key !== 'pkg' && key !== 'files' && key !== 'source') {
+        obj[key] = value;
+      }
+    }
+  });
+}
+
+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);
+  }
+
+  runWith(plugin) {
+    return makeCreateRuntime(this, plugin);
+  }
+}
+
+/**
+ * Makes the initial context used through the create command flow.
+ *
+ * @param {String[]} argv - Commands args
+ * @param {Object} options - Command options
+ * @returns {CreateContext} context
+ */
+export function makeCreateContext(argv = [], options = {}) {
+  const appName = argv[0] || 'templated-app';
+  const {
+    presets = [],
+    npmLink = [],
+    presetPath = [],
+    packageManager,
+    prompts,
+    config,
+    configFile
+  } = options;
+
+  // Flatten the array of array created by the plugins flag – it
+  // supports both multiple instances as well as comma-separated lists.
+  const rawPresets = presets.reduce(flatten, []);
+  const localPresets = presetPath.reduce(flatten, []);
+  const pkgLinks = npmLink.reduce(flatten, []);
+  const cwd = process.cwd();
+  const dest = path.join(cwd, appName);
+  const relDest = `.${path.sep}${path.relative(cwd, dest)}`;
+  // eslint-disable-next-line no-sync
+  const extant = fs.existsSync(dest);
+
+  /**
+   * Input context which will be appended by prompts and passed to create hooks
+   *
+   * @type {CreateContext}
+   */
+  const context = new CreateContext({
+    destOverride: true,
+    cwd,
+    dest,
+    relDest,
+    extant,
+    pkgLinks,
+    localPresets,
+    rawPresets,
+    messages: [],
+    warnings: [],
+    errors: [],
+    nextSteps: [],
+    generatedFiles: new Set(),
+    prompts,
+    presets: [],
+    presetConfig: {
+      plugins: []
+    },
+    readme: []
+  });
+
+  readConfig(context, { config, configFile });
+
+  if (packageManager) {
+    context.packageManager = packageManager;
+  }
+  if (appName) {
+    context.appName = appName;
+  }
+
+  return context;
+}
+

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

@@ -0,0 +1,28 @@
+import path from 'path';
+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
+ */
+export async function dumpErrorContext(context, error) {
+  const { cwd } = context;
+
+  try {
+    const report = { exitError: error.stack, ...context };
+    const fileName = 'gasket-create-error.log';
+
+    const filePath = path.join(cwd, fileName);
+    await writeFile(filePath, JSON.stringify(report, null, 2), 'utf8');
+    console.log(`Error log dumped to: ${filePath}`);
+  } catch (err) {
+    //
+    // eat but print any errors during writing log file
+    //
+    console.error(`Error writing error log: ${err}`);
+  }
+}

package/lib/scaffold/files.js

@@ -0,0 +1,30 @@
+/**
+ * Utility for plugins to add files and templates for generating
+ *
+ * @type {Files}
+ */
+export class Files {
+  constructor() {
+    this.globSets = [];
+  }
+
+  /**
+   * Return array of globs
+   *
+   * @deprecated
+   * @returns {string[]} `globby` compatible patterns
+   */
+  get globs() {
+    return this.globSets.reduce((acc, cur) => [...acc, ...cur.globs], []);
+  }
+
+  /**
+   * 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.
+   */
+  add({ globs, source }) {
+    this.globSets.push({ globs, source });
+  }
+}

package/lib/scaffold/readme.js

@@ -0,0 +1,51 @@
+import { readFile } from 'fs/promises';
+
+/** @type {import('../index').Readme} */
+export default class Readme {
+  constructor() {
+    this.markdown = [];
+    this.links = [];
+  }
+
+  addNewLine() {
+    this.markdown.push('');
+    return this;
+  }
+
+  heading(content, level = 2) {
+    this.markdown.push(`${'#'.repeat(level)} ${content}`);
+    return this.addNewLine();
+  }
+
+  subHeading(content) {
+    return this.heading(content, 3);
+  }
+
+  content(content) {
+    this.markdown.push(content);
+    return this.addNewLine();
+  }
+
+  list(items) {
+    this.markdown.push(...items.map(item => `- ${item}`));
+    return this.addNewLine();
+  }
+
+  link(content, href) {
+    this.links.push(`[${content}]: ${href}`);
+    return this;
+  }
+
+  codeBlock(content, syntax = '') {
+    this.markdown.push(`\`\`\`${syntax}`);
+    this.markdown.push(content);
+    this.markdown.push('```');
+    return this.addNewLine();
+  }
+
+  async markdownFile(path) {
+    const content = await readFile(path, 'utf8');
+    this.markdown.push(content);
+    return this.addNewLine();
+  }
+}

package/lib/scaffold/utils.js

@@ -0,0 +1,22 @@
+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
+ */
+export function readConfig(context, { config, configFile }) {
+  if (config) {
+    const parsedConfig = JSON.parse(config);
+    Object.assign(context, parsedConfig);
+  } else if (configFile) {
+    const parsedConfigFile = require(path.resolve(context.cwd, configFile));
+    Object.assign(context, parsedConfigFile);
+  }
+}
+

package/lib/utils/create-option.js

@@ -0,0 +1,18 @@
+import { Option } from 'commander';
+
+/**
+ * createOption - Create a commander option
+ * @param {CLICommandOption} definition - The option configuration
+ * @returns {CommnaderOption} option
+ */
+export function createOption(definition) {
+  const option = new Option(...definition.options);
+  const { defaultValue, conflicts, parse, hidden, required } = definition;
+
+  if (conflicts.length) option.conflicts(definition.conflicts);
+  if (hidden) option.hideHelp();
+  if (typeof defaultValue !== 'undefined') option.default(defaultValue);
+  if (parse) option.argParser(parse);
+  if (required) option.makeOptionMandatory();
+  return option;
+}

package/lib/utils/index.js

@@ -0,0 +1,5 @@
+export { processCommand } from './process-command.js';
+export { processArgs } from './process-args.js';
+export { processOptions } from './process-options.js';
+export { createOption } from './create-option.js';
+export { logo } from './logo.js';

package/lib/utils/logo.js

@@ -0,0 +1,12 @@
+export const logo = `
+         ▄▄▄▄████▀▀█▄
+     ▄████▀▀▀▀▀▀█▄▄██
+    ███▀  ▄▄▄▄▄   ▀██▌                 ▄▄▄
+  ▄███  ███▀▀▀▀██   ██                  ██              ██
+ █▀▀█  ██▌          ▐█▌ ▄▀▀▀█▄  ▄█▀▀▀▄  ██ ▐██▀ ▄█▀▀█▄ ▀██▀▀
+ █▄▄█  ██▌   ▀▀██   ▐█▌ ▄▄▄▄██  ▀▀█▄▄▄  █████   ██▄▄██  ██
+  ▀███  ███▄▄▄▄██   ██  ▀▄▄▄▀█▄ ▀▄▄▄█▀ ▄██▄ ██▄ ▀█▄▄▄▄  ▀█▄▄
+    ███▄  ▀▀▀  ▀▀ ▄██▌
+     ▀████▄▄▄▄▄▄█▀▀██
+         ▀▀▀▀████▄▄█▀
+`;

package/lib/utils/process-args.js

@@ -0,0 +1,37 @@
+/**
+ * isValidArg - Validates the argument configuration
+ * @param {CLICommandArg} arg The argument configuration
+ * @returns {boolean} True if valid, false otherwise
+ */
+function isValidArg(arg) {
+  const keys = Object.keys(arg);
+  if (arg.required && arg.default) return false;
+  return keys.length &&
+    keys.length <= 4 &&
+    arg.name && arg.description;
+}
+
+/**
+ * processArgs - Process the arguments configuration
+ * @param {CLICommandArg[]} args Array of argument configurations
+ * @returns {ProccesedCLICommandArg[]} Array of argument definitions
+ */
+export function processArgs(args) {
+  if (!Array.isArray(args) || !args.every(isValidArg)) throw new Error('Invalid argument(s) configuration');
+
+  return args.reduce((acc, arg) => {
+    const def = [];
+    const { name, description, required = false, default: defaultValue } = arg;
+    if (required) {
+      def.push(`<${name}>`, description);
+    } else {
+      def.push(`[${name}]`, description);
+    }
+
+    if (defaultValue) def.push(defaultValue);
+
+    acc.push(def);
+    return acc;
+
+  }, []);
+}

package/lib/utils/process-command.js

@@ -0,0 +1,50 @@
+import { Command } from 'commander';
+import { processArgs } from './process-args.js';
+import { processOptions } from './process-options.js';
+import { createOption } from './create-option.js';
+const program = new Command();
+
+/**
+ * isValidCommand - Validates the command configuration
+ * @param {CLICommand} command The command configuration
+ * @returns {boolean} True if valid, false otherwise
+ */
+function isValidCommand(command) {
+  const keys = Object.keys(command);
+  return keys.length &&
+    keys.length <= 7 &&
+    command &&
+    command.id &&
+    command.description &&
+    command.action &&
+    typeof command.action === 'function';
+}
+
+/**
+ * processCommand - Process the command configuration
+ * @param {CLICommand} command The command configuration
+ * @returns {ProccesedCLICommand} The command instance
+ */
+export function processCommand(command) {
+  if (!isValidCommand(command)) throw new Error('Invalid command configuration');
+  const { id, description, action, args, options, hidden = false, default: isDefault = false } = command;
+  const cmd = program
+    .command(id)
+    .description(description)
+    .action(action);
+
+  if (args) {
+    const cmdArgs = processArgs(args);
+    cmdArgs.forEach(arg => cmd.argument(...arg));
+  }
+
+  if (options) {
+    const cmdOpts = processOptions(options);
+    cmdOpts.forEach(o => {
+      const option = createOption(o);
+      cmd.addOption(option);
+    });
+  }
+
+  return { command: cmd, hidden, isDefault };
+}

package/lib/utils/process-options.js

@@ -0,0 +1,44 @@
+/**
+ * isValidOption - Validate the option
+ * @param {CLICommandOption} option The option configuration
+ * @returns {boolean} True if valid, false otherwise
+ */
+function isValidOption(option) {
+  const keys = Object.keys(option);
+  return keys.length &&
+    keys.length <= 5 &&
+    option.name &&
+    option.description;
+}
+
+/**
+ * processOptions - Process the options configuration
+ * @param {CLICommandOption[]} options Array of option configurations
+ * @returns {ProccesedCLICommandOption[]} Processed option definitions
+ */
+export function processOptions(options) {
+  if (!Array.isArray(options) || !options.every(isValidOption)) throw new Error('Invalid option(s) configuration');
+
+  return options.reduce((acc, option) => {
+    const def = [];
+    const {
+      name,
+      description,
+      required = false,
+      short,
+      parse,
+      type = 'string',
+      conflicts = [],
+      hidden = false,
+      default: defaultValue
+    } = option;
+
+    const format = required ? `<${name}>` : `[${name}]`;
+    const flags = short ? `-${short}, --${name}` : `--${name}`;
+
+    def.push(`${flags}${type !== 'boolean' ? ` ${format}` : ''}`, description);
+    acc.push({ options: def, conflicts, hidden, defaultValue, parse, required });
+
+    return acc;
+  }, []);
+}

package/package.json

@@ -1,19 +1,21 @@
 {
   "name": "create-gasket-app",
-  "version": "7.0.3-cli.0",
+  "version": "7.0.4",
   "description": "starter pack for creating a gasket app",
-  "main": "lib",
+  "type": "module",
   "bin": {
     "create-gasket-app": "./lib/index.js"
   },
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "files": [
     "lib"
   ],
   "scripts": {
     "lint": "eslint .",
     "lint:fix": "npm run lint -- --fix",
-    "test": "cross-env NODE_OPTIONS='--unhandled-rejections=strict' jest",
-    "test:watch": "jest --watch",
+    "test": "cross-env NODE_OPTIONS='--unhandled-rejections=strict --experimental-vm-modules' jest",
+    "test:watch": "npm run test -- --watch",
     "test:coverage": "jest --coverage",
     "posttest": "npm run lint"
   },
@@ -31,15 +33,37 @@
   },
   "homepage": "https://github.com/godaddy/gasket/tree/main/packages/create-gasket-app",
   "dependencies": {
-    "@gasket/cli": "^7.0.3-cli.0"
+    "@gasket/core": "^7.0.1",
+    "@gasket/plugin-command": "^7.0.1",
+    "@gasket/plugin-docs": "^7.0.4",
+    "@gasket/plugin-docusaurus": "^7.0.3",
+    "@gasket/plugin-git": "^7.0.1",
+    "@gasket/plugin-logger": "^7.0.4",
+    "@gasket/plugin-metadata": "^7.0.4",
+    "@gasket/utils": "^7.0.1",
+    "commander": "^12.0.0",
+    "deepmerge": "^4.3.1",
+    "glob": "^8.1.0",
+    "handlebars": "^4.7.8",
+    "inquirer": "6.5.2",
+    "json5": "^2.2.3",
+    "mkdirp": "^1.0.4",
+    "ora": "3.4.0",
+    "pump": "^3.0.0",
+    "semver": "^7.5.4",
+    "tar-fs": "^2.0.0",
+    "untildify": "^4.0.0"
   },
   "devDependencies": {
+    "@types/inquirer": "^9.0.7",
     "cross-env": "^7.0.3",
+    "diagnostics": "^2.0.2",
+    "dotenv": "^16.4.5",
     "eslint": "^8.56.0",
-    "eslint-config-godaddy": "^7.0.2",
-    "eslint-plugin-jest": "^27.6.3",
+    "eslint-config-godaddy": "^7.1.1",
+    "eslint-plugin-jest": "^28.6.0",
     "eslint-plugin-json": "^3.1.0",
-    "eslint-plugin-unicorn": "^44.0.0",
+    "eslint-plugin-unicorn": "^55.0.0",
     "jest": "^29.7.0"
   },
   "eslintConfig": {
@@ -57,5 +81,8 @@
   "eslintIgnore": [
     "test/fixtures"
   ],
-  "gitHead": "ffcc0372192c096dba45d684d9fe3926edd6cc71"
+  "jest": {
+    "transform": {}
+  },
+  "gitHead": "af49c0e42e7947e000faa771777b815b90aaffa3"
 }