create-gasket-app 7.4.15 → 7.4.17

package/lib/commands/create.js

@@ -108,8 +108,8 @@ const createCommand = {
 
 /**
  * validateOption - We require at least one of the options to be provided
- * @param {import('../internal.js').PartialCreateContext} context
- * @returns {import('../internal.js').PartialCreateContext}
+ * @param {import('../internal.js').PartialCreateContext} context - Create context
+ * @returns {import('../internal.js').PartialCreateContext} Validated context
  */
 function validateOptions(context) {
   const hasOption = (context) => Boolean(context.template || context.templatePath || context.rawPresets.length || context.localPresets.length);
@@ -124,8 +124,8 @@ function validateOptions(context) {
 
 /**
  * handleTemplate - Handles the template creation
- * @param {import('../internal.js').PartialCreateContext} context
- * @returns {Promise<void>}
+ * @param {import('../internal.js').PartialCreateContext} context - Create context
+ * @returns {Promise<void>} Promise that resolves when template is created
  */
 async function handleTemplate(context) {
   await mkDir({ context });
@@ -140,8 +140,8 @@ async function handleTemplate(context) {
 
 /**
  * handlePresets - Handles the preset creation
- * @param {import('../internal.js').PartialCreateContext} context
- * @returns {Promise<void>}
+ * @param {import('../internal.js').PartialCreateContext} context - Create context
+ * @returns {Promise<void>} Promise that resolves when presets are applied
  */
 async function handlePresets(context) {
   await loadPreset({ context });
@@ -175,8 +175,8 @@ async function handlePresets(context) {
 
 /**
  * handleCreate - Handles the create creation
- * @param {import('../internal.js').PartialCreateContext} context
- * @returns {Promise<void>}
+ * @param {import('../internal.js').PartialCreateContext} context - Create context
+ * @returns {Promise<void>} Promise that resolves when app is created
  */
 async function handleCreate(context) {
   const { template, templatePath } = context;
@@ -200,7 +200,6 @@ createCommand.action = async function run(appname, options, command) {
   try {
     await handleCreate(context);
   } catch (err) {
-    // eslint-disable-next-line no-console
     console.error(chalk.red('Exiting with errors.'));
     dumpErrorContext(context, err);
     throw err;

package/lib/scaffold/actions/copy-template.js

@@ -1,9 +1,54 @@
 import path from 'path';
 import { withSpinner } from '../with-spinner.js';
-import { cp, readdir } from 'fs/promises';
+import { cp, readdir, writeFile, access } from 'fs/promises';
 
 const EXCLUDED_FILES = ['node_modules'];
 
+/**
+ * Ensures a .gitignore exists in the generated app.
+ * npm intentionally strips .gitignore files from published packages.
+ * We will need to update our templates to use a different name
+ * such as gitignore or .gitignore.template to survive installing.
+ * @param {import("../../internal.d.ts").PartialCreateContext} context - Create context
+ * @returns {Promise<void>}
+ */
+export async function ensureGitignore(context) {
+  const destPath = path.join(context.dest, '.gitignore');
+
+  const exists = await access(destPath)
+    .then(() => true)
+    .catch(() => false);
+
+  if (exists) {
+    return;
+  }
+
+  const npmignorePath = path.join(context.dest, '.npmignore');
+  try {
+    await cp(npmignorePath, destPath);
+    context.generatedFiles.add(path.relative(context.cwd, destPath));
+    return;
+  } catch (err) {
+    if (err.code !== 'ENOENT') throw err;
+  }
+
+  // No template gitignore found, create a basic one
+  const basicGitignore = [
+    '# Dependencies',
+    'node_modules',
+    '',
+    '# Logs',
+    '*.log',
+    '',
+    '# Env files',
+    '.env',
+    '.env.local'
+  ].join('\n');
+
+  await writeFile(destPath, basicGitignore, 'utf8');
+  context.generatedFiles.add(path.relative(context.cwd, destPath));
+}
+
 /** @type {import('../../internal.d.ts').copyTemplate} */
 async function copyTemplate({ context }) {
   if (!context.templateDir) return;
@@ -17,6 +62,9 @@ async function copyTemplate({ context }) {
     await cp(sourcePath, destPath, { recursive: true });
     context.generatedFiles.add(path.relative(context.cwd, destPath));
   }
+
+  // Ensure .gitignore is properly created
+  await ensureGitignore(context);
 }
 
 export default withSpinner('Copy template files', copyTemplate);

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

@@ -8,7 +8,6 @@ import { logo } from '../../utils/index.js';
  * @private
  */
 const newline = () => {
-  // eslint-disable-next-line no-console
   console.log('');
 };
 
@@ -59,7 +58,6 @@ async function printReport({ context }) {
   const report = buildReport(context);
   const { warnings, errors } = context;
 
-  // eslint-disable-next-line no-console
   console.log(`✨Success!
 
 Finished with ${warnings.length} warnings and ${errors.length} errors using
@@ -68,13 +66,10 @@ Finished with ${warnings.length} warnings and ${errors.length} errors using
   Object.entries(report).forEach(([k, v]) => {
     if (!v || !v.length) return;
     newline();
-    // eslint-disable-next-line no-console
     console.log(`${bold(toSpaceCase(k))}`);
     if (Array.isArray(v)) {
-      // eslint-disable-next-line no-console
       v.map(o => console.log(`  ${o}`));
     } else {
-      // eslint-disable-next-line no-console
       console.log(`  ${v}`);
     }
   });

package/lib/scaffold/config-builder.js

@@ -57,8 +57,8 @@ function isValidVersion(v) {
 export class ConfigBuilder {
   /**
    * ConfigBuilder
-   * @param fields
-   * @param options
+   * @param {object} fields - Initial fields
+   * @param {object} options - Configuration options
    */
   constructor(fields = {}, options = {}) {
     this.fields = Object.assign({}, fields);
@@ -134,9 +134,9 @@ export class ConfigBuilder {
 
   /**
    * Adds all `[key, value]` pairs in the `fields` provided.
-   * @param {object|function(current):object} fields - Object to merge.
+   * @param {object|function(object):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
@@ -413,7 +413,7 @@ 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 {object} options - Merge 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
@@ -543,7 +543,7 @@ export class ConfigBuilder {
    * keys are ordered lexographically.
    * @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 | undefined} 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
@@ -560,13 +560,11 @@ export class ConfigBuilder {
       }, {});
     }
 
-    /*
-     * Sorts based on the `order` defined above.
-     */
     /**
-     *
-     * @param a
-     * @param b
+     * Sorts based on the `order` defined above.
+     * @param {string} a - First key to compare
+     * @param {string} b - Second key to compare
+     * @returns {number} Comparison result
      */
     function sortByOrder(a, b) {
       const indexA = typeof order[a] === 'undefined'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-gasket-app",
-  "version": "7.4.15",
+  "version": "7.4.17",
   "description": "starter pack for creating a gasket app",
   "type": "module",
   "bin": {
@@ -32,23 +32,23 @@
     "mkdirp": "^1.0.4",
     "ora": "^3.4.0",
     "semver": "^7.7.1",
-    "@gasket/core": "^7.6.3",
-    "@gasket/plugin-command": "^7.6.0",
-    "@gasket/plugin-docs": "^7.5.0",
+    "@gasket/core": "^7.7.1",
+    "@gasket/plugin-command": "^7.6.2",
+    "@gasket/plugin-docs": "^7.5.2",
     "@gasket/plugin-docusaurus": "^7.5.0",
     "@gasket/plugin-dynamic-plugins": "^7.5.0",
-    "@gasket/plugin-git": "^7.4.7",
+    "@gasket/plugin-git": "^7.4.8",
     "@gasket/plugin-logger": "^7.4.0",
-    "@gasket/plugin-metadata": "^7.5.5",
-    "@gasket/request": "^7.5.4",
-    "@gasket/utils": "^7.6.3"
+    "@gasket/plugin-metadata": "^7.5.7",
+    "@gasket/request": "^7.5.5",
+    "@gasket/utils": "^7.6.4"
   },
   "devDependencies": {
     "@typescript-eslint/parser": "^8.38.0",
     "@vitest/coverage-v8": "^3.2.0",
     "dotenv": "^16.4.7",
     "vitest": "^3.2.0",
-    "@gasket/request": "^7.5.4"
+    "@gasket/request": "^7.5.5"
   },
   "scripts": {
     "lint": "eslint .",