@promptbook/node 0.114.0-30 → 0.114.0-31

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.
@@ -0,0 +1,9 @@
1
+ import type { PromptRunnerHarnessName } from '../common/promptRunnerCliOptions';
2
+ /**
3
+ * Offers to add missing project-local ignore rules for the selected coding harness.
4
+ *
5
+ * Note: `$` is used to indicate that this function is not a pure function - it may ask the user and update `.gitignore`.
6
+ *
7
+ * @private internal utility of `ptbk coder`
8
+ */
9
+ export declare function $ensureCoderHarnessGitignoreRules(projectPath: string, harnessName: PromptRunnerHarnessName | undefined): Promise<void>;
@@ -1,7 +1,20 @@
1
+ import { type PromptRunnerHarnessName } from '../common/promptRunnerCliOptions';
1
2
  import type { InitializationStatus } from './boilerplateTemplates';
2
3
  /**
3
- * Ensures `.gitignore` contains the standalone Promptbook temp entry.
4
+ * Ensures `.gitignore` contains Promptbook Coder's local artifacts and every supported harness's local artifacts.
4
5
  *
5
6
  * @private function of `initializeCoderProjectConfiguration`
6
7
  */
7
8
  export declare function ensureCoderGitignoreFile(projectPath: string): Promise<InitializationStatus>;
