@promptbook/cli 0.112.0-35 → 0.112.0-36

package/esm/src/cli/cli-commands/coder/boilerplateTemplates.d.ts

@@ -0,0 +1,127 @@
+/**
+ * Relative path to the root prompts directory used by Promptbook coder utilities.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export declare const PROMPTS_DIRECTORY_PATH = "prompts";
+/**
+ * Relative path to the archive directory used by `coder verify`.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export declare const PROMPTS_DONE_DIRECTORY_PATH: string;
+/**
+ * Relative path to the project-owned boilerplate templates directory.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export declare const PROMPTS_TEMPLATES_DIRECTORY_PATH: string;
+/**
+ * Initialization statuses used when creating or updating coder configuration artifacts.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export type InitializationStatus = 'created' | 'updated' | 'unchanged';
+/**
+ * Identifiers of built-in coder boilerplate templates.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export type BuiltInCoderPromptTemplate = 'common' | 'agents-server';
+/**
+ * One built-in coder boilerplate template definition.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export type CoderPromptTemplateDefinition = {
+    /**
+     * Stable built-in identifier that can also be used as a CLI shorthand.
+     */
+    readonly id: BuiltInCoderPromptTemplate;
+    /**
+     * Project-relative path where `ptbk coder init` materializes the template file.
+     */
+    readonly relativeFilePath: string;
+    /**
+     * Prefix inserted into generated prompt file slugs.
+     */
+    readonly slugPrefix: string | null;
+    /**
+     * Markdown content of the template.
+     */
+    readonly content: string;
+};
+/**
+ * Result of ensuring one default coder template file exists inside a project.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export type EnsuredCoderPromptTemplateFile = {
+    /**
+     * Stable built-in identifier of the template.
+     */
+    readonly id: BuiltInCoderPromptTemplate;
+    /**
+     * Project-relative path of the materialized template file.
+     */
+    readonly relativeFilePath: string;
+    /**
+     * Status describing whether the file had to be created.
+     */
+    readonly status: InitializationStatus;
+};
+/**
+ * Fully resolved boilerplate template used by `coder generate-boilerplates`.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export type ResolvedCoderPromptTemplate = {
+    /**
+     * Identifier or relative file path that was resolved.
+     */
+    readonly identifier: string;
+    /**
+     * Project-relative path when the template corresponds to a project file.
+     */
+    readonly relativeFilePath?: string;
+    /**
+     * Markdown content of the resolved template.
+     */
+    readonly content: string;
+    /**
+     * Prefix inserted into generated prompt file slugs.
+     */
+    readonly slugPrefix: string | null;
+};
+/**
+ * Lists the built-in coder boilerplate templates.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export declare function getDefaultCoderPromptTemplateDefinitions(): ReadonlyArray<CoderPromptTemplateDefinition>;
+/**
+ * Resolves one built-in coder boilerplate template definition by its stable identifier.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export declare function getDefaultCoderPromptTemplateDefinition(template: BuiltInCoderPromptTemplate): CoderPromptTemplateDefinition;
+/**
+ * Ensures the default project-owned coder template files exist without overwriting user customizations.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export declare function ensureDefaultCoderPromptTemplateFiles(projectPath: string): Promise<ReadonlyArray<EnsuredCoderPromptTemplateFile>>;
+/**
+ * Resolves the template requested by `coder generate-boilerplates`.
+ *
+ * Supports three modes:
+ * - omitted option => built-in `common`
+ * - built-in alias => one of the shared default templates
+ * - relative path => markdown template file resolved from the project root
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export declare function resolveCoderPromptTemplate({ projectPath, templateOption, }: {
+    readonly projectPath: string;
+    readonly templateOption?: string;
+}): Promise<ResolvedCoderPromptTemplate>;

package/esm/src/cli/cli-commands/coder/boilerplateTemplates.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/src/cli/cli-commands/coder/generate-boilerplates.d.ts

@@ -8,3 +8,13 @@ import type { $side_effect } from '../../../utils/organization/$side_effect';
  * @private internal function of `promptbookCli`
  */
 export declare function $initializeCoderGenerateBoilerplatesCommand(program: Program): $side_effect;
+/**
+ * Generates boilerplate prompt files with unique emoji tags.
+ *
+ * @private internal function of `generatePromptBoilerplate` command
+ */
+export declare function generatePromptBoilerplate({ projectPath, filesCount, templateOption, }: {
+    readonly projectPath: string;
+    readonly filesCount: number;
+    readonly templateOption?: string;
+}): Promise<void>;

package/esm/src/cli/cli-commands/coder/init.d.ts

@@ -1,5 +1,24 @@
 import type { Command as Program } from 'commander';
 import type { $side_effect } from '../../../utils/organization/$side_effect';
+import { type EnsuredCoderPromptTemplateFile, type InitializationStatus } from './boilerplateTemplates';
+/**
+ * Generic JSON object used for standalone coder configuration files.
+ */
+type JsonObject = Record<string, unknown>;
+/**
+ * Result summary returned after coder configuration initialization.
+ */
+type CoderInitializationSummary = {
+    readonly promptsDirectoryStatus: InitializationStatus;
+    readonly promptsDoneDirectoryStatus: InitializationStatus;
+    readonly promptsTemplatesDirectoryStatus: InitializationStatus;
+    readonly promptTemplateFileStatuses: ReadonlyArray<EnsuredCoderPromptTemplateFile>;
+    readonly envFileStatus: InitializationStatus;
+    readonly gitignoreFileStatus: InitializationStatus;
+    readonly packageJsonFileStatus: InitializationStatus;
+    readonly vscodeSettingsFileStatus: InitializationStatus;
+    readonly initializedEnvVariableNames: ReadonlyArray<string>;
+};
 /**
  * Initializes `coder init` command for Promptbook CLI utilities.
  *
@@ -8,3 +27,22 @@ import type { $side_effect } from '../../../utils/organization/$side_effect';
  * @private internal function of `promptbookCli`
  */
 export declare function $initializeCoderInitCommand(program: Program): $side_effect;
+/**
+ * Lists the default npm scripts initialized by `ptbk coder init`.
+ *
+ * @private internal utility of `coder init` command
+ */
+export declare function getDefaultCoderPackageJsonScripts(): Readonly<Record<string, string>>;
+/**
+ * Lists the default VS Code settings initialized by `ptbk coder init`.
+ *
+ * @private internal utility of `coder init` command
+ */
+export declare function getDefaultCoderVscodeSettings(): Readonly<JsonObject>;
+/**
+ * Creates or updates all coder configuration artifacts required in the current project.
+ *
+ * @private internal utility of `coder init` command
+ */
+export declare function initializeCoderProjectConfiguration(projectPath: string): Promise<CoderInitializationSummary>;
+export {};

package/esm/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.112.0-34`).
+ * It follows semantic versioning (e.g., `0.112.0-35`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/cli",
-    "version": "0.112.0-35",
+    "version": "0.112.0-36",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,