Class DefaultPromptFragmentCustomizationService

Implements

PromptFragmentCustomizationService

Index

Constructors

Properties

activeCustomizations additionalTemplateDirs allCustomizations envVariablesServer fileService onDidChangeCustomAgents onDidChangeCustomAgentsEmitter onDidChangePromptFragmentCustomization onDidChangePromptFragmentCustomizationEmitter openerService preferences templateExtensions toDispose trackedTemplateURIs watchedFiles workspaceTemplateFiles

Methods

Constructors

constructor

new DefaultPromptFragmentCustomizationService(): DefaultPromptFragmentCustomizationService
Returns DefaultPromptFragmentCustomizationService

Properties

`Protected`activeCustomizations

activeCustomizations: Map<string, PromptFragmentCustomization> = ...

Contains the currently active customization, mapped by prompt fragment ID.

`Protected`additionalTemplateDirs

additionalTemplateDirs: Set<string> = ...

Stores additional directory paths for loading template files.

`Protected`allCustomizations

allCustomizations: Map<string, PromptFragmentCustomization> = ...

Tracks all loaded customizations, including overridden ones, mapped by source URI.

`Protected` `Readonly`envVariablesServer

envVariablesServer: EnvVariablesServer

`Protected` `Readonly`fileService

fileService: FileService

`Readonly`onDidChangeCustomAgents

onDidChangeCustomAgents: Event<void> = ...

Event fired when custom agents are modified

`Protected` `Readonly`onDidChangeCustomAgentsEmitter

onDidChangeCustomAgentsEmitter: Emitter<void> = ...

`Readonly`onDidChangePromptFragmentCustomization

onDidChangePromptFragmentCustomization: Event<string[]> = ...

Event fired when a prompt fragment is changed

`Protected` `Readonly`onDidChangePromptFragmentCustomizationEmitter

onDidChangePromptFragmentCustomizationEmitter: Emitter<string[]> = ...

`Protected` `Readonly`openerService

openerService: OpenerService

`Protected` `Readonly`preferences

preferences: AICorePreferences

`Protected`templateExtensions

templateExtensions: Set<string> = ...

Contains file extensions that identify prompt template files.

`Protected`toDispose

toDispose: DisposableCollection = ...

Collection of disposable resources for cleanup when the service updates or is disposed.

`Protected`trackedTemplateURIs

trackedTemplateURIs: Set<string> = ...

Stores URI strings of template files from directories currently being monitored for changes.

`Protected`watchedFiles

watchedFiles: Map<string, WatchedFileInfo> = ...

Maps URI strings to WatchedFileInfo objects for individually watched template files.

`Protected`workspaceTemplateFiles

workspaceTemplateFiles: Set<string> = ...

Stores specific file paths, provided by the settings, that should be treated as templates.

Methods

`Protected`addTemplate

addTemplate(
    activeCustomizationsCopy: Map<string, PromptFragmentCustomization>,
    id: string,
    template: string,
    sourceUri: string,
    allCustomizationsCopy: Map<string, PromptFragmentCustomization>,
    priority: number,
    origin: CustomizationSource,
): void
Adds a template to the customizations map, handling conflicts based on priority
Parameters
- activeCustomizationsCopy: Map<string, PromptFragmentCustomization>
  The map to add the customization to
- id: string
  The fragment ID
- template: string
  The template content
- sourceUri: string
  The URI of the source file (used to distinguish updates from conflicts)
- allCustomizationsCopy: Map<string, PromptFragmentCustomization>
  The map to track all loaded customizations
- priority: number
  The customization priority
- origin: CustomizationSource
  The source type of the customization
Returns void
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:217

createBuiltInPromptFragmentCustomization

createBuiltInPromptFragmentCustomization(
id: string,
defaultContent?: string,
): Promise<void>
Creates a customization based on a built-in fragment
Parameters
- id: string
  The ID of the built-in fragment to customize
- OptionaldefaultContent: string
  Optional default content for the customization
Returns Promise<void>
Implementation of PromptFragmentCustomizationService.createBuiltInPromptFragmentCustomization
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:769

createPromptFragmentCustomization

createPromptFragmentCustomization(
id: string,
defaultContent?: string,
): Promise<void>
Creates a new customization for a prompt fragment
Parameters
- id: string
  The fragment ID to customize
- OptionaldefaultContent: string
  Optional default content for the customization