9
+ /**
10
+ * Lists missing project-local ignore rules for the selected harnesses.
11
+ *
12
+ * @private internal utility of `ptbk coder`
13
+ */
14
+ export declare function getMissingCoderHarnessGitignoreRules(projectPath: string, harnessNames: ReadonlyArray<PromptRunnerHarnessName>): Promise<ReadonlyArray<string>>;
15
+ /**
16
+ * Adds the given Promptbook Coder rules to a project's `.gitignore` file.
17
+ *
18
+ * @private internal utility of `ptbk coder`
19
+ */
20
+ export declare function ensureCoderGitignoreRules(projectPath: string, rules: ReadonlyArray<string>): Promise<InitializationStatus>;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Asks the user in the terminal to confirm one optional change.
3
+ *
4
+ * Note: `$` is used to indicate that this function is not a pure function - it reads the answer from stdin.
5
+ *
6
+ * @returns `true` when the user confirms, `false` when the user declines or the terminal is not interactive.
7
+ * @private internal utility of `promptbookCli`
8
+ */
9
+ export declare function $askForConfirmation(question: string): Promise<boolean>;
@@ -45,6 +45,10 @@ export type HarnessDefinition = {
45
45
  * Extra environment variables required by the global npm installation of this harness.
46
46
  */
47
47
  readonly npmInstallEnvironment?: Readonly<Record<string, string>>;
48
+ /**
49
+ * Project-local files or directories which this harness can create and which should not be committed.
50
+ */
51
+ readonly projectGitignoreRules: ReadonlyArray<string>;
48
52
  /**
49
53
  * How a standalone installation of this harness is recognized and updated.
50
54
  *
@@ -64,3 +68,9 @@ export declare const HARNESS_DEFINITIONS: Readonly<Record<PromptRunnerHarnessNam
64
68
  * @private internal utility of `promptbookCli`
65
69
  */
66
70
  export declare function getHarnessDefinition(harnessName: PromptRunnerHarnessName): HarnessDefinition;
71
+ /**
72
+ * Lists the unique project ignore rules required by the selected harnesses, in selection order.
73
+ *
74
+ * @private internal utility of `promptbookCli`
75
+ */
76
+ export declare function getHarnessProjectGitignoreRules(harnessNames: ReadonlyArray<PromptRunnerHarnessName>): ReadonlyArray<string>;
@@ -50,6 +50,12 @@ export declare function ensureProjectEnvFile<TEnvVariable extends ProjectEnvVari
50
50
  * @private internal utility of Promptbook CLI project initialization
51
51
  */
52
52
  export declare function ensureProjectGitignoreFile({ projectPath, blockHeader, rules, }: EnsureProjectGitignoreFileOptions): Promise<ProjectInitializationStatus>;
53
+ /**
54
+ * Lists the ignore rules which are not yet present in a project's `.gitignore` file.
55
+ *
56
+ * @private internal utility of Promptbook CLI project initialization
57
+ */
58
+ export declare function getMissingProjectGitignoreRules(projectPath: string, rules: ReadonlyArray<string>): Promise<ReadonlyArray<string>>;
53
59
  /**
54
60
  * Reads one text file when it exists, otherwise returns `undefined`.
55
61
  *
@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
15
15
  export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
16
16
  /**
17
17
  * Represents the version string of the Promptbook engine.
18
- * It follows semantic versioning (e.g., `0.114.0-29`).
18
+ * It follows semantic versioning (e.g., `0.114.0-30`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/node",
3
- "version": "0.114.0-30",
3
+ "version": "0.114.0-31",
4
4
  "description": "Promptbook: Create persistent AI agents that turn your company's scattered knowledge into action",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -97,7 +97,7 @@
97
97
  "types": "./esm/src/_packages/node.index.d.ts",
98
98
  "typings": "./esm/src/_packages/node.index.d.ts",
99
99
  "peerDependencies": {
100
- "@promptbook/core": "0.114.0-30"
100
+ "@promptbook/core": "0.114.0-31"
101
101
  },
102
102
  "dependencies": {
103
103
  "@openai/agents": "0.4.15",
package/umd/index.umd.js CHANGED
@@ -47,7 +47,7 @@
47
47
  * @generated
48
48
  * @see https://github.com/webgptorg/promptbook
49
49
  */
50
- const PROMPTBOOK_ENGINE_VERSION = '0.114.0-30';
50
+ const PROMPTBOOK_ENGINE_VERSION = '0.114.0-31';
51
51
  /**
52
52
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
53
53
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -1804,6 +1804,7 @@
1804
1804
  label: 'OpenAI Codex',
1805
1805
  commandName: 'codex',
1806
1806
  npmPackageName: '@openai/codex',
1807
+ projectGitignoreRules: ['.codex'],
1807
1808
  // Note: The official standalone installer keeps its package in `~/.codex` and links it onto the `PATH`
1808
1809
  standaloneInstallation: {
1809
1810
  directoryNames: ['.codex'],
@@ -1815,6 +1816,7 @@
1815
1816
  label: 'GitHub Copilot',
1816
1817
  commandName: 'copilot',
1817
1818
  npmPackageName: '@github/copilot',
1819
+ projectGitignoreRules: ['.github/copilot/settings.local.json'],
1818
1820
  // Note: The GitHub Copilot CLI downloads its native binary in a postinstall script
1819
1821
  npmInstallEnvironment: { npm_config_ignore_scripts: 'false' },
1820
1822
  },
@@ -1823,30 +1825,35 @@
1823
1825
  label: 'Cline',
1824
1826
  commandName: 'cline',
1825
1827
  npmPackageName: 'cline',
1828
+ projectGitignoreRules: ['.cline'],
1826
1829
  },
1827
1830
  'claude-code': {
1828
1831
  harnessName: 'claude-code',
1829
1832
  label: 'Claude Code',
1830
1833
  commandName: 'claude',
1831
1834
  npmPackageName: '@anthropic-ai/claude-code',
1835
+ projectGitignoreRules: ['.claude'],
1832
1836
  },
1833
1837
  opencode: {
1834
1838
  harnessName: 'opencode',
1835
1839
  label: 'Opencode',
1836
1840
  commandName: 'opencode',
1837
1841
  npmPackageName: 'opencode-ai',
1842
+ projectGitignoreRules: ['.opencode'],
1838
1843
  },
1839
1844
  gemini: {
1840
1845
  harnessName: 'gemini',
1841
1846
  label: 'Gemini CLI',
1842
1847
  commandName: 'gemini',
1843
1848
  npmPackageName: '@google/gemini-cli',
1849
+ projectGitignoreRules: ['.gemini'],
1844
1850
  },
1845
1851
  'qwen-code': {
1846
1852
  harnessName: 'qwen-code',
1847
1853
  label: 'Qwen Code',
1848
1854
  commandName: 'qwen',
1849
1855
  npmPackageName: '@qwen-code/qwen-code',
1856
+ projectGitignoreRules: ['.qwen'],
1850
1857
  },
1851
1858
  };
1852
1859
  /**