feat(mod_update): add self-update flow, package name parser, dynamic CLI version, and tests
This commit is contained in:
@@ -1,5 +1,14 @@
|
||||
# Changelog
|
||||
|
||||
## 2026-02-06 - 3.3.0 - feat(mod_update)
|
||||
add self-update flow, package name parser, dynamic CLI version, and tests
|
||||
|
||||
- Add a self-update check in mod_update to detect and optionally update @git.zone/tools (prompts the user or uses --yes).
|
||||
- Introduce PackageManagerUtil.parseYarnPackageName to correctly parse scoped and unscoped yarn package strings and use it when collecting installed packages.
|
||||
- Add comprehensive unit tests for PackageManagerUtil.isNewerVersion and parseYarnPackageName.
|
||||
- Use commitinfo.version for CLI reported version instead of a hardcoded value.
|
||||
- Remove automatic invocation of runCli() from ts/index.ts to avoid immediate execution on import.
|
||||
|
||||
## 2026-02-05 - 3.2.0 - feat(update)
|
||||
enhance package manager detection, version reporting, and add verbose option
|
||||
|
||||
|
||||
@@ -1,9 +1,93 @@
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
import * as tools from '../ts/index.js';
|
||||
import { PackageManagerUtil } from '../ts/mod_update/classes.packagemanager.js';
|
||||
|
||||
tap.test('should export runCli function', async () => {
|
||||
expect(typeof tools.runCli).toEqual('function');
|
||||
});
|
||||
|
||||
// ============================================
|
||||
// isNewerVersion tests
|
||||
// ============================================
|
||||
|
||||
tap.test('isNewerVersion: should detect newer major version', async () => {
|
||||
const pmUtil = new PackageManagerUtil();
|
||||
expect(pmUtil.isNewerVersion('1.0.0', '2.0.0')).toBeTrue();
|
||||
});
|
||||
|
||||
tap.test('isNewerVersion: should detect newer minor version', async () => {
|
||||
const pmUtil = new PackageManagerUtil();
|
||||
expect(pmUtil.isNewerVersion('1.0.0', '1.1.0')).toBeTrue();
|
||||
});
|
||||
|
||||
tap.test('isNewerVersion: should detect newer patch version', async () => {
|
||||
const pmUtil = new PackageManagerUtil();
|
||||
expect(pmUtil.isNewerVersion('1.0.0', '1.0.1')).toBeTrue();
|
||||
});
|
||||
|
||||
tap.test('isNewerVersion: should return false for equal versions', async () => {
|
||||
const pmUtil = new PackageManagerUtil();
|
||||
expect(pmUtil.isNewerVersion('1.0.0', '1.0.0')).toBeFalse();
|
||||
});
|
||||
|
||||
tap.test('isNewerVersion: should return false when current is newer', async () => {
|
||||
const pmUtil = new PackageManagerUtil();
|
||||
expect(pmUtil.isNewerVersion('2.0.0', '1.0.0')).toBeFalse();
|
||||
expect(pmUtil.isNewerVersion('1.1.0', '1.0.0')).toBeFalse();
|
||||
expect(pmUtil.isNewerVersion('1.0.1', '1.0.0')).toBeFalse();
|
||||
});
|
||||
|
||||
tap.test('isNewerVersion: should handle v-prefixed versions', async () => {
|
||||
const pmUtil = new PackageManagerUtil();
|
||||
expect(pmUtil.isNewerVersion('v1.0.0', 'v2.0.0')).toBeTrue();
|
||||
expect(pmUtil.isNewerVersion('v2.0.0', 'v1.0.0')).toBeFalse();
|
||||
});
|
||||
|
||||
tap.test('isNewerVersion: should handle mixed prefixed and non-prefixed', async () => {
|
||||
const pmUtil = new PackageManagerUtil();
|
||||
expect(pmUtil.isNewerVersion('v1.0.0', '2.0.0')).toBeTrue();
|
||||
expect(pmUtil.isNewerVersion('1.0.0', 'v2.0.0')).toBeTrue();
|
||||
});
|
||||
|
||||
tap.test('isNewerVersion: should handle versions with different segment counts', async () => {
|
||||
const pmUtil = new PackageManagerUtil();
|
||||
expect(pmUtil.isNewerVersion('1.0', '1.0.1')).toBeTrue();
|
||||
expect(pmUtil.isNewerVersion('1.0.1', '1.0')).toBeFalse();
|
||||
});
|
||||
|
||||
// ============================================
|
||||
// parseYarnPackageName tests
|
||||
// ============================================
|
||||
|
||||
tap.test('parseYarnPackageName: should parse scoped package correctly', async () => {
|
||||
const result = PackageManagerUtil.parseYarnPackageName('@git.zone/cli@1.2.3');
|
||||
expect(result.name).toEqual('@git.zone/cli');
|
||||
expect(result.version).toEqual('1.2.3');
|
||||
});
|
||||
|
||||
tap.test('parseYarnPackageName: should parse unscoped package correctly', async () => {
|
||||
const result = PackageManagerUtil.parseYarnPackageName('typescript@5.3.2');
|
||||
expect(result.name).toEqual('typescript');
|
||||
expect(result.version).toEqual('5.3.2');
|
||||
});
|
||||
|
||||
tap.test('parseYarnPackageName: should handle empty string', async () => {
|
||||
const result = PackageManagerUtil.parseYarnPackageName('');
|
||||
expect(result.name).toEqual('');
|
||||
expect(result.version).toEqual('unknown');
|
||||
});
|
||||
|
||||
tap.test('parseYarnPackageName: should handle name with no version', async () => {
|
||||
const result = PackageManagerUtil.parseYarnPackageName('@git.zone/cli');
|
||||
expect(result.name).toEqual('@git.zone/cli');
|
||||
expect(result.version).toEqual('unknown');
|
||||
});
|
||||
|
||||
tap.test('parseYarnPackageName: should handle unscoped name with no version', async () => {
|
||||
const result = PackageManagerUtil.parseYarnPackageName('typescript');
|
||||
expect(result.name).toEqual('typescript');
|
||||
expect(result.version).toEqual('unknown');
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
|
||||
@@ -3,6 +3,6 @@
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@git.zone/tools',
|
||||
version: '3.2.0',
|
||||
version: '3.3.0',
|
||||
description: 'A CLI tool placeholder for development utilities.'
|
||||
}
|
||||
|
||||
@@ -3,5 +3,3 @@ import * as cli from './tools.cli.js';
|
||||
export const runCli = async () => {
|
||||
await cli.run();
|
||||
};
|
||||
|
||||
runCli();
|
||||
|
||||
@@ -191,12 +191,11 @@ export class PackageManagerUtil {
|
||||
const data = JSON.parse(line);
|
||||
if (data.type === 'tree' && data.data && data.data.trees) {
|
||||
for (const tree of data.data.trees) {
|
||||
const name = tree.name?.split('@')[0] || '';
|
||||
if (name.startsWith('@git.zone/')) {
|
||||
const version = tree.name?.split('@').pop() || 'unknown';
|
||||
const parsed = PackageManagerUtil.parseYarnPackageName(tree.name || '');
|
||||
if (parsed.name.startsWith('@git.zone/')) {
|
||||
packages.push({
|
||||
name,
|
||||
version,
|
||||
name: parsed.name,
|
||||
version: parsed.version,
|
||||
packageManager: pm,
|
||||
});
|
||||
}
|
||||
@@ -277,6 +276,26 @@ export class PackageManagerUtil {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse a yarn package name string like "@git.zone/cli@1.0.0" into name and version.
|
||||
* Handles scoped packages correctly by splitting on the last '@' (version separator).
|
||||
*/
|
||||
public static parseYarnPackageName(fullName: string): { name: string; version: string } {
|
||||
if (!fullName) {
|
||||
return { name: '', version: 'unknown' };
|
||||
}
|
||||
const lastAtIndex = fullName.lastIndexOf('@');
|
||||
// If lastAtIndex is 0, the string is just "@something" with no version
|
||||
// If lastAtIndex is -1, there's no '@' at all
|
||||
if (lastAtIndex <= 0) {
|
||||
return { name: fullName, version: 'unknown' };
|
||||
}
|
||||
return {
|
||||
name: fullName.substring(0, lastAtIndex),
|
||||
version: fullName.substring(lastAtIndex + 1) || 'unknown',
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Compare two semver versions
|
||||
* Returns true if latest > current
|
||||
|
||||
@@ -1,6 +1,10 @@
|
||||
import * as plugins from './mod.plugins.js';
|
||||
import { PackageManagerUtil, type TPackageManager, type IPackageUpdateInfo, type IPackageManagerInfo } from './classes.packagemanager.js';
|
||||
import { commitinfo } from '../00_commitinfo_data.js';
|
||||
|
||||
// Curated list of known @git.zone CLI tools to track for updates.
|
||||
// This list is intentionally hardcoded to only track official tools.
|
||||
// Add new entries here when new @git.zone packages are published.
|
||||
const GITZONE_PACKAGES = [
|
||||
'@git.zone/cli',
|
||||
'@git.zone/tsdoc',
|
||||
@@ -73,6 +77,54 @@ export const run = async (options: IUpdateOptions = {}): Promise<void> => {
|
||||
|
||||
console.log('');
|
||||
|
||||
// === Self-update check ===
|
||||
console.log('Checking for gtools self-update...\n');
|
||||
const selfVersion = commitinfo.version;
|
||||
const selfLatest = await pmUtil.getLatestVersion('@git.zone/tools');
|
||||
|
||||
if (selfLatest && pmUtil.isNewerVersion(selfVersion, selfLatest)) {
|
||||
console.log(` @git.zone/tools ${selfVersion} → ${selfLatest} ⬆️ Update available\n`);
|
||||
|
||||
// Find which PM has it installed globally
|
||||
let selfPm: TPackageManager | null = null;
|
||||
for (const pmInfo of detectedPMs) {
|
||||
const installed = await pmUtil.getInstalledPackages(pmInfo.name);
|
||||
if (installed.some(p => p.name === '@git.zone/tools')) {
|
||||
selfPm = pmInfo.name;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (!selfPm) {
|
||||
// Fallback: use first available PM
|
||||
selfPm = detectedPMs[0].name;
|
||||
}
|
||||
|
||||
let shouldSelfUpdate = options.yes === true;
|
||||
if (!shouldSelfUpdate) {
|
||||
const smartinteractInstance = new plugins.smartinteract.SmartInteract();
|
||||
const answer = await smartinteractInstance.askQuestion({
|
||||
type: 'confirm',
|
||||
name: 'confirmSelfUpdate',
|
||||
message: 'Do you want to update gtools itself first?',
|
||||
default: true,
|
||||
});
|
||||
shouldSelfUpdate = answer.value === true;
|
||||
}
|
||||
|
||||
if (shouldSelfUpdate) {
|
||||
const success = await pmUtil.executeUpdate(selfPm, '@git.zone/tools');
|
||||
if (success) {
|
||||
console.log('\ngtools has been updated. Please re-run "gtools update" to check remaining packages.');
|
||||
process.exit(0);
|
||||
} else {
|
||||
console.log('\ngtools self-update failed. Continuing with current version...\n');
|
||||
}
|
||||
}
|
||||
} else {
|
||||
console.log(` @git.zone/tools ${selfVersion} ✓ Up to date\n`);
|
||||
}
|
||||
|
||||
// Collect all installed @git.zone packages from all package managers
|
||||
const allPackages: IPackageUpdateInfo[] = [];
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
import * as plugins from './tools.plugins.js';
|
||||
import * as modUpdate from './mod_update/index.js';
|
||||
import { commitinfo } from './00_commitinfo_data.js';
|
||||
|
||||
export const run = async () => {
|
||||
const toolsCli = new plugins.smartcli.Smartcli();
|
||||
@@ -20,6 +21,6 @@ export const run = async () => {
|
||||
await modUpdate.run({ yes: yesFlag, verbose: verboseFlag });
|
||||
});
|
||||
|
||||
toolsCli.addVersion('3.0.0');
|
||||
toolsCli.addVersion(commitinfo.version);
|
||||
toolsCli.startParse();
|
||||
};
|
||||
|
||||
Reference in New Issue
Block a user