support the "object" variant for the prompt files configuration setting value (microsoft#239242)

[config]: support the "object" variant for the setting value

Author: legomushroom

src/vs/workbench/contrib/chat/browser/chat.contribution.ts

@@ -154,7 +154,7 @@ configurationRegistry.registerConfiguration({
 			default: true
 		},
 		[PromptFilesConfig.CONFIG_KEY]: {
-			type: ['string', 'array', 'boolean', 'null'],
+			type: ['string', 'array', 'object', 'boolean', 'null'],
 			title: nls.localize('chat.promptFiles.setting.title', "Prompt Files"),
 			markdownDescription: nls.localize(
 				'chat.promptFiles.setting.markdownDescription',

src/vs/workbench/contrib/chat/browser/chatAttachmentModel/chatInstructionsFileLocator.ts

@@ -4,9 +4,9 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { URI } from '../../../../../base/common/uri.js';
+import { PromptFilesConfig } from '../../common/promptSyntax/config.js';
 import { dirname, extUri } from '../../../../../base/common/resources.js';
 import { IFileService } from '../../../../../platform/files/common/files.js';
-import { PromptFilesConfig } from '../../common/promptSyntax/config.js';
 import { IConfigurationService } from '../../../../../platform/configuration/common/configuration.js';
 import { IWorkspaceContextService, WorkbenchState } from '../../../../../platform/workspace/common/workspace.js';
 import { PROMPT_SNIPPET_FILE_EXTENSION } from '../../common/promptSyntax/contentProviders/promptContentsProviderBase.js';

src/vs/workbench/contrib/chat/common/promptSyntax/config.ts

@@ -35,14 +35,39 @@ import { IConfigurationService } from '../../../../../platform/configuration/com
  * Enable the feature, specifying multiple prompt files source folder location:
  * ```json
  * {
+ *   "chat.experimental.promptSnippets": {
+ *     ".github/prompts" : true,
+ *     ".copilot/prompts" : false,
+ *     "/Users/legomushroom/repos/prompts" : true,
+ *   },
+ * }
+ * ```
+ *
+ * Enable the feature, specifying multiple prompt files source folder location:
+ * ```json
+ * {
  *   "chat.experimental.promptSnippets": [
- *     '.github/prompts',
- *     '.copilot/prompts',
- *     '/Users/legomushroom/repos/prompts',
+ *     ".github/prompts",
+ *     ".copilot/prompts",
+ *     "/Users/legomushroom/repos/prompts",
  *   ],
  * }
  * ```
  *
+ * The "array" case is similar to the "object" one, but there is one difference.
+ * At the time of writing, configuration settings with the `array` value cannot
+ * be merged into a single entry when the setting is specified in both the user
+ * and the workspace settings. On the other hand, the "object" case is provides
+ * flexibility - the settings are combined into a single object.
+ *
+ * Enable the feature, using defaults for prompt files source folder locations
+ * (see {@link DEFAULT_LOCATION}):
+ * ```json
+ * {
+ *   "chat.experimental.promptSnippets": {},
+ * }
+ * ```
+ *
  * See the next section for details on how we treat the config value.
  *
  * ### Possible Values
@@ -54,13 +79,24 @@ import { IConfigurationService } from '../../../../../platform/configuration/com
  *   - `false`: feature is disabled
  * - `string`:
  *   - values that can be mapped to `boolean`(`"true"`, `"FALSE", "TrUe"`, etc.)
- *     are treated as `boolean` above
+ *     are treated the same as the `boolean` case above
  *   - any other `non-empty` string value is treated as a single prompt files source folder path
+ *   - `empty` string value is treated the same as the `undefined`/`null` case above
+ * - `object`:
+ *   - expects the { "string": `boolean` } pairs, where the `string` is a path and the `boolean`
+ *     is a flag that defines if the source folder location is enable or disabled
+ *   - value of a record in the object can also be a `string`:
+ *     - if the string can be clearly mapped to a `boolean` (e.g., `"true"`, `"FALSE", "TrUe"`, etc.),
+ *       it is treated as `boolean` value
+ *     - any other string value is treated as `false` and is effectively ignored
+ *   - if the record key is an `empty` string, it is ignored
+ *   - if the resulting object is empty, the feature is considered `enabled`, prompt files source
+ *     folder locations fallback to {@link DEFAULT_LOCATION}
  * - `array`:
  *   - `string` items in the array are treated as prompt files source folder paths
  *   - all `non-string` items in the array are `ignored`
- *   - if the resulting array is empty, the feature is considered `enabled`, prompt files source
- *     folder locations fallback to defaults (see {@linkcode DEFAULT_LOCATION})
+ *   - if the resulting array is empty, the feature is considered `enabled`, prompt files
+ *     source folder locations fallback to {@link DEFAULT_LOCATION}
  *
  * ### File Paths Resolution
  *
@@ -87,47 +123,59 @@ export namespace PromptFilesConfig {
 	/**
 	 * Default prompt instructions source folder paths.
 	 */
-	const DEFAULT_LOCATION = ['.github/prompts'];
+	const DEFAULT_LOCATION = Object.freeze(['.github/prompts']);
 
 	/**
 	 * Get value of the `prompt files` configuration setting.
 	 */
 	export const getValue = (
 		configService: IConfigurationService,
 	): string | readonly string[] | boolean | undefined => {
-		const value = configService.getValue(CONFIG_KEY);
+		const configValue = configService.getValue(CONFIG_KEY);
 
-		if (value === undefined || value === null) {
+		if (configValue === undefined || configValue === null) {
 			return undefined;
 		}
 
-		if (typeof value === 'string') {
-			const cleanValue = value.trim().toLowerCase();
-			if (cleanValue === 'true') {
-				return true;
-			}
-
-			if (cleanValue === 'false') {
-				return false;
-			}
+		if (typeof configValue === 'string') {
+			const cleanValue = configValue.trim().toLowerCase();
 
 			if (!cleanValue) {
 				return undefined;
 			}
 
-			return value;
+			if (asBoolean(cleanValue) !== undefined) {
+				return asBoolean(cleanValue);
+			}
+
+			return cleanValue;
 		}
 
-		if (typeof value === 'boolean') {
-			return value;
+		if (typeof configValue === 'boolean') {
+			return configValue;
 		}
 
-		if (Array.isArray(value)) {
-			return value.filter((item) => {
+		if (Array.isArray(configValue)) {
+			return configValue.filter((item) => {
 				return typeof item === 'string';
 			});
 		}
 
+		// note! this would be also true for `null` and `array`,
+		// 		 but those cases are already handled above
+		if (typeof configValue === 'object') {
+			const paths: string[] = [];
+
+			for (const [path, value] of Object.entries(configValue)) {
+				const cleanPath = path.trim();
+				if (asBoolean(value) && cleanPath) {
+					paths.push(cleanPath);
+				}
+			}
+
+			return Object.freeze(paths);
+		}
+
 		return undefined;
 	};
 
@@ -156,17 +204,42 @@ export namespace PromptFilesConfig {
 		}
 
 		if (typeof value === 'string') {
-			return [value];
+			return Object.freeze([value]);
 		}
 
-		if (Array.isArray(value)) {
-			if (value.length !== 0) {
-				return value;
-			}
-
-			return DEFAULT_LOCATION;
+		if (Array.isArray(value) && value.length !== 0) {
+			return value;
 		}
 
 		return DEFAULT_LOCATION;
 	};
 }
+
+/**
+ * Helper to parse an input value of `any` type into a boolean.
+ *
+ * @param value - input value to parse
+ * @returns `true` if the value is a boolean `true` or a string that can
+ * 			be clearly mapped to a boolean (e.g., `"true"`, `"TRUE"`, `"FaLSe"`, etc.),
+ * 			`undefined` for rest of the values
+ */
+function asBoolean(value: any): boolean | undefined {
+	if (typeof value === 'boolean') {
+		return value;
+	}
+
+	if (typeof value === 'string') {
+		const cleanValue = value.trim().toLowerCase();
+		if (cleanValue === 'true') {
+			return true;
+		}
+
+		if (cleanValue === 'false') {
+			return false;
+		}
+
+		return undefined;
+	}
+
+	return undefined;
+}