@promptbook/cli 0.114.0-10 → 0.114.0-12

package/src/cli/cli-commands/common/harness/HarnessInstallationStatus.ts

@@ -6,11 +6,12 @@ import type { HarnessDefinition } from './HarnessDefinition';
  * - `up-to-date` the newest published version is installed
  * - `outdated` an older version is installed
  * - `not-installed` the harness command is not available globally
+ * - `installed` the harness is installed and automatic update checking was disabled
  * - `unknown` the harness is installed but the newest published version could not be resolved, for example when offline
  *
  * @private internal utility of `promptbookCli`
  */
-export type HarnessInstallationState = 'up-to-date' | 'outdated' | 'not-installed' | 'unknown';
+export type HarnessInstallationState = 'up-to-date' | 'outdated' | 'not-installed' | 'installed' | 'unknown';
 
 /**
  * Installation state of one CLI coding harness on the current machine.
@@ -24,7 +25,7 @@ export type HarnessInstallationStatus = {
     readonly definition: HarnessDefinition;
 
     /**
-     * Comparison of the installed version with the newest published one.
+     * Installation state, including whether the newest published version was checked.
      */
     readonly installationState: HarnessInstallationState;
 

package/src/cli/cli-commands/common/harnessUpdateCliOptions.ts

@@ -0,0 +1,49 @@
+import type {
+    Command as Program /* <- Note: [🔸] Using Program because Command is misleading name */,
+} from 'commander';
+
+/**
+ * Commander option bag for opting out of automatic coding-harness update checks.
+ *
+ * @private internal utility of `promptbookCli`
+ */
+export type HarnessUpdateCliOptions = {
+    readonly harnessUpdate: boolean;
+};
+
+/**
+ * Normalized automatic coding-harness update-check option.
+ *
+ * @private internal utility of `promptbookCli`
+ */
+export type NormalizedHarnessUpdateCliOptions = {
+    readonly isHarnessUpdateCheckEnabled: boolean;
+};
+
+/**
+ * Registers the shared `--no-harness-update` option on a `ptbk coder` command that uses a coding harness.
+ *
+ * @private internal utility of `promptbookCli`
+ */
+export function addHarnessUpdateOption(command: Program): void {
+    command.option(
+        '--no-harness-update',
+        'Skip checking whether globally installed coding harnesses are up to date',
+    );
+}
+
+/**
+ * Converts the Commander harness-update flag into the normalized harness-check option.
+ *
+ * @private internal utility of `promptbookCli`
+ */
+export function normalizeHarnessUpdateCliOptions(
+    cliOptions: HarnessUpdateCliOptions,
+): NormalizedHarnessUpdateCliOptions {
+    return {
+        isHarnessUpdateCheckEnabled: cliOptions.harnessUpdate,
+    };
+}
+
+// Note: [🟡] Code for CLI harness update options [harnessUpdateCliOptions](src/cli/cli-commands/common/harnessUpdateCliOptions.ts) should never be published outside of `@promptbook/cli`
+// Note: [💞] Ignore a discrepancy between file name and exported helper names

package/src/executables/platforms/locateAppOnWindows.ts

@@ -1,4 +1,4 @@
-import { join } from 'path';
+import { delimiter, join } from 'path';
 import { assertsError } from '../../errors/assertsError';
 import { $provideFilesystemForNode } from '../../scrapers/_common/register/$provideFilesystemForNode';
 import type { string_executable_path } from '../../types/string_filename';
@@ -6,7 +6,7 @@ import { isExecutable } from '../../utils/files/isExecutable';
 import type { LocateAppOptions } from '../locateApp';
 
 /**
- * Attempts to locate the specified application on a Windows system by searching common installation directories.
+ * Attempts to locate the specified application on a Windows system by searching PATH and common installation directories.
  * Returns the path to the executable if found, or null otherwise.
  *
  * @private within the repository
@@ -16,18 +16,21 @@ export async function locateAppOnWindows({
     windowsSuffix,
 }: Pick<Required<LocateAppOptions>, 'appName' | 'windowsSuffix'>): Promise<string_executable_path | null> {
     try {
-        const prefixes = [
+        const EXECUTABLE_FILENAME = windowsSuffix.replace(/^.*[\\/]/, '');
+        const PATH_EXECUTABLE_PATHS = (process.env.PATH || '')
+            .split(delimiter)
+            .filter(Boolean)
+            .map((pathPrefix) => join(pathPrefix, EXECUTABLE_FILENAME));
+        const INSTALLATION_EXECUTABLE_PATHS = [
             process.env.LOCALAPPDATA,
             join(process.env.LOCALAPPDATA || '', 'Programs'),
             process.env.PROGRAMFILES,
             process.env['PROGRAMFILES(X86)'],
-        ];
+        ].map((pathPrefix) => pathPrefix + windowsSuffix);
 
-        for (const prefix of prefixes) {
-            const path = prefix + windowsSuffix;
-
-            if (await isExecutable(path, $provideFilesystemForNode())) {
-                return path;
+        for (const executablePath of [...PATH_EXECUTABLE_PATHS, ...INSTALLATION_EXECUTABLE_PATHS]) {
+            if (await isExecutable(executablePath, $provideFilesystemForNode())) {
+                return executablePath;
             }
         }