Returns Promise<void>
Implementation of PromptFragmentCustomizationService.createPromptFragmentCustomization
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:765

editBuiltIn

editBuiltIn(id: string, defaultContent?: string): Promise<void>
Parameters
- id: string
- defaultContent: string = ''
Returns Promise<void>
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:910

editBuiltInPromptFragmentCustomization

editBuiltInPromptFragmentCustomization(
id: string,
defaultContent?: string,
): Promise<void>
Edits the built-in customization of a prompt fragment
Parameters
- id: string
  The prompt fragment ID to edit
- OptionaldefaultContent: string
  Optional default content for the customization
Returns Promise<void>
Implementation of PromptFragmentCustomizationService.editBuiltInPromptFragmentCustomization
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:956

editPromptFragmentCustomization

editPromptFragmentCustomization(
id: string,
customizationId: string,
): Promise<void>
Edits a specific customization of a prompt fragment
Parameters
- id: string
  The prompt fragment ID
- customizationId: string
  The customization ID to edit
Returns Promise<void>
Implementation of PromptFragmentCustomizationService.editPromptFragmentCustomization
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:773

`Protected`editTemplate

editTemplate(id: string, defaultContent?: string): Promise<void>
Edits a template by opening it in the editor, creating it if it doesn't exist
Parameters
- id: string
  The fragment ID
- OptionaldefaultContent: string
  Optional default content for new templates
Returns Promise<void>
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:794

`Protected`generateCustomizationId

generateCustomizationId(id: string, sourceUri: string): string
Generates a unique customization ID based on the fragment ID, source URI, and priority
Parameters
- id: string
  The fragment ID
- sourceUri: string
  The source URI of the template
Returns string
A unique customization ID
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:266

getActivePromptFragmentCustomization

getActivePromptFragmentCustomization(
id: string,
): undefined | CustomizedPromptFragment
Gets the active customized prompt fragment for a given ID
Parameters
- id: string
  The prompt fragment ID
Returns undefined | CustomizedPromptFragment
The active customized fragment or undefined if none exists
Implementation of PromptFragmentCustomizationService.getActivePromptFragmentCustomization
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:728

getAdditionalTemplateDirectories

getAdditionalTemplateDirectories(): string[]
Gets the list of additional template directories that are being watched.

Returns string[]
Array of directory paths
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:633

getAllCustomizations

getAllCustomizations(id: string): CustomizedPromptFragment[]
Gets all customizations for a prompt fragment ordered by priority
Parameters
- id: string
  The prompt fragment ID
Returns CustomizedPromptFragment[]
Array of customized fragments ordered by priority (highest first)
Implementation of PromptFragmentCustomizationService.getAllCustomizations
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:742

getCustomAgents

getCustomAgents(): Promise<CustomAgentDescription[]>
Gets all custom agent descriptions

Returns Promise<CustomAgentDescription[]>
Array of custom agent descriptions
Implementation of PromptFragmentCustomizationService.getCustomAgents
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:987

getCustomAgentsLocations

getCustomAgentsLocations(): Promise<{ exists: boolean; uri: URI }[]>
Returns all locations of existing customAgents.yml files and potential locations where new customAgents.yml files could be created.

Returns Promise<{ exists: boolean; uri: URI }[]>
An array of objects containing the URI and whether the file exists
Implementation of PromptFragmentCustomizationService.getCustomAgentsLocations
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:1044

getCustomizedPromptFragmentIds

getCustomizedPromptFragmentIds(): string[]
Gets the IDs of all prompt fragments that have customizations

Returns string[]
Array of prompt fragment IDs
Implementation of PromptFragmentCustomizationService.getCustomizedPromptFragmentIds
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:761

`Protected`getFragmentIdFromFilePath

getFragmentIdFromFilePath(filePath: string): string
Extract a fragment ID from a file path
Parameters
- filePath: string
  The path to the template file
Returns string
A fragment ID derived from the file name
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:443

`Protected`getFragmentIDFromURI

getFragmentIDFromURI(uri: URI): undefined | string
Gets the fragment ID from a URI
Parameters
- uri: URI
  URI to check
Returns undefined | string
Fragment ID or undefined if not found
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:965

getPromptFragmentCustomizationDescription

getPromptFragmentCustomizationDescription(
id: string,
customizationId: string,
): Promise<undefined | string>
Gets information about the description of a customization
Parameters
- id: string
  The fragment ID
