@promptbook/cli 0.114.0-26 → 0.114.0-28
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm/index.es.js +374 -60
- package/esm/index.es.js.map +1 -1
- package/esm/src/cli/cli-commands/common/harness/$applyHarnessInstallationStatus.d.ts +1 -1
- package/esm/src/cli/cli-commands/common/harness/$resolveHarnessCommandPath.d.ts +14 -0
- package/esm/src/cli/cli-commands/common/harness/$resolveHarnessInstallationOrigin.d.ts +10 -0
- package/esm/src/cli/cli-commands/common/harness/$runHarnessInstallationCommand.d.ts +43 -0
- package/esm/src/cli/cli-commands/common/harness/HarnessDefinition.d.ts +26 -0
- package/esm/src/cli/cli-commands/common/harness/HarnessInstallationOrigin.d.ts +36 -0
- package/esm/src/cli/cli-commands/common/harness/HarnessInstallationStatus.d.ts +5 -0
- package/esm/src/cli/cli-commands/common/harness/HarnessUpdatePlan.d.ts +23 -0
- package/esm/src/cli/cli-commands/common/harness/buildHarnessInstallCommand.d.ts +4 -1
- package/esm/src/cli/cli-commands/common/harness/formatHarnessManualUpdateInstruction.d.ts +8 -0
- package/esm/src/cli/cli-commands/common/harness/formatHarnessManualUpdateInstruction.test.d.ts +1 -0
- package/esm/src/cli/cli-commands/common/harness/resolveHarnessInstallationMethodFromPaths.d.ts +31 -0
- package/esm/src/cli/cli-commands/common/harness/resolveHarnessInstallationMethodFromPaths.test.d.ts +1 -0
- package/esm/src/cli/cli-commands/common/harness/resolveHarnessUpdatePlan.d.ts +12 -0
- package/esm/src/cli/cli-commands/common/harness/resolveHarnessUpdatePlan.test.d.ts +1 -0
- package/esm/src/cli/cli-commands/common/npm/$resolveNpmGlobalPrefixPath.d.ts +9 -0
- package/esm/src/version.d.ts +1 -1
- package/package.json +1 -1
- package/src/cli/cli-commands/coder/init.ts +1 -1
- package/src/cli/cli-commands/coder/ping.ts +1 -1
- package/src/cli/cli-commands/coder/run.ts +1 -1
- package/src/cli/cli-commands/coder/server.ts +1 -1
- package/src/cli/cli-commands/common/harness/$applyHarnessInstallationStatus.ts +57 -8
- package/src/cli/cli-commands/common/harness/$checkHarnessInstallation.ts +8 -1
- package/src/cli/cli-commands/common/harness/$resolveHarnessCommandPath.ts +46 -0
- package/src/cli/cli-commands/common/harness/$resolveHarnessInstallationOrigin.ts +36 -0
- package/src/cli/cli-commands/common/harness/$runHarnessInstallationCommand.ts +100 -0
- package/src/cli/cli-commands/common/harness/HarnessDefinition.ts +34 -0
- package/src/cli/cli-commands/common/harness/HarnessInstallationOrigin.ts +44 -0
- package/src/cli/cli-commands/common/harness/HarnessInstallationStatus.ts +6 -0
- package/src/cli/cli-commands/common/harness/HarnessUpdatePlan.ts +27 -0
- package/src/cli/cli-commands/common/harness/buildHarnessInstallCommand.ts +4 -1
- package/src/cli/cli-commands/common/harness/formatHarnessInstallationWarning.ts +28 -6
- package/src/cli/cli-commands/common/harness/formatHarnessManualUpdateInstruction.ts +41 -0
- package/src/cli/cli-commands/common/harness/resolveHarnessInstallationMethodFromPaths.ts +111 -0
- package/src/cli/cli-commands/common/harness/resolveHarnessUpdatePlan.ts +47 -0
- package/src/cli/cli-commands/common/harnessUpdateCliOptions.ts +1 -1
- package/src/cli/cli-commands/common/npm/$resolveNpmGlobalPrefixPath.ts +51 -0
- package/src/other/templates/getTemplatesPipelineCollection.ts +816 -870
- package/src/version.ts +2 -2
- package/src/versions.txt +2 -0
- package/umd/index.umd.js +374 -60
- package/umd/index.umd.js.map +1 -1
- package/umd/src/cli/cli-commands/common/harness/$applyHarnessInstallationStatus.d.ts +1 -1
- package/umd/src/cli/cli-commands/common/harness/$resolveHarnessCommandPath.d.ts +14 -0
- package/umd/src/cli/cli-commands/common/harness/$resolveHarnessInstallationOrigin.d.ts +10 -0
- package/umd/src/cli/cli-commands/common/harness/$runHarnessInstallationCommand.d.ts +43 -0
- package/umd/src/cli/cli-commands/common/harness/HarnessDefinition.d.ts +26 -0
- package/umd/src/cli/cli-commands/common/harness/HarnessInstallationOrigin.d.ts +36 -0
- package/umd/src/cli/cli-commands/common/harness/HarnessInstallationStatus.d.ts +5 -0
- package/umd/src/cli/cli-commands/common/harness/HarnessUpdatePlan.d.ts +23 -0
- package/umd/src/cli/cli-commands/common/harness/buildHarnessInstallCommand.d.ts +4 -1
- package/umd/src/cli/cli-commands/common/harness/formatHarnessManualUpdateInstruction.d.ts +8 -0
- package/umd/src/cli/cli-commands/common/harness/formatHarnessManualUpdateInstruction.test.d.ts +1 -0
- package/umd/src/cli/cli-commands/common/harness/resolveHarnessInstallationMethodFromPaths.d.ts +31 -0
- package/umd/src/cli/cli-commands/common/harness/resolveHarnessInstallationMethodFromPaths.test.d.ts +1 -0
- package/umd/src/cli/cli-commands/common/harness/resolveHarnessUpdatePlan.d.ts +12 -0
- package/umd/src/cli/cli-commands/common/harness/resolveHarnessUpdatePlan.test.d.ts +1 -0
- package/umd/src/cli/cli-commands/common/npm/$resolveNpmGlobalPrefixPath.d.ts +9 -0
- package/umd/src/version.d.ts +1 -1
- package/esm/src/cli/cli-commands/common/harness/$installHarness.d.ts +0 -13
- package/src/cli/cli-commands/common/harness/$installHarness.ts +0 -56
- package/umd/src/cli/cli-commands/common/harness/$installHarness.d.ts +0 -13
package/esm/index.es.js
CHANGED
|
@@ -48,7 +48,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
|
|
|
48
48
|
* @generated
|
|
49
49
|
* @see https://github.com/webgptorg/promptbook
|
|
50
50
|
*/
|
|
51
|
-
const PROMPTBOOK_ENGINE_VERSION = '0.114.0-
|
|
51
|
+
const PROMPTBOOK_ENGINE_VERSION = '0.114.0-28';
|
|
52
52
|
/**
|
|
53
53
|
* TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
|
|
54
54
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
@@ -3703,7 +3703,7 @@ async function resolveAgentsServerAppPath() {
|
|
|
3703
3703
|
*
|
|
3704
3704
|
* @private internal constant of `buildAgentsServer`
|
|
3705
3705
|
*/
|
|
3706
|
-
const NODE_MODULES_DIRECTORY_NAME$
|
|
3706
|
+
const NODE_MODULES_DIRECTORY_NAME$2 = 'node_modules';
|
|
3707
3707
|
|
|
3708
3708
|
/**
|
|
3709
3709
|
* Returns true when one path is nested below a `node_modules` segment.
|
|
@@ -3711,7 +3711,7 @@ const NODE_MODULES_DIRECTORY_NAME$1 = 'node_modules';
|
|
|
3711
3711
|
* @private internal utility of `buildAgentsServer`
|
|
3712
3712
|
*/
|
|
3713
3713
|
function isPathInsideNodeModules(path) {
|
|
3714
|
-
return path.split(/[\\/]+/u).includes(NODE_MODULES_DIRECTORY_NAME$
|
|
3714
|
+
return path.split(/[\\/]+/u).includes(NODE_MODULES_DIRECTORY_NAME$2);
|
|
3715
3715
|
}
|
|
3716
3716
|
|
|
3717
3717
|
/**
|
|
@@ -3824,7 +3824,7 @@ async function copyAgentsServerRuntimePath(options) {
|
|
|
3824
3824
|
* Links the materialized runtime back to the package dependency tree used by the installed CLI.
|
|
3825
3825
|
*/
|
|
3826
3826
|
async function ensureMaterializedRuntimeNodeModulesLink(options) {
|
|
3827
|
-
const nodeModulesLinkPath = join(options.materializedRuntimeRootPath, NODE_MODULES_DIRECTORY_NAME$
|
|
3827
|
+
const nodeModulesLinkPath = join(options.materializedRuntimeRootPath, NODE_MODULES_DIRECTORY_NAME$2);
|
|
3828
3828
|
try {
|
|
3829
3829
|
const existingLinkStats = await lstat(nodeModulesLinkPath);
|
|
3830
3830
|
await rm(nodeModulesLinkPath, {
|
|
@@ -3910,7 +3910,7 @@ function resolveNextCliPath() {
|
|
|
3910
3910
|
*/
|
|
3911
3911
|
function resolveNodeModulesPath(nextCliPath) {
|
|
3912
3912
|
const normalizedNextCliPath = nextCliPath.replace(/\\/gu, '/');
|
|
3913
|
-
const marker = `/${NODE_MODULES_DIRECTORY_NAME$
|
|
3913
|
+
const marker = `/${NODE_MODULES_DIRECTORY_NAME$2}/next/`;
|
|
3914
3914
|
const markerIndex = normalizedNextCliPath.lastIndexOf(marker);
|
|
3915
3915
|
if (markerIndex === -1) {
|
|
3916
3916
|
return resolve(nextCliPath, '..', '..', '..');
|
|
@@ -24118,6 +24118,11 @@ const HARNESS_DEFINITIONS = {
|
|
|
24118
24118
|
label: 'OpenAI Codex',
|
|
24119
24119
|
commandName: 'codex',
|
|
24120
24120
|
npmPackageName: '@openai/codex',
|
|
24121
|
+
// Note: The official standalone installer keeps its package in `~/.codex` and links it onto the `PATH`
|
|
24122
|
+
standaloneInstallation: {
|
|
24123
|
+
directoryNames: ['.codex'],
|
|
24124
|
+
updateCommand: 'codex update',
|
|
24125
|
+
},
|
|
24121
24126
|
},
|
|
24122
24127
|
'github-copilot': {
|
|
24123
24128
|
harnessName: 'github-copilot',
|
|
@@ -43088,6 +43093,53 @@ async function $askForNpmPackageInstallationApproval(question) {
|
|
|
43088
43093
|
}
|
|
43089
43094
|
// Note: [🟡] Code for CLI npm package installation approval [$askForNpmPackageInstallationApproval](src/cli/cli-commands/common/npm/$askForNpmPackageInstallationApproval.ts) should never be published outside of `@promptbook/cli`
|
|
43090
43095
|
|
|
43096
|
+
/**
|
|
43097
|
+
* Words describing each operation in the terminal output.
|
|
43098
|
+
*/
|
|
43099
|
+
const HARNESS_INSTALLATION_OPERATION_WORDS = {
|
|
43100
|
+
install: { running: 'Installing', finished: 'installed' },
|
|
43101
|
+
update: { running: 'Updating', finished: 'updated' },
|
|
43102
|
+
};
|
|
43103
|
+
/**
|
|
43104
|
+
* Runs one command which installs or updates a CLI coding harness.
|
|
43105
|
+
*
|
|
43106
|
+
* A failed installation is reported but never aborts the running command, because the harness check
|
|
43107
|
+
* is only an assistant - the command itself may still work with a manually managed harness.
|
|
43108
|
+
*
|
|
43109
|
+
* Note: `$` is used to indicate that this function is not a pure function - it installs software
|
|
43110
|
+
*
|
|
43111
|
+
* @returns `true` when the command succeeded, `false` when it failed
|
|
43112
|
+
* @private internal utility of `promptbookCli`
|
|
43113
|
+
*/
|
|
43114
|
+
async function $runHarnessInstallationCommand(options) {
|
|
43115
|
+
const { definition, operation, command, environment } = options;
|
|
43116
|
+
const operationWords = HARNESS_INSTALLATION_OPERATION_WORDS[operation];
|
|
43117
|
+
console.info(colors.cyan(`${operationWords.running} ${definition.label} with \`${command}\`...`));
|
|
43118
|
+
try {
|
|
43119
|
+
await $execCommand({
|
|
43120
|
+
command,
|
|
43121
|
+
crashOnError: true,
|
|
43122
|
+
isVerbose: true,
|
|
43123
|
+
env: environment ? { ...environment } : undefined,
|
|
43124
|
+
});
|
|
43125
|
+
}
|
|
43126
|
+
catch (error) {
|
|
43127
|
+
assertsError(error);
|
|
43128
|
+
const installErrorMessage = error.message;
|
|
43129
|
+
console.error(colors.red(spaceTrim$1((block) => `
|
|
43130
|
+
Could not ${operation} **${definition.label}**.
|
|
43131
|
+
|
|
43132
|
+
Run \`${command}\` manually and run the command again.
|
|
43133
|
+
|
|
43134
|
+
${block(installErrorMessage)}
|
|
43135
|
+
`)));
|
|
43136
|
+
return false;
|
|
43137
|
+
}
|
|
43138
|
+
console.info(colors.green(`${definition.label} has been ${operationWords.finished}.`));
|
|
43139
|
+
return true;
|
|
43140
|
+
}
|
|
43141
|
+
// Note: [🟡] Code for CLI harness installation commands [$runHarnessInstallationCommand](src/cli/cli-commands/common/harness/$runHarnessInstallationCommand.ts) should never be published outside of `@promptbook/cli`
|
|
43142
|
+
|
|
43091
43143
|
/**
|
|
43092
43144
|
* Builds an npm command which installs or updates a package in the requested existing location.
|
|
43093
43145
|
*
|
|
@@ -43107,9 +43159,12 @@ function buildNpmPackageInstallCommand(npmPackageName, installationLocation) {
|
|
|
43107
43159
|
/**
|
|
43108
43160
|
* Builds the shell command which installs or updates one CLI coding harness globally.
|
|
43109
43161
|
*
|
|
43110
|
-
* The very same command is executed by `$
|
|
43162
|
+
* The very same command is executed by `$runHarnessInstallationCommand` and printed as the manual fallback,
|
|
43111
43163
|
* so the user always sees exactly what Promptbook would run.
|
|
43112
43164
|
*
|
|
43165
|
+
* Note: This command installs the harness through npm, so it may only update a harness which npm really owns,
|
|
43166
|
+
* see `resolveHarnessUpdatePlan`.
|
|
43167
|
+
*
|
|
43113
43168
|
* @private internal utility of `promptbookCli`
|
|
43114
43169
|
*/
|
|
43115
43170
|
function buildHarnessInstallCommand(definition) {
|
|
@@ -43118,76 +43173,114 @@ function buildHarnessInstallCommand(definition) {
|
|
|
43118
43173
|
// Note: [🟡] Code for CLI harness install command [buildHarnessInstallCommand](src/cli/cli-commands/common/harness/buildHarnessInstallCommand.ts) should never be published outside of `@promptbook/cli`
|
|
43119
43174
|
|
|
43120
43175
|
/**
|
|
43121
|
-
*
|
|
43122
|
-
|
|
43123
|
-
|
|
43124
|
-
|
|
43125
|
-
|
|
43126
|
-
|
|
43176
|
+
* Human-readable description of each way a harness can be installed.
|
|
43177
|
+
*/
|
|
43178
|
+
const HARNESS_INSTALLATION_METHOD_DESCRIPTIONS = {
|
|
43179
|
+
'npm-global': 'global npm installation',
|
|
43180
|
+
standalone: 'standalone installation',
|
|
43181
|
+
homebrew: 'Homebrew installation',
|
|
43182
|
+
unknown: 'unknown installation method',
|
|
43183
|
+
};
|
|
43184
|
+
/**
|
|
43185
|
+
* Formats the warning shown when a harness is missing or outdated.
|
|
43127
43186
|
*
|
|
43128
|
-
* @returns `true` when the harness has been installed, `false` when the installation failed
|
|
43129
43187
|
* @private internal utility of `promptbookCli`
|
|
43130
43188
|
*/
|
|
43131
|
-
|
|
43132
|
-
const
|
|
43133
|
-
|
|
43134
|
-
|
|
43135
|
-
|
|
43136
|
-
command: installCommand,
|
|
43137
|
-
crashOnError: true,
|
|
43138
|
-
isVerbose: true,
|
|
43139
|
-
env: definition.npmInstallEnvironment ? { ...definition.npmInstallEnvironment } : undefined,
|
|
43140
|
-
});
|
|
43141
|
-
}
|
|
43142
|
-
catch (error) {
|
|
43143
|
-
assertsError(error);
|
|
43144
|
-
const installErrorMessage = error.message;
|
|
43145
|
-
console.error(colors.red(spaceTrim$1((block) => `
|
|
43146
|
-
Could not install **${definition.label}**.
|
|
43147
|
-
|
|
43148
|
-
Install it manually with \`${installCommand}\` and run the command again.
|
|
43189
|
+
function formatHarnessInstallationWarning(status) {
|
|
43190
|
+
const { definition, installedVersion, latestVersion, installationOrigin } = status;
|
|
43191
|
+
if (status.installationState === 'not-installed') {
|
|
43192
|
+
return spaceTrim$1(`
|
|
43193
|
+
**${definition.label}** is not installed globally.
|
|
43149
43194
|
|
|
43150
|
-
|
|
43151
|
-
|
|
43152
|
-
return false;
|
|
43195
|
+
The \`${definition.commandName}\` command was not found, so the \`${definition.harnessName}\` harness cannot run.
|
|
43196
|
+
`);
|
|
43153
43197
|
}
|
|
43154
|
-
|
|
43155
|
-
|
|
43198
|
+
const warningLines = [
|
|
43199
|
+
`**${definition.label}** is outdated.`,
|
|
43200
|
+
'',
|
|
43201
|
+
`Installed version: \`${installedVersion}\``,
|
|
43202
|
+
`Newest version: \`${latestVersion}\``,
|
|
43203
|
+
];
|
|
43204
|
+
if (installationOrigin.commandPath !== null) {
|
|
43205
|
+
const installationMethodDescription = HARNESS_INSTALLATION_METHOD_DESCRIPTIONS[installationOrigin.installationMethod];
|
|
43206
|
+
warningLines.push(`Installed command: \`${installationOrigin.commandPath}\` *(${installationMethodDescription})*`);
|
|
43207
|
+
}
|
|
43208
|
+
return spaceTrim$1(warningLines.join('\n'));
|
|
43156
43209
|
}
|
|
43157
|
-
// Note: [🟡] Code for CLI harness installation [
|
|
43210
|
+
// Note: [🟡] Code for CLI harness installation warning [formatHarnessInstallationWarning](src/cli/cli-commands/common/harness/formatHarnessInstallationWarning.ts) should never be published outside of `@promptbook/cli`
|
|
43158
43211
|
|
|
43159
43212
|
/**
|
|
43160
|
-
* Formats the
|
|
43213
|
+
* Formats the instruction shown when an outdated harness must be updated by the user.
|
|
43161
43214
|
*
|
|
43162
43215
|
* @private internal utility of `promptbookCli`
|
|
43163
43216
|
*/
|
|
43164
|
-
function
|
|
43165
|
-
const { definition,
|
|
43166
|
-
|
|
43217
|
+
function formatHarnessManualUpdateInstruction(status, updatePlan) {
|
|
43218
|
+
const { definition, installationOrigin } = status;
|
|
43219
|
+
const commandLocation = installationOrigin.commandPath === null
|
|
43220
|
+
? `The \`${definition.commandName}\` command`
|
|
43221
|
+
: `The \`${definition.commandName}\` command at \`${installationOrigin.commandPath}\``;
|
|
43222
|
+
if (updatePlan.command !== null) {
|
|
43167
43223
|
return spaceTrim$1(`
|
|
43168
|
-
|
|
43224
|
+
${commandLocation} is not managed by npm, so Promptbook leaves it alone.
|
|
43169
43225
|
|
|
43170
|
-
|
|
43226
|
+
Update it manually with \`${updatePlan.command}\`.
|
|
43171
43227
|
`);
|
|
43172
43228
|
}
|
|
43229
|
+
const unknownInstallationReason = installationOrigin.commandPath === null ? 'could not be located' : 'is not inside the global npm prefix';
|
|
43230
|
+
const npmInstallCommand = buildHarnessInstallCommand(definition);
|
|
43173
43231
|
return spaceTrim$1(`
|
|
43174
|
-
|
|
43232
|
+
${commandLocation} ${unknownInstallationReason}, so Promptbook cannot tell how it was installed.
|
|
43175
43233
|
|
|
43176
|
-
|
|
43177
|
-
Newest version: \`${latestVersion}\`
|
|
43234
|
+
Update it the same way it was installed - \`${npmInstallCommand}\` would install a **second** copy of ${definition.label} instead of updating the one which is really used.
|
|
43178
43235
|
`);
|
|
43179
43236
|
}
|
|
43180
|
-
// Note: [🟡] Code for CLI harness
|
|
43237
|
+
// Note: [🟡] Code for CLI harness manual update instruction [formatHarnessManualUpdateInstruction](src/cli/cli-commands/common/harness/formatHarnessManualUpdateInstruction.ts) should never be published outside of `@promptbook/cli`
|
|
43238
|
+
|
|
43239
|
+
/**
|
|
43240
|
+
* Decides how one outdated CLI coding harness should be updated.
|
|
43241
|
+
*
|
|
43242
|
+
* The plan follows the way the harness was installed, because `npm install -g` updates only a harness
|
|
43243
|
+
* which npm owns and installs a **second** copy of every other one.
|
|
43244
|
+
*
|
|
43245
|
+
* @private internal utility of `promptbookCli`
|
|
43246
|
+
*/
|
|
43247
|
+
function resolveHarnessUpdatePlan(definition, installationMethod) {
|
|
43248
|
+
if (installationMethod === 'npm-global') {
|
|
43249
|
+
return {
|
|
43250
|
+
command: buildHarnessInstallCommand(definition),
|
|
43251
|
+
isRunnableByPromptbook: true,
|
|
43252
|
+
environment: definition.npmInstallEnvironment,
|
|
43253
|
+
};
|
|
43254
|
+
}
|
|
43255
|
+
if (installationMethod === 'standalone' && definition.standaloneInstallation !== undefined) {
|
|
43256
|
+
return {
|
|
43257
|
+
command: definition.standaloneInstallation.updateCommand,
|
|
43258
|
+
isRunnableByPromptbook: true,
|
|
43259
|
+
};
|
|
43260
|
+
}
|
|
43261
|
+
if (installationMethod === 'homebrew') {
|
|
43262
|
+
// Note: The formula may be named differently than the command, so the update is only suggested
|
|
43263
|
+
return {
|
|
43264
|
+
command: `brew upgrade ${definition.commandName}`,
|
|
43265
|
+
isRunnableByPromptbook: false,
|
|
43266
|
+
};
|
|
43267
|
+
}
|
|
43268
|
+
return {
|
|
43269
|
+
command: null,
|
|
43270
|
+
isRunnableByPromptbook: false,
|
|
43271
|
+
};
|
|
43272
|
+
}
|
|
43273
|
+
// Note: [🟡] Code for CLI harness update planning [resolveHarnessUpdatePlan](src/cli/cli-commands/common/harness/resolveHarnessUpdatePlan.ts) should never be published outside of `@promptbook/cli`
|
|
43181
43274
|
|
|
43182
43275
|
/**
|
|
43183
43276
|
* Reports one detected harness installation status and offers to install or update the harness.
|
|
43184
43277
|
*
|
|
43185
|
-
* Note: `$` is used to indicate that this function is not a pure function - it asks the user and installs
|
|
43278
|
+
* Note: `$` is used to indicate that this function is not a pure function - it asks the user and installs software
|
|
43186
43279
|
*
|
|
43187
43280
|
* @private internal utility of `promptbookCli`
|
|
43188
43281
|
*/
|
|
43189
43282
|
async function $applyHarnessInstallationStatus(status) {
|
|
43190
|
-
const { definition, installationState, installedVersion
|
|
43283
|
+
const { definition, installationState, installedVersion } = status;
|
|
43191
43284
|
if (installationState === 'up-to-date') {
|
|
43192
43285
|
console.info(colors.gray(`✔ ${definition.label} ${installedVersion} is up to date.`));
|
|
43193
43286
|
return;
|
|
@@ -43201,14 +43294,50 @@ async function $applyHarnessInstallationStatus(status) {
|
|
|
43201
43294
|
return;
|
|
43202
43295
|
}
|
|
43203
43296
|
console.warn(colors.yellow(formatHarnessInstallationWarning(status)));
|
|
43204
|
-
|
|
43205
|
-
|
|
43206
|
-
|
|
43297
|
+
if (installationState === 'not-installed') {
|
|
43298
|
+
await $applyMissingHarnessInstallation(definition);
|
|
43299
|
+
return;
|
|
43300
|
+
}
|
|
43301
|
+
await $applyOutdatedHarnessInstallation(status);
|
|
43302
|
+
}
|
|
43303
|
+
/**
|
|
43304
|
+
* Offers to install a missing harness globally through npm.
|
|
43305
|
+
*/
|
|
43306
|
+
async function $applyMissingHarnessInstallation(definition) {
|
|
43307
|
+
const installCommand = buildHarnessInstallCommand(definition);
|
|
43308
|
+
const isInstallationApproved = await $askForNpmPackageInstallationApproval(`Install ${definition.label} globally now?`);
|
|
43207
43309
|
if (!isInstallationApproved) {
|
|
43208
|
-
console.info(colors.gray(`Skipped, run \`${
|
|
43310
|
+
console.info(colors.gray(`Skipped, run \`${installCommand}\` to do it manually.`));
|
|
43209
43311
|
return;
|
|
43210
43312
|
}
|
|
43211
|
-
await $
|
|
43313
|
+
await $runHarnessInstallationCommand({
|
|
43314
|
+
definition,
|
|
43315
|
+
operation: 'install',
|
|
43316
|
+
command: installCommand,
|
|
43317
|
+
environment: definition.npmInstallEnvironment,
|
|
43318
|
+
});
|
|
43319
|
+
}
|
|
43320
|
+
/**
|
|
43321
|
+
* Offers to update an outdated harness exactly where it is installed.
|
|
43322
|
+
*/
|
|
43323
|
+
async function $applyOutdatedHarnessInstallation(status) {
|
|
43324
|
+
const { definition, latestVersion, installationOrigin } = status;
|
|
43325
|
+
const updatePlan = resolveHarnessUpdatePlan(definition, installationOrigin.installationMethod);
|
|
43326
|
+
if (updatePlan.command === null || !updatePlan.isRunnableByPromptbook) {
|
|
43327
|
+
console.info(colors.gray(formatHarnessManualUpdateInstruction(status, updatePlan)));
|
|
43328
|
+
return;
|
|
43329
|
+
}
|
|
43330
|
+
const isUpdateApproved = await $askForNpmPackageInstallationApproval(`Update ${definition.label} to ${latestVersion} with \`${updatePlan.command}\` now?`);
|
|
43331
|
+
if (!isUpdateApproved) {
|
|
43332
|
+
console.info(colors.gray(`Skipped, run \`${updatePlan.command}\` to do it manually.`));
|
|
43333
|
+
return;
|
|
43334
|
+
}
|
|
43335
|
+
await $runHarnessInstallationCommand({
|
|
43336
|
+
definition,
|
|
43337
|
+
operation: 'update',
|
|
43338
|
+
command: updatePlan.command,
|
|
43339
|
+
environment: updatePlan.environment,
|
|
43340
|
+
});
|
|
43212
43341
|
}
|
|
43213
43342
|
// Note: [🟡] Code for CLI harness installation handling [$applyHarnessInstallationStatus](src/cli/cli-commands/common/harness/$applyHarnessInstallationStatus.ts) should never be published outside of `@promptbook/cli`
|
|
43214
43343
|
|
|
@@ -43408,6 +43537,186 @@ function comparePrereleaseIdentifier(firstIdentifier, secondIdentifier) {
|
|
|
43408
43537
|
}
|
|
43409
43538
|
// Note: [🟡] Code for CLI npm package version comparison [isNpmPackageVersionOutdated](src/cli/cli-commands/common/npm/isNpmPackageVersionOutdated.ts) should never be published outside of `@promptbook/cli`
|
|
43410
43539
|
|
|
43540
|
+
/**
|
|
43541
|
+
* Time limit for asking npm where it installs global packages.
|
|
43542
|
+
*/
|
|
43543
|
+
const NPM_GLOBAL_PREFIX_COMMAND_TIMEOUT_MS = 30 * 1000;
|
|
43544
|
+
/**
|
|
43545
|
+
* Cached lookup, because the global npm prefix cannot change while one command runs and several
|
|
43546
|
+
* harnesses are checked at the same time.
|
|
43547
|
+
*/
|
|
43548
|
+
let npmGlobalPrefixPathPromise = null;
|
|
43549
|
+
/**
|
|
43550
|
+
* Reads the root directory under which npm installs global packages.
|
|
43551
|
+
*
|
|
43552
|
+
* Note: `$` is used to indicate that this function is not a pure function - it runs npm
|
|
43553
|
+
*
|
|
43554
|
+
* @returns The global npm prefix or `null` when npm could not be asked for it
|
|
43555
|
+
* @private internal utility of `promptbookCli`
|
|
43556
|
+
*/
|
|
43557
|
+
function $resolveNpmGlobalPrefixPath() {
|
|
43558
|
+
if (npmGlobalPrefixPathPromise === null) {
|
|
43559
|
+
npmGlobalPrefixPathPromise = $readNpmGlobalPrefixPath();
|
|
43560
|
+
}
|
|
43561
|
+
return npmGlobalPrefixPathPromise;
|
|
43562
|
+
}
|
|
43563
|
+
/**
|
|
43564
|
+
* Asks npm for the global prefix once.
|
|
43565
|
+
*/
|
|
43566
|
+
async function $readNpmGlobalPrefixPath() {
|
|
43567
|
+
const output = await $execCommand({
|
|
43568
|
+
command: 'npm prefix --global --loglevel=error',
|
|
43569
|
+
crashOnError: true,
|
|
43570
|
+
timeout: NPM_GLOBAL_PREFIX_COMMAND_TIMEOUT_MS,
|
|
43571
|
+
isVerbose: false,
|
|
43572
|
+
}).catch(() => '');
|
|
43573
|
+
// Note: npm prints the prefix as the last line, warnings emitted before it are ignored
|
|
43574
|
+
const prefixPath = output
|
|
43575
|
+
.split('\n')
|
|
43576
|
+
.map((line) => line.trim())
|
|
43577
|
+
.filter((line) => line !== '')
|
|
43578
|
+
.pop();
|
|
43579
|
+
return prefixPath !== null && prefixPath !== void 0 ? prefixPath : null;
|
|
43580
|
+
}
|
|
43581
|
+
// Note: [🟡] Code for CLI npm global prefix lookup [$resolveNpmGlobalPrefixPath](src/cli/cli-commands/common/npm/$resolveNpmGlobalPrefixPath.ts) should never be published outside of `@promptbook/cli`
|
|
43582
|
+
|
|
43583
|
+
/**
|
|
43584
|
+
* Time limit for looking up where the harness command lives.
|
|
43585
|
+
*/
|
|
43586
|
+
const HARNESS_COMMAND_LOOKUP_TIMEOUT_MS = 30 * 1000;
|
|
43587
|
+
/**
|
|
43588
|
+
* Finds out which file is really executed when the harness command runs.
|
|
43589
|
+
*
|
|
43590
|
+
* The lookup deliberately uses the very same `PATH` which runs the harness, so it reports the copy of the
|
|
43591
|
+
* harness which Promptbook itself would use. Symbolic links are followed, because installers like the
|
|
43592
|
+
* standalone OpenAI Codex installer only link their package into a directory on `PATH`.
|
|
43593
|
+
*
|
|
43594
|
+
* Note: `$` is used to indicate that this function is not a pure function - it runs a command in a shell
|
|
43595
|
+
*
|
|
43596
|
+
* @returns Resolved path of the harness command or `null` when the command is not available
|
|
43597
|
+
* @private internal utility of `promptbookCli`
|
|
43598
|
+
*/
|
|
43599
|
+
async function $resolveHarnessCommandPath(definition) {
|
|
43600
|
+
const lookupCommand = process.platform === 'win32' ? `where ${definition.commandName}` : `command -v ${definition.commandName}`;
|
|
43601
|
+
const output = await $execCommand({
|
|
43602
|
+
command: lookupCommand,
|
|
43603
|
+
crashOnError: true,
|
|
43604
|
+
timeout: HARNESS_COMMAND_LOOKUP_TIMEOUT_MS,
|
|
43605
|
+
isVerbose: false,
|
|
43606
|
+
}).catch(() => '');
|
|
43607
|
+
// Note: `where` lists every match on its own line, only the first one is really executed
|
|
43608
|
+
const commandPath = output
|
|
43609
|
+
.split('\n')
|
|
43610
|
+
.map((line) => line.trim())
|
|
43611
|
+
.find((line) => line !== '');
|
|
43612
|
+
if (commandPath === undefined) {
|
|
43613
|
+
return null;
|
|
43614
|
+
}
|
|
43615
|
+
return await realpath(commandPath).catch(() => commandPath);
|
|
43616
|
+
}
|
|
43617
|
+
// Note: [🟡] Code for CLI harness command lookup [$resolveHarnessCommandPath](src/cli/cli-commands/common/harness/$resolveHarnessCommandPath.ts) should never be published outside of `@promptbook/cli`
|
|
43618
|
+
|
|
43619
|
+
/**
|
|
43620
|
+
* Origin used when the harness command was not looked up at all, for example when the update check is disabled.
|
|
43621
|
+
*
|
|
43622
|
+
* @private internal utility of `promptbookCli`
|
|
43623
|
+
*/
|
|
43624
|
+
const UNKNOWN_HARNESS_INSTALLATION_ORIGIN = {
|
|
43625
|
+
commandPath: null,
|
|
43626
|
+
installationMethod: 'unknown',
|
|
43627
|
+
};
|
|
43628
|
+
// Note: [🟡] Code for CLI harness installation origin [HarnessInstallationOrigin](src/cli/cli-commands/common/harness/HarnessInstallationOrigin.ts) should never be published outside of `@promptbook/cli`
|
|
43629
|
+
|
|
43630
|
+
/**
|
|
43631
|
+
* Directory which holds npm packages, so it appears in the resolved path of every globally installed npm binary
|
|
43632
|
+
* on systems where the global binary is only a symbolic link into the package.
|
|
43633
|
+
*
|
|
43634
|
+
* Note: Written in lower case because it is compared against normalized paths.
|
|
43635
|
+
*/
|
|
43636
|
+
const NODE_MODULES_DIRECTORY_NAME$1 = 'node_modules';
|
|
43637
|
+
/**
|
|
43638
|
+
* Directory into which Homebrew unpacks every formula, so it appears in the resolved path of
|
|
43639
|
+
* everything Homebrew manages and in nothing else.
|
|
43640
|
+
*
|
|
43641
|
+
* Note: Written in lower case because it is compared against normalized paths.
|
|
43642
|
+
*/
|
|
43643
|
+
const HOMEBREW_DIRECTORY_NAME = 'cellar';
|
|
43644
|
+
/**
|
|
43645
|
+
* Decides how a harness command was installed from the place where it really lives.
|
|
43646
|
+
*
|
|
43647
|
+
* Only a command which npm owns may be updated with `npm install -g`, every other command has to be
|
|
43648
|
+
* updated where it is installed, otherwise the update silently adds a second copy of the harness.
|
|
43649
|
+
*
|
|
43650
|
+
* @private internal utility of `promptbookCli`
|
|
43651
|
+
*/
|
|
43652
|
+
function resolveHarnessInstallationMethodFromPaths(paths) {
|
|
43653
|
+
var _a, _b;
|
|
43654
|
+
const { definition, commandPath, npmGlobalPrefixPath } = paths;
|
|
43655
|
+
const normalizedCommandPath = normalizeInstallationPath(commandPath);
|
|
43656
|
+
const commandPathDirectoryNames = normalizedCommandPath.split('/');
|
|
43657
|
+
// Note: A Homebrew formula may bundle its own `node_modules` and may live under the npm prefix of a
|
|
43658
|
+
// Homebrew-installed Node, so Homebrew has to be recognized before anything npm-shaped
|
|
43659
|
+
if (commandPathDirectoryNames.includes(HOMEBREW_DIRECTORY_NAME)) {
|
|
43660
|
+
return 'homebrew';
|
|
43661
|
+
}
|
|
43662
|
+
const standaloneDirectoryNames = (_b = (_a = definition.standaloneInstallation) === null || _a === void 0 ? void 0 : _a.directoryNames) !== null && _b !== void 0 ? _b : [];
|
|
43663
|
+
if (standaloneDirectoryNames.some((directoryName) => commandPathDirectoryNames.includes(normalizeInstallationPath(directoryName)))) {
|
|
43664
|
+
return 'standalone';
|
|
43665
|
+
}
|
|
43666
|
+
// Note: npm is not always reachable, but its own package directory is a reliable fallback marker
|
|
43667
|
+
if (normalizedCommandPath.includes(`/${NODE_MODULES_DIRECTORY_NAME$1}/${normalizeInstallationPath(definition.npmPackageName)}/`)) {
|
|
43668
|
+
return 'npm-global';
|
|
43669
|
+
}
|
|
43670
|
+
if (isPathInsideDirectory(normalizedCommandPath, npmGlobalPrefixPath)) {
|
|
43671
|
+
return 'npm-global';
|
|
43672
|
+
}
|
|
43673
|
+
return 'unknown';
|
|
43674
|
+
}
|
|
43675
|
+
/**
|
|
43676
|
+
* Normalizes one path so that paths coming from different tools and platforms can be compared.
|
|
43677
|
+
*
|
|
43678
|
+
* Note: The comparison is case-insensitive because Windows paths are, and two harness paths which differ
|
|
43679
|
+
* only in letter casing do not exist in practice.
|
|
43680
|
+
*/
|
|
43681
|
+
function normalizeInstallationPath(path) {
|
|
43682
|
+
return path.trim().replace(/\\/gu, '/').replace(/\/+$/u, '').toLowerCase();
|
|
43683
|
+
}
|
|
43684
|
+
/**
|
|
43685
|
+
* Checks whether one path lies inside a directory.
|
|
43686
|
+
*/
|
|
43687
|
+
function isPathInsideDirectory(normalizedPath, directoryPath) {
|
|
43688
|
+
if (directoryPath === null) {
|
|
43689
|
+
return false;
|
|
43690
|
+
}
|
|
43691
|
+
const normalizedDirectoryPath = normalizeInstallationPath(directoryPath);
|
|
43692
|
+
return normalizedDirectoryPath !== '' && normalizedPath.startsWith(`${normalizedDirectoryPath}/`);
|
|
43693
|
+
}
|
|
43694
|
+
// Note: [🟡] Code for CLI harness installation method detection [resolveHarnessInstallationMethodFromPaths](src/cli/cli-commands/common/harness/resolveHarnessInstallationMethodFromPaths.ts) should never be published outside of `@promptbook/cli`
|
|
43695
|
+
|
|
43696
|
+
/**
|
|
43697
|
+
* Finds out where one CLI coding harness is really installed and which tool manages it.
|
|
43698
|
+
*
|
|
43699
|
+
* Note: `$` is used to indicate that this function is not a pure function - it runs shell commands
|
|
43700
|
+
*
|
|
43701
|
+
* @private internal utility of `promptbookCli`
|
|
43702
|
+
*/
|
|
43703
|
+
async function $resolveHarnessInstallationOrigin(definition) {
|
|
43704
|
+
const commandPath = await $resolveHarnessCommandPath(definition);
|
|
43705
|
+
if (commandPath === null) {
|
|
43706
|
+
return UNKNOWN_HARNESS_INSTALLATION_ORIGIN;
|
|
43707
|
+
}
|
|
43708
|
+
const npmGlobalPrefixPath = await $resolveNpmGlobalPrefixPath();
|
|
43709
|
+
return {
|
|
43710
|
+
commandPath,
|
|
43711
|
+
installationMethod: resolveHarnessInstallationMethodFromPaths({
|
|
43712
|
+
definition,
|
|
43713
|
+
commandPath,
|
|
43714
|
+
npmGlobalPrefixPath,
|
|
43715
|
+
}),
|
|
43716
|
+
};
|
|
43717
|
+
}
|
|
43718
|
+
// Note: [🟡] Code for CLI harness installation origin detection [$resolveHarnessInstallationOrigin](src/cli/cli-commands/common/harness/$resolveHarnessInstallationOrigin.ts) should never be published outside of `@promptbook/cli`
|
|
43719
|
+
|
|
43411
43720
|
/**
|
|
43412
43721
|
* Detects whether one CLI coding harness is installed globally and, when enabled, whether it is up to date.
|
|
43413
43722
|
*
|
|
@@ -43416,17 +43725,22 @@ function comparePrereleaseIdentifier(firstIdentifier, secondIdentifier) {
|
|
|
43416
43725
|
* @private internal utility of `promptbookCli`
|
|
43417
43726
|
*/
|
|
43418
43727
|
async function $checkHarnessInstallation(definition, isHarnessUpdateCheckEnabled = true) {
|
|
43419
|
-
|
|
43728
|
+
// Note: The origin is only needed to update an outdated harness, so it is not looked up without the update check
|
|
43729
|
+
const [installedVersion, latestVersion, installationOrigin] = await Promise.all([
|
|
43420
43730
|
$resolveInstalledHarnessVersion(definition),
|
|
43421
43731
|
isHarnessUpdateCheckEnabled
|
|
43422
43732
|
? $resolveLatestNpmPackageVersion(definition.npmPackageName)
|
|
43423
43733
|
: Promise.resolve(null),
|
|
43734
|
+
isHarnessUpdateCheckEnabled
|
|
43735
|
+
? $resolveHarnessInstallationOrigin(definition)
|
|
43736
|
+
: Promise.resolve(UNKNOWN_HARNESS_INSTALLATION_ORIGIN),
|
|
43424
43737
|
]);
|
|
43425
43738
|
return {
|
|
43426
43739
|
definition,
|
|
43427
43740
|
installationState: resolveHarnessInstallationState(installedVersion, latestVersion, isHarnessUpdateCheckEnabled),
|
|
43428
43741
|
installedVersion,
|
|
43429
43742
|
latestVersion,
|
|
43743
|
+
installationOrigin,
|
|
43430
43744
|
};
|
|
43431
43745
|
}
|
|
43432
43746
|
/**
|
|
@@ -43485,7 +43799,7 @@ function resolveCheckedHarnessDefinitions(harnessNames) {
|
|
|
43485
43799
|
* @private internal utility of `promptbookCli`
|
|
43486
43800
|
*/
|
|
43487
43801
|
function addHarnessUpdateOption(command) {
|
|
43488
|
-
command.option('--no-harness-update', 'Skip checking whether
|
|
43802
|
+
command.option('--no-harness-update', 'Skip checking whether the installed coding harnesses are up to date');
|
|
43489
43803
|
}
|
|
43490
43804
|
/**
|
|
43491
43805
|
* Converts the Commander harness-update flag into the normalized harness-check option.
|
|
@@ -44062,7 +44376,7 @@ function $initializeCoderInitCommand(program) {
|
|
|
44062
44376
|
- CODING_AGENT_GIT_EMAIL
|
|
44063
44377
|
- CODING_AGENT_GIT_SIGNING_KEY
|
|
44064
44378
|
|
|
44065
|
-
Checks that the coding harnesses are installed
|
|
44379
|
+
Checks that the coding harnesses are installed and up to date unless \`--no-harness-update\` is used:
|
|
44066
44380
|
${block(listCheckedHarnessLabels())}
|
|
44067
44381
|
|
|
44068
44382
|
${block(CODER_GIT_SYNC_DESCRIPTION)}
|
|
@@ -44170,7 +44484,7 @@ function $initializeCoderPingCommand(program) {
|
|
|
44170
44484
|
- Starts the hourly/weekly quota window before you need it, so it is already refreshing when you do
|
|
44171
44485
|
- Optional --period keeps the quota window refreshing by pinging once per period until stopped
|
|
44172
44486
|
- Leaves the project exactly as it was — nothing is read, written, changed or committed
|
|
44173
|
-
- Checks that the selected harness is installed
|
|
44487
|
+
- Checks that the selected harness is installed and up to date unless --no-harness-update is used
|
|
44174
44488
|
- Use --no-ui to stream the raw harness output instead of only the compact result
|
|
44175
44489
|
`));
|
|
44176
44490
|
addPromptRunnerSelectionOptions(command);
|
|
@@ -44664,7 +44978,7 @@ function $initializeCoderRunCommand(program) {
|
|
|
44664
44978
|
- Optional --isolate runs every prompt in its own temporary git worktree and merges it back when verified
|
|
44665
44979
|
- Optional --preserve-logs keeps temp prompt/log artifacts after successful rounds
|
|
44666
44980
|
- Optional --no-ui keeps plain streaming console output for logging and debugging
|
|
44667
|
-
- Checks that the selected harness is installed
|
|
44981
|
+
- Checks that the selected harness is installed and up to date before the first prompt unless --no-harness-update is used
|
|
44668
44982
|
- In interactive mode, checks local and global Promptbook CLI installations and offers to update them
|
|
44669
44983
|
- Supports GPG signing of commits
|
|
44670
44984
|
- Optional pre-coding test run that can stop or repair pre-existing failures
|
|
@@ -44821,7 +45135,7 @@ function $initializeCoderServerCommand(program) {
|
|
|
44821
45135
|
|
|
44822
45136
|
Features:
|
|
44823
45137
|
- Runs the same prompt processing as \`ptbk coder run\`
|
|
44824
|
-
- Checks that the selected harness is installed
|
|
45138
|
+
- Checks that the selected harness is installed and up to date on startup unless --no-harness-update is used
|
|
44825
45139
|
- Does not exit when all prompts are done; polls for new prompt files instead
|
|
44826
45140
|
- Serves a kanban board at http://localhost:<port> for visual progress tracking
|
|
44827
45141
|
- Allows editing prompt files directly from the browser (Trello-style)
|