feat(create-studiocms): implement latest version check in the verify step (#1358)

* feat(verify): implement latest version check in the verify step

* fix(index): replace readJson with direct import of package.json

* fix(dependencies): remove internal_helpers from package.json and pnpm-lock.yaml

* fix(verify): handle latest version check more gracefully and improve fetch error handling

* fix(verify): simplify update confirmation check in version logging

* fix(verify): enhance version comparison by validating semantic versioning

* fix(verify): improve update confirmation check to handle symbol type

Author: Adammatthiesen

.changeset/brown-planets-obey.md

@@ -0,0 +1,5 @@
+---
+"create-studiocms": minor
+---
+
+Implement latest version check in the verify step

packages/create-studiocms/package.json

@@ -28,11 +28,12 @@
 	],
 	"devDependencies": {
 		"@bluwy/giget-core": "^0.1.6",
+		"@types/semver": "catalog:",
 		"@withstudiocms/cli-kit": "workspace:^",
 		"@withstudiocms/effect": "workspace:^",
-		"@withstudiocms/internal_helpers": "workspace:^",
 		"effect": "catalog:effect",
 		"package-json": "^10.0.1",
+		"semver": "catalog:",
 		"tsdown": "catalog:"
 	},
 	"engines": {

packages/create-studiocms/src/index.ts

@@ -2,7 +2,7 @@ import { StudioCMSColorwayBg } from '@withstudiocms/cli-kit/colors';
 import { label } from '@withstudiocms/cli-kit/messages';
 import { intro, tasks } from '@withstudiocms/effect/clack';
 import { Cli, Effect, Layer, PlatformNode } from '@withstudiocms/effect/effect';
-import { readJson } from '@withstudiocms/internal_helpers/utils';
+import pkgJson from '../package.json';
 import { CommandConfig } from './args.ts';
 import { type EffectStepFn, getContext } from './context.ts';
 import { dependencies } from './steps/dependencies.ts';
@@ -13,11 +13,6 @@ import { projectName } from './steps/projectName.ts';
 import { template } from './steps/template.ts';
 import { verify } from './steps/verify.ts';
 
-/**
- * Get the package.json data for this package
- */
-const pkgJson = readJson<{ version: string }>(new URL('../package.json', import.meta.url));
-
 /**
  * Define the CLI command for the create-studiocms application
  */

packages/create-studiocms/src/steps/verify.ts

@@ -2,11 +2,16 @@ import dns from 'node:dns/promises';
 import { styleText } from 'node:util';
 import { verifyTemplate } from '@bluwy/giget-core';
 import { StudioCMSColorwayError, StudioCMSColorwayInfo } from '@withstudiocms/cli-kit/colors';
-import { log } from '@withstudiocms/effect/clack';
+import { confirm, log } from '@withstudiocms/effect/clack';
 import { Effect } from 'effect';
+import { compare as semCompare, valid as semValid } from 'semver';
+import pkg from '../../package.json';
 import { CLIError, type Context, type EffectStepFn } from '../context.ts';
 import { getTemplateTarget } from './template.ts';
 
+const name = pkg.name;
+const version = pkg.version;
+
 /**
  * Verify internet connection and template availability
  */
@@ -20,6 +25,39 @@ export const verify: EffectStepFn = Effect.fn('verify')(
 				ctx.exit(1);
 			}
 			if (ctx.debug) yield* Effect.log('Internet connection verified');
+
+			// Check if we are on the latest version of the CLI
+			if (ctx.debug) yield* Effect.log('Checking for updates...');
+
+			const latestVersion = yield* getLatestVersionEffect().pipe(Effect.orElseSucceed(() => null));
+
+			if (latestVersion) {
+				const comparison =
+					semValid(version) && semValid(latestVersion) ? semCompare(version, latestVersion) : null;
+				switch (comparison) {
+					case -1: {
+						const updateConfirmed = yield* confirm({
+							message: StudioCMSColorwayInfo(
+								`${styleText('bold', 'A new version of the CLI is available!')} You are using version ${styleText('reset', version)} but the latest version is ${styleText('reset', latestVersion)}. It is recommended to restart the CLI with the latest version to get new features and bug fixes!\n\nDo you want to exit?`
+							),
+							initialValue: true,
+						});
+
+						if (typeof updateConfirmed === 'symbol' || updateConfirmed) {
+							yield* log.info(
+								StudioCMSColorwayInfo(
+									'Check https://www.npmjs.com/package/create-studiocms for the latest version.'
+								)
+							);
+							ctx.exit(0);
+						}
+						break;
+					}
+					default:
+						if (ctx.debug) yield* Effect.log('You are using the latest version of the CLI');
+						break;
+				}
+			}
 		}
 
 		if (ctx.template) {
@@ -61,3 +99,21 @@ const isOnline = Effect.fn('isOnline')(() =>
 		catch: (cause) => new CLIError({ cause }),
 	})
 );
+
+/**
+ * Get the latest version of the CLI from npm registry
+ */
+const getLatestVersionEffect = Effect.fn('getLatestVersion')(() =>
+	Effect.tryPromise({
+		try: () =>
+			fetch(`https://registry.npmjs.org/${name}/latest`, {
+				signal: AbortSignal.timeout(5000),
+			})
+				.then((res) => {
+					if (!res.ok) return null;
+					return res.json() as Promise<{ version?: string }>;
+				})
+				.then((data) => data?.version ?? null),
+		catch: (cause) => new CLIError({ cause }),
+	})
+);