- customizationId: string
  The customization ID
Returns Promise<undefined | string>
Description of the customization
Implementation of PromptFragmentCustomizationService.getPromptFragmentCustomizationDescription
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:884

getPromptFragmentCustomizationType

getPromptFragmentCustomizationType(
id: string,
customizationId: string,
): Promise<undefined | string>
Gets information about the source/type of a customization
Parameters
- id: string
  The fragment ID
- customizationId: string
  The customization ID
Returns Promise<undefined | string>
Type of the customization source
Implementation of PromptFragmentCustomizationService.getPromptFragmentCustomizationType
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:897

getPromptFragmentIDFromResource

getPromptFragmentIDFromResource(resourceId: unknown): undefined | string
Implementation of the generic getPromptFragmentIDFromResource method in the interface Accepts any resource identifier but only processes URIs
Parameters
- resourceId: unknown
  Resource to check
Returns undefined | string
Fragment ID or undefined if not found
Implementation of PromptFragmentCustomizationService.getPromptFragmentIDFromResource
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:979

getTemplateFileExtensions

getTemplateFileExtensions(): string[]
Gets the list of file extensions that are considered prompt templates.

Returns string[]
Array of file extensions including the leading dot (e.g., '.prompttemplate')
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:641

getTemplateFiles

getTemplateFiles(): string[]
Gets the list of specific template files that are being watched.

Returns string[]
Array of file paths
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:649

`Protected`getTemplatesDirectoryURI

getTemplatesDirectoryURI(): Promise<URI>
Gets the URI of the templates directory

Returns Promise<URI>
URI of the templates directory
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:690

`Protected`getTemplateURI

getTemplateURI(fragmentId: string): Promise<URI>
Gets the URI for a specific template file
Parameters
- fragmentId: string
  The fragment ID
Returns Promise<URI>
URI for the template file
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:704

`Protected`hashString

hashString(str: string): string
Simple hash function to generate a short identifier from a string
Parameters
- str: string
  The string to hash
Returns string
A string hash
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:278

`Protected`init

init(): void
Returns void
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:163

isPromptFragmentCustomized

isPromptFragmentCustomized(id: string): boolean
PromptFragmentCustomizationService interface implementation
Parameters
- id: string
Returns boolean
Implementation of PromptFragmentCustomizationService.isPromptFragmentCustomized
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:724

`Protected`isPromptTemplateExtension

isPromptTemplateExtension(extension: string): boolean
Checks if the given file extension is registered as a prompt template extension
Parameters
- extension: string
  The file extension including the leading dot (e.g., '.prompttemplate')
Returns boolean
True if the extension is registered as a prompt template extension
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:625

`Protected`loadCustomAgentsFromDirectory

loadCustomAgentsFromDirectory(
directoryURI: URI,
agentsById: Map<string, CustomAgentDescription>,
): Promise<void>
Load custom agents from a specific directory
Parameters
- directoryURI: URI
  The URI of the directory to load from
- agentsById: Map<string, CustomAgentDescription>
  Map to store the loaded agents by ID
Returns Promise<void>
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:1006

openCustomAgentYaml

openCustomAgentYaml(uri: URI): Promise<void>
Opens an existing customAgents.yml file at the given URI, or creates a new one if it doesn't exist.
Parameters
- uri: URI
  The URI of the customAgents.yml file to open or create
Returns Promise<void>
Implementation of PromptFragmentCustomizationService.openCustomAgentYaml
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:1066

`Protected`processExistingTemplateDirectory

processExistingTemplateDirectory(
    activeCustomizationsCopy: Map<string, PromptFragmentCustomization>,
    trackedTemplateURIsCopy: Set<string>,
    allCustomizationsCopy: Map<string, PromptFragmentCustomization>,
    dirURI: URI,
    priority: number,
    customizationSource: CustomizationSource,
): Promise<void>
Processes an existing directory for template files
Parameters
- activeCustomizationsCopy: Map<string, PromptFragmentCustomization>
  Map to store active customizations
- trackedTemplateURIsCopy: Set<string>
  Set to track URIs being monitored
- allCustomizationsCopy: Map<string, PromptFragmentCustomization>
  Map to store all loaded customizations
- dirURI: URI
  URI of the directory to process
- priority: number
  Priority level for customizations in this directory
