chore(developer): fix commander global options

mcdurdin · mcdurdin · commit e1087ed78107 · 2023-09-22T11:20:48.000+07:00
diff --git a/developer/src/kmc/src/commands/analyze.ts b/developer/src/kmc/src/commands/analyze.ts
@@ -22,22 +22,21 @@ interface AnalysisActivityOptions /* not inheriting from CompilerBaseOptions */
 
 export function declareAnalyze(program: Command) {
   let command = program.command('analyze [infile...]');
-  BaseOptions.addVersion(command);
   declareOskCharUse(command);
   declareOskRewrite(command);
 }
 
 function declareOskCharUse(command: Command) {
   let subCommand = command.command('osk-char-use');
-  BaseOptions.addVersion(subCommand);
   BaseOptions.addLogLevel(subCommand);
   subCommand
     .description('Analyze On Screen Keyboards for character usage')
     .option('-b, --base', 'First PUA codepoint to use, in hexadecimal (default F100)', 'F100')
     .option('--include-counts', 'Include number of times each character is referenced', false)
     .option('--strip-dotted-circle', 'Strip U+25CC (dotted circle base) from results', false)
     .addOption(new Option('-m, --mapping-file <filename>', 'Result file to write to (.json, .md, or .txt)').makeOptionMandatory())
-    .action(async (filenames: string[], options: any) => {
+    .action(async (filenames: string[], _options: any, commander: any) => {
+      const options = commander.optsWithGlobals();
       if(!filenames.length) {
         // If there are no filenames provided, then we are building the current
         // folder ('.') as a project-style build
diff --git a/developer/src/kmc/src/commands/build.ts b/developer/src/kmc/src/commands/build.ts
@@ -11,6 +11,7 @@ import { expandFileLists } from '../util/fileLists.js';
 import { isProject } from '../util/projectLoader.js';
 import { buildTestData } from './buildTestData/index.js';
 import { buildWindowsPackageInstaller } from './buildWindowsPackageInstaller/index.js';
+//import { buildWindowsPackageInstaller } from './buildWindowsPackageInstaller/index.js';
 
 
 function commandOptionsToCompilerOptions(options: any): CompilerOptions {
@@ -32,31 +33,38 @@ function commandOptionsToCompilerOptions(options: any): CompilerOptions {
 }
 
 export function declareBuild(program: Command) {
-  const command = BaseOptions.addAll(program
-    .command('build [infile...]')
-    .description(`Compile one or more source files or projects.`)
+  const buildCommand = program
+    .command('build')
+    .option('--color', 'Force colorization for log messages')
+    .option('--no-color', 'No colorization for log messages; if both omitted, detects from console')
+
+    // These options are only used with build file but are included here so that
+    // they are visible in `kmc build --help`
+    .option('-d, --debug', 'Include debug information in output')
+    .option('-w, --compiler-warnings-as-errors', 'Causes warnings to fail the build; overrides project-level warnings-as-errors option')
+    .option('-W, --no-compiler-warnings-as-errors', 'Warnings do not fail the build; overrides project-level warnings-as-errors option')
+    .option('--no-compiler-version', 'Exclude compiler version metadata from output')
+    .option('--no-warn-deprecated-code', 'Turn off warnings for deprecated code styles');
+
+  BaseOptions.addAll(buildCommand);
+
+  buildCommand.command('file [infile...]', {isDefault: true})
+    .description(`Compile one or more source files or projects ('file' subcommand is default).`)
     .addHelpText('after', `
 Supported file types:
-  * folder: Keyman project in folder
-  * .kpj: Keyman project
-  * .kmn: Keyman keyboard
-  * .xml: LDML keyboard
-  * .model.ts: Keyman lexical model
-  * .kps: Keyman keyboard or lexical model package
+* folder: Keyman project in folder
+* .kpj: Keyman project
+* .kmn: Keyman keyboard
+* .xml: LDML keyboard
+* .model.ts: Keyman lexical model
+* .kps: Keyman keyboard or lexical model package
 
 File lists can be referenced with @filelist.txt.
 
 If no input file is supplied, kmc will build the current folder.`)
-  )
-    .option('-d, --debug', 'Include debug information in output')
-    .option('-w, --compiler-warnings-as-errors', 'Causes warnings to fail the build; overrides project-level warnings-as-errors option')
-    .option('-W, --no-compiler-warnings-as-errors', 'Warnings do not fail the build; overrides project-level warnings-as-errors option')
-    .option('--no-compiler-version', 'Exclude compiler version metadata from output')
-    .option('--no-warn-deprecated-code', 'Turn off warnings for deprecated code styles')
-    .option('--color', 'Force colorization for log messages')
-    .option('--no-color', 'No colorization for log messages; if both omitted, detects from console')
-    .action(async (filenames: string[], options: any) => {
-      options = commandOptionsToCompilerOptions(options);
+
+    .action(async (filenames: string[], _options: any, commander: any) => {
+      const options = commandOptionsToCompilerOptions(commander.optsWithGlobals());
       const callbacks = new NodeCompilerCallbacks(options);
 
       if(!filenames.length) {
@@ -77,12 +85,12 @@ If no input file is supplied, kmc will build the current folder.`)
       }
     });
 
-  command
+  buildCommand
     .command('ldml-test-data <infile>')
     .description('Convert LDML keyboard test .xml to .json')
     .action(buildTestData);
 
-  command
+  buildCommand
     .command('windows-package-installer <infile>')
     .description('Build an executable installer for Windows for a Keyman package')
     .option('--msi <msiFilename>', 'Location of keymandesktop.msi')
diff --git a/developer/src/kmc/src/commands/buildTestData/index.ts b/developer/src/kmc/src/commands/buildTestData/index.ts
@@ -5,7 +5,9 @@ import { CompilerBaseOptions, CompilerCallbacks, defaultCompilerOptions, LDMLKey
 import { NodeCompilerCallbacks } from '../../util/NodeCompilerCallbacks.js';
 import { fileURLToPath } from 'url';
 
-export function buildTestData(infile: string, options: CompilerBaseOptions) {
+export function buildTestData(infile: string, _options: any, commander: any) {
+  const options: CompilerBaseOptions = commander.optsWithGlobals();
+
   let compilerOptions: kmcLdml.LdmlCompilerOptions = {
     ...defaultCompilerOptions,
     ...options,
diff --git a/developer/src/kmc/src/commands/buildWindowsPackageInstaller/index.ts b/developer/src/kmc/src/commands/buildWindowsPackageInstaller/index.ts
@@ -14,7 +14,8 @@ interface WindowsPackageInstallerOptions extends CompilerBaseOptions {
   startWithConfiguration: boolean;
 };
 
-export async function buildWindowsPackageInstaller(infile: string, options: WindowsPackageInstallerOptions) {
+export async function buildWindowsPackageInstaller(infile: string, _options: any, commander: any) {
+  const options: WindowsPackageInstallerOptions = commander.optsWithGlobals();
   const sources: WindowsPackageInstallerSources = {
     licenseFilename: options.license,
     msiFilename: options.msi,
diff --git a/developer/src/kmc/src/kmc.ts b/developer/src/kmc/src/kmc.ts
@@ -3,11 +3,11 @@
  * kmc - Keyman Next Generation Compiler
  */
 
-import { Command } from 'commander';
+import { Command, Option } from 'commander';
 import { declareBuild } from './commands/build.js';
 import { declareAnalyze } from './commands/analyze.js';
-import { BaseOptions } from './util/baseOptions.js';
 import { KeymanSentry } from './util/KeymanSentry.js';
+import KEYMAN_VERSION from "@keymanapp/keyman-version";
 
 await KeymanSentry.runTestIfCLRequested();
 try {
@@ -24,9 +24,19 @@ async function run() {
   /* Arguments */
 
   const program = new Command();
-  program.description('Keyman Developer Command Line Interface');
-  BaseOptions.addVersion(program);
-  BaseOptions.addSentry(program);
+  program
+    .description('Keyman Developer Command Line Interface')
+    .configureHelp({
+      showGlobalOptions: true
+    })
+    .version(KEYMAN_VERSION.VERSION_WITH_TAG)
+
+    // This corresponds to an option tested in KeymanSentry.ts, which is
+    // searched for in process.argv, in order to avoid depending on Commander to
+    // start Sentry, and to ensure that we capture errors as early as possible
+    // in launch
+    .addOption(new Option('--no-error-reporting', 'Disable error reporting to keyman.com (overriding user settings)'))
+    .addOption(new Option('--error-reporting', 'Enable error reporting to keyman.com (overriding user settings)'));
 
   if(await KeymanSentry.isEnabled()) {
     KeymanSentry.init();
diff --git a/developer/src/kmc/src/util/baseOptions.ts b/developer/src/kmc/src/util/baseOptions.ts
@@ -1,24 +1,9 @@
 import { ALL_COMPILER_LOG_FORMATS, ALL_COMPILER_LOG_LEVELS } from "@keymanapp/common-types";
 import { Command, Option } from "commander";
-import KEYMAN_VERSION from "@keymanapp/keyman-version";
 
 // These options map to CompilerBaseOptions
 
 export class BaseOptions {
-  public static addVersion(program: Command) {
-    return program.version(KEYMAN_VERSION.VERSION_WITH_TAG);
-  }
-
-  public static addSentry(program: Command) {
-    // This corresponds to an option tested in KeymanSentry.ts, which is
-    // searched for in process.argv, in order to avoid depending on Commander to
-    // start Sentry, and to ensure that we capture errors as early as possible
-    // in launch
-    return program
-      .addOption(new Option('--no-error-reporting', 'Disable error reporting to keyman.com (overriding user settings)'))
-      .addOption(new Option('--error-reporting', 'Enable error reporting to keyman.com (overriding user settings)'));
-  }
-
   public static addLogLevel(program: Command) {
     return program.addOption(new Option('-l, --log-level <logLevel>', 'Log level').choices(ALL_COMPILER_LOG_LEVELS).default('info'));
   }
@@ -33,7 +18,6 @@ export class BaseOptions {
 
   public static addAll(program: Command) {
     return [
-      this.addVersion,
       this.addLogLevel,
       this.addLogFormat,
       this.addOutFile,
