create-gasket-app 7.0.0-next.21 → 7.0.0-next.25

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-import type { GasketConfigDefinition, MaybeAsync, Plugin, GasketEngine } from '@gasket/engine';
+import type { GasketConfigDefinition, MaybeAsync, Plugin, GasketEngine } from '@gasket/core';
 import type { PackageManager } from '@gasket/utils';
 
 export interface Dependencies {
@@ -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 {
@@ -239,14 +238,17 @@ export interface ActionWrapperParams {
   spinner?: any;
 }
 
-declare module '@gasket/engine' {
+declare module '@gasket/core' {
   export interface HookExecTypes {
     presetPrompt(context: CreateContext): Promise<void>;
     presetConfig(context: CreateContext): Promise<CreateContext['presetConfig']>;
     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/engine' {
     postCreate(
       context: CreateContext,
       utils: {
-        runScript: (script: string) => Promise<void>
-      }): MaybeAsync<void>;
+        runScript: (script: string) => Promise<void>;
+      }
+    ): MaybeAsync<void>;
   }
 }

package/lib/index.js

@@ -2,7 +2,8 @@
 import { Command } from 'commander';
 import { createRequire } from 'module';
 import { createCommand } from './commands/create.js';
-import { processCommand, logo, warnIfOutdated } from './utils/index.js';
+import { processCommand, logo } from './utils/index.js';
+import { warnIfOutdated } from '@gasket/utils';
 
 const require = createRequire(import.meta.url);
 const pkg = require('../package.json');

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

@@ -24,7 +24,6 @@ async function setupPkg({ context }) {
   // Add critical dependencies
   pkg.add('dependencies', {
     '@gasket/core': dependencies['@gasket/core'],
-    '@gasket/engine': dependencies['@gasket/engine'],
     '@gasket/utils': dependencies['@gasket/utils']
   });
 

package/lib/utils/index.js

@@ -3,4 +3,3 @@ export { processArgs } from './process-args.js';
 export { processOptions } from './process-options.js';
 export { createOption } from './create-option.js';
 export { logo } from './logo.js';
-export { warnIfOutdated } from './warn-if-outdated.js';

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "create-gasket-app",
-  "version": "7.0.0-next.21",
+  "version": "7.0.0-next.25",
   "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,11 +33,10 @@
   },
   "homepage": "https://github.com/godaddy/gasket/tree/main/packages/create-gasket-app",
   "dependencies": {
-    "@gasket/core": "^7.0.0-next.21",
-    "@gasket/engine": "^7.0.0-next.21",
-    "@gasket/plugin-git": "^7.0.0-next.21",
-    "@gasket/plugin-logger": "^7.0.0-next.21",
-    "@gasket/utils": "^7.0.0-next.21",
+    "@gasket/core": "^7.0.0-next.25",
+    "@gasket/plugin-git": "^7.0.0-next.25",
+    "@gasket/plugin-logger": "^7.0.0-next.25",
+    "@gasket/utils": "^7.0.0-next.25",
     "commander": "^12.0.0",
     "deepmerge": "^4.3.1",
     "glob": "^8.1.0",
@@ -55,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",
@@ -79,5 +79,5 @@
   "jest": {
     "transform": {}
   },
-  "gitHead": "52718d035b5a33c04de7043587f89596dd6da6f4"
+  "gitHead": "0782b4f4d07d18fb6bd44ecaab3e6bdafd6d4c9d"
 }

package/lib/utils/warn-if-outdated.js

@@ -1,78 +0,0 @@
-import { default as gasketUtils } from '@gasket/utils';
-import semver from 'semver';
-import chalk from 'chalk';
-import { readFile, writeFile } from 'fs/promises';
-import path from 'path';
-import { fileURLToPath } from 'url';
-const __dirname = fileURLToPath(import.meta.url);
-
-const cachePath = path.join(__dirname, '..', '..', '..', '.cache'); // Place at root of gasket-cli
-const LATEST_VERSION = 'latestVersion';
-const LATEST_VERSION_UPDATE_TIME = 'latestVersionUpdateTime';
-
-/**
- * Checks if the latest version update time is older than seven days
- * @param {number} currentTime - current time in milliseconds
- * @param {number} latestVersionUpdateTime - latest version update time in milliseconds
- * @returns {boolean} - true if latestVersionUpdateTime is older than seven days
- */
-function isOlderThanSevenDays(currentTime, latestVersionUpdateTime) {
-  const sevenDaysInMillis = 7 * 24 * 60 * 60 * 1000; // Seven days in milliseconds
-  const timeDifference = Math.abs(currentTime - latestVersionUpdateTime);
-  return timeDifference > sevenDaysInMillis;
-}
-
-/**
- * Fetches the latest version of a package from npm
- * @param {string} pkgName - package name
- * @param {number} currentTime - current time in milliseconds
- * @param {object} cache - cache object
- * @returns {string} - latest version of the package
- */
-async function getLatestVersion(pkgName, currentTime, cache) {
-  if (
-    !cache[LATEST_VERSION_UPDATE_TIME] ||
-    !cache[LATEST_VERSION] ||
-    isOlderThanSevenDays(currentTime, cache[LATEST_VERSION_UPDATE_TIME])
-  ) {
-    try {
-      const cmdResult = await gasketUtils.runShellCommand('npm', ['view', pkgName, 'version'], {});
-      if (cmdResult?.stdout) {
-        const latestVersion = cmdResult.stdout.trim();
-        cache[LATEST_VERSION_UPDATE_TIME] = currentTime;
-        cache[LATEST_VERSION] = latestVersion;
-        await writeFile(cachePath, JSON.stringify(cache));
-        return latestVersion;
-      }
-    } catch (error) {
-      console.error('Error fetching latest version:', error);
-    }
-  } else {
-    return cache[LATEST_VERSION];
-  }
-}
-
-/**
- * Warns if the package is outdated
- * @param {string} pkgName - package name
- * @param {string} currentVersion - current version of the package
- */
-export async function warnIfOutdated(pkgName, currentVersion) {
-  const currentTime = new Date().getTime();
-  let cache = {};
-
-  try {
-    const file = await readFile(cachePath, 'utf8');
-    cache = JSON.parse(file);
-  } catch (error) {
-    // console.error('Error reading cache file:', error);
-  }
-
-  const latestVersion = await getLatestVersion(pkgName, currentTime, cache);
-
-  if (typeof latestVersion === 'string' && semver.gt(latestVersion, currentVersion)) {
-    console.warn(
-      ` ${chalk.yellow('›')}   Warning: ${pkgName} update available from ${chalk.green(latestVersion)} to ${chalk.green(currentVersion)}`
-    );
-  }
-}