- customizationSource: CustomizationSource
  Source type of the customization
Returns Promise<void>
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:493

`Protected`processTemplateDirectory

processTemplateDirectory(
    activeCustomizationsCopy: Map<string, PromptFragmentCustomization>,
    trackedTemplateURIsCopy: Set<string>,
    allCustomizationsCopy: Map<string, PromptFragmentCustomization>,
    dirURI: URI,
    priority: number,
    customizationSource: CustomizationSource,
): Promise<void>
Processes a directory for template files, adding them to the customizations map and setting up file watching
Parameters
- activeCustomizationsCopy: Map<string, PromptFragmentCustomization>
  Map to store active customizations
- trackedTemplateURIsCopy: Set<string>
  Set to track URIs being monitored
- allCustomizationsCopy: Map<string, PromptFragmentCustomization>
  Map to store all loaded customizations
- dirURI: URI
  URI of the directory to process
- priority: number
  Priority level for customizations in this directory
- customizationSource: CustomizationSource
  Source type of the customization
Returns Promise<void>
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:458

`Protected`processTemplateFiles

processTemplateFiles(
    activeCustomizationsCopy: Map<string, PromptFragmentCustomization>,
    trackedTemplateURIsCopy: Set<string>,
    allCustomizationsCopy: Map<string, PromptFragmentCustomization>,
    watchedFilesCopy: Map<string, WatchedFileInfo>,
): Promise<void>
Process the template files specified by path, watching for changes and loading their content into the customizations map
Parameters
- activeCustomizationsCopy: Map<string, PromptFragmentCustomization>
  Map to store active customizations
- trackedTemplateURIsCopy: Set<string>
  Set to track URIs being monitored
- allCustomizationsCopy: Map<string, PromptFragmentCustomization>
  Map to store all loaded customizations
- watchedFilesCopy: Map<string, WatchedFileInfo>
  Map to store file watch information
Returns Promise<void>
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:340

removeAllPromptFragmentCustomizations

removeAllPromptFragmentCustomizations(id: string): Promise<void>
Resets a fragment to its built-in version by removing all customizations
Parameters
- id: string
  The fragment ID to reset
Returns Promise<void>
Implementation of PromptFragmentCustomizationService.removeAllPromptFragmentCustomizations
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:820

`Protected`removeCustomizationFromMaps

removeCustomizationFromMaps(
    sourceUri: string,
    allCustomizationsCopy: Map<string, PromptFragmentCustomization>,
    activeCustomizationsCopy: Map<string, PromptFragmentCustomization>,
    trackedTemplateURIsCopy: Set<string>,
): undefined | string
Removes a customization from customizations maps based on the source URI. Also checks for any lower-priority customizations with the same ID that might need to be loaded.
Parameters
- sourceUri: string
  The URI of the source file being removed
- allCustomizationsCopy: Map<string, PromptFragmentCustomization>
  The map of all loaded customizations
- activeCustomizationsCopy: Map<string, PromptFragmentCustomization>
  The map of active customizations
- trackedTemplateURIsCopy: Set<string>
  Optional set of tracked URIs to update
Returns undefined | string
The fragment ID that was removed, or undefined if no customization was found
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:297

removePromptFragmentCustomization

removePromptFragmentCustomization(
id: string,
customizationId: string,
): Promise<void>
Removes a specific customization of a prompt fragment
Parameters
- id: string
  The prompt fragment ID
- customizationId: string
  The customization ID to remove
Returns Promise<void>
Implementation of PromptFragmentCustomizationService.removePromptFragmentCustomization
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:803

`Protected`removePromptTemplateSuffix

removePromptTemplateSuffix(filename: string): string
Removes the prompt template extension from a filename
Parameters
- filename: string
  The filename with extension
Returns string
The filename without the extension
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:713

resetBuiltInCustomization

