@travetto/repo 3.0.3 → 3.1.0-rc.1

package/README.md

@@ -20,16 +20,15 @@ The versioning operation will find all the changed modules (and the modules that
 
 **Terminal: Version execution**
 ```bash
-$ trv repo:version
+$ trv repo:version -h
 
-Please specify a level to continue
-
-Usage: trv repo:version [options] <level> [prefix]
+Usage: repo:version [options] <level:string> [prefix:string]
 
 Options:
-  -c, --no-changed  Disables: Only version changed modules
-  -f, --force       Force operation, even in a dirty workspace
-  -h, --help        display help for command
+  --changed, --no-changed  Only version changed modules (default: true)
+  -f, --force              Force operation, even in a dirty workspace (default: false)
+  --commit, --no-commit    Produce release commit message (default: true)
+  -h, --help               display help for command
 ```
 
 Level is a standard semver level of: major, minor, patch or prerelease.  The prefix argument only applies to the prerelease and allows for determining the prerelease level.  For example:
@@ -48,7 +47,7 @@ Author: Travetto Framework <travetto.framework@gmail.com>
 Date:   Thu Feb 23 17:51:37 2023 -0500
 Date:   Thu Feb 23 17:51:37 2023 -0500
 
-    Publish @travetto/app,@travetto/asset,@travetto/asset-rest,@travetto/auth,@travetto/auth-model,@travetto/auth-rest,@travetto/auth-rest-context,@travetto/auth-rest-jwt,@travetto/auth-rest-passport,@travetto/auth-rest-session,...
+    Publish @travetto/asset,@travetto/asset-rest,@travetto/auth,@travetto/auth-model,@travetto/auth-rest,@travetto/auth-rest-context,@travetto/auth-rest-jwt,@travetto/auth-rest-passport,@travetto/auth-rest-session,...
 ```
 
 ## CLI - Publish
@@ -58,18 +57,18 @@ The publish functionality is relatively naive, but consistent.  The code will lo
 ```bash
 $ trv repo:publish -h
 
-Usage:  repo:publish [options]
+Usage: repo:publish [options]
 
 Options:
-  -d, --no-dry-run  Disables: Dry Run?
-  -h, --help        display help for command
+  --dry-run, --no-dry-run  Dry Run? (default: true)
+  -h, --help               display help for command
 ```
 
 By default the tool will execute a dry run only, and requires passing a flag to disable the dry run.
 
 **Terminal: Publishing changes**
 ```bash
-npx trv repo:publish -d
+npx trv repo:publish --no-dry-run
 ```
 
 If no modules are currently changed, then the command will indicate there is no work to do, and exit gracefully.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/repo",
-  "version": "3.0.3",
+  "version": "3.1.0-rc.1",
   "description": "Monorepo utilities",
   "keywords": [
     "travetto",
@@ -21,7 +21,7 @@
     "directory": "module/repo"
   },
   "dependencies": {
-    "@travetto/cli": "^3.0.3"
+    "@travetto/cli": "^3.1.0-rc.1"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/support/bin/package-manager.ts

@@ -1,7 +1,7 @@
 import { ExecUtil, ExecutionOptions, ExecutionState, ExecutionResult } from '@travetto/base';
 import { IndexedModule, ManifestContext } from '@travetto/manifest';
 
-export type SemverLevel = 'minor' | 'patch' | 'major' | 'prerelease';
+export type SemverLevel = 'minor' | 'patch' | 'major' | 'prerelease' | 'premajor' | 'preminor' | 'prepatch';
 
 /**
  * Utilities for working with package managers

package/support/cli.repo_publish.ts

@@ -1,28 +1,18 @@
-import { CliCommand, CliModuleUtil, OptionConfig } from '@travetto/cli';
+import { CliCommandShape, CliCommand, CliModuleUtil } from '@travetto/cli';
 import { RootIndex } from '@travetto/manifest';
 
 import { PackageManager } from './bin/package-manager';
 
-type Options = {
-  dryRun: OptionConfig<boolean>;
-};
-
 /**
-* `npx trv repo:publish`
-*
-* Publish all pending modules
-*/
-export class RepoPublishCommand extends CliCommand<Options> {
-
-  name = 'repo:publish';
+ * Publish all pending modules
+ */
+@CliCommand()
+export class RepoPublishCommand implements CliCommandShape {
 
-  getOptions(): Options {
-    return {
-      dryRun: this.boolOption({ desc: 'Dry Run?', def: true })
-    };
-  }
+  /** Dry Run? */
+  dryRun = true;
 
-  async action(...args: unknown[]): Promise<void> {
+  async main(): Promise<void> {
     const published = await CliModuleUtil.execOnModules('all', (mod, opts) => PackageManager.isPublished(RootIndex.manifest, mod, opts), {
       filter: mod => !!mod.local && !mod.internal,
       progressMessage: (mod) => `Checking published [%idx/%total] -- ${mod?.name}`,
@@ -30,12 +20,12 @@ export class RepoPublishCommand extends CliCommand<Options> {
       transformResult: (mod, res) => PackageManager.validatePublishedResult(RootIndex.manifest, mod, res),
     });
 
-    if (this.cmd.dryRun) {
+    if (this.dryRun) {
       console.log('Unpublished modules', [...published.entries()].filter(x => !x[1]).map(([mod]) => mod.sourceFolder));
     }
 
     await CliModuleUtil.execOnModules(
-      'all', (mod, opts) => PackageManager.publish(RootIndex.manifest, mod, this.cmd.dryRun, opts),
+      'all', (mod, opts) => PackageManager.publish(RootIndex.manifest, mod, this.dryRun, opts),
       {
         progressMessage: (mod) => `Published [%idx/%total] -- ${mod?.name}`,
         showStdout: false,

package/support/cli.repo_version.ts

@@ -1,57 +1,43 @@
-import { CliCommand, CliScmUtil, OptionConfig } from '@travetto/cli';
+import { CliCommandShape, CliCommand, CliScmUtil, CliValidationError } from '@travetto/cli';
 import { CliModuleUtil } from '@travetto/cli/src/module';
 import { RootIndex } from '@travetto/manifest';
 
 import { PackageManager, SemverLevel } from './bin/package-manager';
 
-type VersionOptions = {
-  changed: OptionConfig<boolean>;
-  force: OptionConfig<boolean>;
-};
-
 /**
-* `npx trv repo:version`
-*
-* Version all all changed dependencies
-*/
-export class RepoVersionCommand extends CliCommand<VersionOptions> {
-
-  name = 'repo:version';
-
-  getArgs(): string {
-    return '<level> [prefix]';
-  }
-
-  getOptions(): VersionOptions {
-    return {
-      changed: this.boolOption({ desc: 'Only version changed modules', def: true }),
-      force: this.boolOption({ desc: 'Force operation, even in a dirty workspace', def: false })
-    };
-  }
-
-  async action(level: SemverLevel, prefix?: string): Promise<void> {
-    if (!level) {
-      return this.showHelp('Please specify a level to continue');
-    }
-
-    if (!this.cmd.force && await CliScmUtil.isWorkspaceDirty()) {
-      return this.showHelp('Cannot update versions with uncommitted changes');
+ * Version all changed dependencies
+ */
+@CliCommand()
+export class RepoVersionCommand implements CliCommandShape {
+  /** Only version changed modules */
+  changed = true;
+  /** Force operation, even in a dirty workspace */
+  force = false;
+  /** Produce release commit message */
+  commit = true;
+
+  async validate(...args: unknown[]): Promise<CliValidationError | undefined> {
+    if (!this.force && await CliScmUtil.isWorkspaceDirty()) {
+      return { message: 'Cannot update versions with uncommitted changes' };
     }
+  }
 
-    const allModules = await CliModuleUtil.findModules(this.cmd.changed ? 'changed' : 'all');
+  async main(level: SemverLevel, prefix?: string): Promise<void> {
+    const allModules = await CliModuleUtil.findModules(this.changed ? 'changed' : 'all');
 
     const modules = allModules.filter(x => !x.internal);
 
     // Do we have valid changes?
     if (!modules.length) {
-      console.error!('No modules available for versioning');
-      return this.exit(1);
+      throw new Error('No modules available for versioning');
     }
 
     await PackageManager.version(RootIndex.manifest, modules, level, prefix);
 
     const versions = await CliModuleUtil.synchronizeModuleVersions();
-
-    console.log!(await CliScmUtil.createCommit(`Publish ${modules.map(x => `${x.name}#${versions[x.name]?.replace('^', '') ?? x.version}`).join(',')}`));
+    if (this.commit) {
+      const commitMessage = `Publish ${modules.map(x => `${x.name}#${versions[x.name]?.replace('^', '') ?? x.version}`).join(',')}`;
+      console.log!(await CliScmUtil.createCommit(commitMessage));
+    }
   }
 }