resetBuiltInCustomization(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:937

resetToCustomization

resetToCustomization(id: string, customizationId: string): Promise<void>
Resets to a specific customization by removing higher-priority customizations
Parameters
- id: string
  The fragment ID
- customizationId: string
  The customization ID to reset to
Returns Promise<void>
Implementation of PromptFragmentCustomizationService.resetToCustomization
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:845

`Protected`setupDirectoryWatcher

setupDirectoryWatcher(
    dirURI: URI,
    priority: number,
    customizationSource: CustomizationSource,
): void
Sets up file watching for a template directory (works for both existing and non-existing directories)
Parameters
- dirURI: URI
  URI of the directory to watch
- priority: number
  Priority level for customizations in this directory
- customizationSource: CustomizationSource
  Source type of the customization
Returns void
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:530

`Protected`update

update(): Promise<void>
Updates the service by reloading all template files and watching for changes

Returns Promise<void>
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:175

updateConfiguration

updateConfiguration(
properties: PromptFragmentCustomizationProperties,
): Promise<void>
Updates multiple configuration properties at once, triggering only a single update process.
Parameters
- properties: PromptFragmentCustomizationProperties
  An object containing the properties to update
Returns Promise<void>
Promise that resolves when the update is complete
- Defined in ai-core/src/browser/frontend-prompt-customization-service.ts:658

Class DefaultPromptFragmentCustomizationService

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns DefaultPromptFragmentCustomizationService

Properties

ProtectedactiveCustomizations

ProtectedadditionalTemplateDirs

ProtectedallCustomizations

Protected ReadonlyenvVariablesServer

Protected ReadonlyfileService

ReadonlyonDidChangeCustomAgents

Protected ReadonlyonDidChangeCustomAgentsEmitter

ReadonlyonDidChangePromptFragmentCustomization

Protected ReadonlyonDidChangePromptFragmentCustomizationEmitter

Protected ReadonlyopenerService

Protected Readonlypreferences

ProtectedtemplateExtensions

ProtectedtoDispose

ProtectedtrackedTemplateURIs

ProtectedwatchedFiles

ProtectedworkspaceTemplateFiles

Methods

ProtectedaddTemplate

Parameters

Returns void

createBuiltInPromptFragmentCustomization

Parameters

Returns Promise<void>

createPromptFragmentCustomization

Parameters

Returns Promise<void>

editBuiltIn

Parameters

Returns Promise<void>

editBuiltInPromptFragmentCustomization

Parameters

Returns Promise<void>

editPromptFragmentCustomization

Parameters

Returns Promise<void>

ProtectededitTemplate

Parameters

Returns Promise<void>

ProtectedgenerateCustomizationId

Parameters

Returns string

getActivePromptFragmentCustomization

Parameters

Returns undefined | CustomizedPromptFragment

getAdditionalTemplateDirectories

Returns string[]

getAllCustomizations

Parameters

Returns CustomizedPromptFragment[]

getCustomAgents

Returns Promise<CustomAgentDescription[]>

getCustomAgentsLocations

Returns Promise<{ exists: boolean; uri: URI }[]>

getCustomizedPromptFragmentIds

Returns string[]

ProtectedgetFragmentIdFromFilePath

Parameters

Returns string

ProtectedgetFragmentIDFromURI

Parameters

Returns undefined | string

getPromptFragmentCustomizationDescription

Parameters

Returns Promise<undefined | string>

getPromptFragmentCustomizationType

Parameters

Returns Promise<undefined | string>

getPromptFragmentIDFromResource

Parameters

Returns undefined | string

`Protected`activeCustomizations

`Protected`additionalTemplateDirs

`Protected`allCustomizations

`Protected` `Readonly`envVariablesServer

`Protected` `Readonly`fileService

`Readonly`onDidChangeCustomAgents

`Protected` `Readonly`onDidChangeCustomAgentsEmitter

`Readonly`onDidChangePromptFragmentCustomization

`Protected` `Readonly`onDidChangePromptFragmentCustomizationEmitter

`Protected` `Readonly`openerService

`Protected` `Readonly`preferences

`Protected`templateExtensions

`Protected`toDispose

`Protected`trackedTemplateURIs

`Protected`watchedFiles

`Protected`workspaceTemplateFiles

`Protected`addTemplate

`Protected`editTemplate

`Protected`generateCustomizationId

`Protected`getFragmentIdFromFilePath

`Protected`getFragmentIDFromURI

`Protected`getTemplatesDirectoryURI

`Protected`getTemplateURI

`Protected`hashString

`Protected`init

`Protected`isPromptTemplateExtension

`Protected`loadCustomAgentsFromDirectory

`Protected`processExistingTemplateDirectory

`Protected`processTemplateDirectory

`Protected`processTemplateFiles

`Protected`removeCustomizationFromMaps

`Protected`removePromptTemplateSuffix

`Protected`setupDirectoryWatcher

`Protected`update