feat(amazonq): rename CodeWhisperer settings #4695

leigaol · web-flow · commit ace3cbc54545 · 2024-04-12T10:22:51.000-07:00
Problem
Rename settings from CodeWhisperer to Amazon Q.

Solution
- Log level and telemetry will now be aws level configurations. They are shared between toolkit &amp; Q.
- Migrating old settings to new settings is not in scope of this PR.
diff --git a/packages/amazonq/package.json b/packages/amazonq/package.json
@@ -48,14 +48,14 @@
     "contributes": {
         "configuration": {
             "type": "object",
-            "title": "%AWS.productName%",
+            "title": "%AWS.amazonq.productName%",
             "cloud9": {
                 "cn": {
-                    "title": "%AWS.productName.cn%"
+                    "title": "%AWS.amazonq.productName.cn%"
                 }
             },
             "properties": {
-                "aws.amazonq.logLevel": {
+                "aws.logLevel": {
                     "type": "string",
                     "default": "debug",
                     "enum": [
@@ -79,7 +79,7 @@
                         }
                     }
                 },
-                "aws.amazonq.telemetry": {
+                "aws.telemetry": {
                     "type": "boolean",
                     "default": true,
                     "markdownDescription": "%AWS.configuration.description.telemetry%",
@@ -89,7 +89,7 @@
                         }
                     }
                 },
-                "aws.amazonq.suppressPrompts": {
+                "aws.amazonQ.suppressPrompts": {
                     "type": "object",
                     "description": "%AWS.configuration.description.suppressPrompts%",
                     "default": {},
@@ -113,23 +113,23 @@
                     },
                     "additionalProperties": false
                 },
-                "aws.codeWhisperer.includeSuggestionsWithCodeReferences": {
+                "aws.amazonQ.includeSuggestionsWithCodeReferences": {
                     "type": "boolean",
                     "markdownDescription": "%AWS.configuration.description.codewhisperer%",
                     "default": true
                 },
-                "aws.codeWhisperer.importRecommendation": {
+                "aws.amazonQ.importRecommendation": {
                     "type": "boolean",
                     "description": "%AWS.configuration.description.codewhisperer.importRecommendation%",
                     "default": true
                 },
-                "aws.codeWhisperer.shareCodeWhispererContentWithAWS": {
+                "aws.amazonQ.shareCodeWhispererContentWithAWS": {
                     "type": "boolean",
                     "markdownDescription": "%AWS.configuration.description.codewhisperer.shareCodeWhispererContentWithAWS%",
                     "default": true,
                     "scope": "application"
                 },
-                "aws.codeWhisperer.javaCompilationOutput": {
+                "aws.amazonQ.javaCompilationOutput": {
                     "type": "string",
                     "default": "",
                     "description": "Provide the ABSOLUTE path which is used to store java project compilation results."
diff --git a/packages/amazonq/scripts/build/syncPackageJson.ts b/packages/amazonq/scripts/build/syncPackageJson.ts
@@ -26,7 +26,7 @@ function main() {
 
     const coreSettings = coreLibPackageJson.contributes.configuration.properties
     Object.keys(coreSettings).forEach(key => {
-        if (key.startsWith('aws.amazonq') || key.startsWith('aws.codeWhisperer')) {
+        if (key.startsWith('aws.amazonQ')) {
             packageJson.contributes.configuration.properties[key] = coreSettings[key]
         }
     })
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -238,41 +238,7 @@
                     "description": "%AWS.configuration.description.lambda.recentlyUploaded%",
                     "default": []
                 },
-                "aws.amazonq.logLevel": {
-                    "type": "string",
-                    "default": "debug",
-                    "enum": [
-                        "error",
-                        "warn",
-                        "info",
-                        "verbose",
-                        "debug"
-                    ],
-                    "enumDescriptions": [
-                        "Errors Only",
-                        "Errors and Warnings",
-                        "Errors, Warnings, and Info",
-                        "Errors, Warnings, Info, and Verbose",
-                        "Errors, Warnings, Info, Verbose, and Debug"
-                    ],
-                    "markdownDescription": "%AWS.configuration.description.logLevel%",
-                    "cloud9": {
-                        "cn": {
-                            "markdownDescription": "%AWS.configuration.description.logLevel.cn%"
-                        }
-                    }
-                },
-                "aws.amazonq.telemetry": {
-                    "type": "boolean",
-                    "default": true,
-                    "markdownDescription": "%AWS.configuration.description.telemetry%",
-                    "cloud9": {
-                        "cn": {
-                            "markdownDescription": "%AWS.configuration.description.telemetry.cn%"
-                        }
-                    }
-                },
-                "aws.amazonq.suppressPrompts": {
+                "aws.amazonQ.suppressPrompts": {
                     "type": "object",
                     "description": "%AWS.configuration.description.suppressPrompts%",
                     "default": {},
@@ -296,23 +262,23 @@
                     },
                     "additionalProperties": false
                 },
-                "aws.codeWhisperer.includeSuggestionsWithCodeReferences": {
+                "aws.amazonQ.includeSuggestionsWithCodeReferences": {
                     "type": "boolean",
                     "markdownDescription": "%AWS.configuration.description.codewhisperer%",
                     "default": true
                 },
-                "aws.codeWhisperer.importRecommendation": {
+                "aws.amazonQ.importRecommendation": {
                     "type": "boolean",
                     "description": "%AWS.configuration.description.codewhisperer.importRecommendation%",
                     "default": true
                 },
-                "aws.codeWhisperer.shareCodeWhispererContentWithAWS": {
+                "aws.amazonQ.shareCodeWhispererContentWithAWS": {
                     "type": "boolean",
                     "markdownDescription": "%AWS.configuration.description.codewhisperer.shareCodeWhispererContentWithAWS%",
                     "default": true,
                     "scope": "application"
                 },
-                "aws.codeWhisperer.javaCompilationOutput": {
+                "aws.amazonQ.javaCompilationOutput": {
                     "type": "string",
                     "default": "",
                     "description": "Provide the ABSOLUTE path which is used to store java project compilation results."
diff --git a/packages/core/package.nls.json b/packages/core/package.nls.json
@@ -3,6 +3,8 @@
     "AWS.title.cn": "Amazon",
     "AWS.productName": "AWS Toolkit",
     "AWS.productName.cn": "Amazon Toolkit",
+    "AWS.amazonq.productName": "Amazon Q",
+    "AWS.amazonq.productName.cn": "Amazon Q",
     "AWS.codecatalyst.submenu.title": "Manage CodeCatalyst",
     "AWS.configuration.profileDescription": "The name of the credential profile to obtain credentials from.",
     "AWS.configuration.description.lambda.recentlyUploaded": "Recently selected Lambda upload targets.",
diff --git a/packages/core/src/codewhisperer/activation.ts b/packages/core/src/codewhisperer/activation.ts
@@ -113,9 +113,7 @@ export async function activate(context: ExtContext): Promise<void> {
                 EditorContext.updateTabSize(getTabSizeSetting())
             }
 
-            if (
-                configurationChangeEvent.affectsConfiguration('aws.codeWhisperer.includeSuggestionsWithCodeReferences')
-            ) {
+            if (configurationChangeEvent.affectsConfiguration('aws.amazonQ.includeSuggestionsWithCodeReferences')) {
                 ReferenceLogViewProvider.instance.update()
                 if (auth.isEnterpriseSsoInUse()) {
                     await vscode.window
@@ -131,7 +129,7 @@ export async function activate(context: ExtContext): Promise<void> {
                 }
             }
 
-            if (configurationChangeEvent.affectsConfiguration('aws.codeWhisperer.shareCodeWhispererContentWithAWS')) {
+            if (configurationChangeEvent.affectsConfiguration('aws.amazonQ.shareCodeWhispererContentWithAWS')) {
                 if (auth.isEnterpriseSsoInUse()) {
                     await vscode.window
                         .showInformationMessage(
@@ -170,10 +168,10 @@ export async function activate(context: ExtContext): Promise<void> {
             if (id === 'codewhisperer') {
                 await vscode.commands.executeCommand(
                     'workbench.action.openSettings',
-                    `@id:aws.codeWhisperer.includeSuggestionsWithCodeReferences`
+                    `@id:aws.amazonQ.includeSuggestionsWithCodeReferences`
                 )
             } else {
-                await vscode.commands.executeCommand('workbench.action.openSettings', `aws.codeWhisperer`)
+                await vscode.commands.executeCommand('workbench.action.openSettings', `aws.amazonQ`)
             }
         }),
         Commands.register('aws.codewhisperer.refreshAnnotation', async (forceProceed: boolean = false) => {
diff --git a/packages/core/src/codewhisperer/commands/startSecurityScan.ts b/packages/core/src/codewhisperer/commands/startSecurityScan.ts
@@ -263,7 +263,7 @@ export function errorPromptHelper(error: Error) {
             )
             .then(async resp => {
                 if (resp === viewSettings) {
-                    openSettings('aws.codeWhisperer.javaCompilationOutput').catch(e => {
+                    openSettings('aws.amazonQ.javaCompilationOutput').catch(e => {
                         getLogger().error('openSettings failed: %s', (e as Error).message)
                     })
                 }
diff --git a/packages/core/src/codewhisperer/util/codewhispererSettings.ts b/packages/core/src/codewhisperer/util/codewhispererSettings.ts
@@ -9,7 +9,7 @@ const description = {
     importRecommendation: Boolean,
     shareCodeWhispererContentWithAWS: Boolean,
 }
-export class CodeWhispererSettings extends fromExtensionManifest('aws.codeWhisperer', description) {
+export class CodeWhispererSettings extends fromExtensionManifest('aws.amazonQ', description) {
     public isSuggestionsWithCodeReferencesEnabled(): boolean {
         return this.get(`includeSuggestionsWithCodeReferences`, false)
     }
diff --git a/packages/core/src/codewhisperer/util/dependencyGraph/javaDependencyGraph.ts b/packages/core/src/codewhisperer/util/dependencyGraph/javaDependencyGraph.ts
@@ -244,7 +244,7 @@ export class JavaDependencyGraph extends DependencyGraph {
     }
 
     private autoDetectClasspath(projectPath: string, projectName: string, extension: string) {
-        const compileOutput = vscode.workspace.getConfiguration('aws.codeWhisperer').get('javaCompilationOutput')
+        const compileOutput = vscode.workspace.getConfiguration('aws.amazonQ').get('javaCompilationOutput')
         if (compileOutput && typeof compileOutput === 'string') {
             this._outputDirs.add(compileOutput)
         }
diff --git a/packages/core/src/shared/settings.ts b/packages/core/src/shared/settings.ts
@@ -637,10 +637,10 @@ export class ToolkitPromptSettings extends Settings.define(
     }
 }
 
-export const amazonQPrompts = settingsProps['aws.amazonq.suppressPrompts'].properties
+export const amazonQPrompts = settingsProps['aws.amazonQ.suppressPrompts'].properties
 type amazonQPromptName = keyof typeof amazonQPrompts
 export class AmazonQPromptSettings extends Settings.define(
-    'aws.amazonq.suppressPrompts',
+    'aws.amazonQ.suppressPrompts',
     toRecord(keys(amazonQPrompts), () => Boolean)
 ) {
     public async isPromptEnabled(promptName: amazonQPromptName): Promise<boolean> {
diff --git a/packages/toolkit/scripts/build/handlePackageJson.ts b/packages/toolkit/scripts/build/handlePackageJson.ts
@@ -41,7 +41,7 @@ function main() {
 
         // Remove Amazon Q extension settings stored in core
         Object.keys(coreSettings).forEach(key => {
-            if (key.startsWith('aws.amazonq') || key.startsWith('aws.codeWhisperer')) {
+            if (key.startsWith('aws.amazonQ')) {
                 delete coreSettings[key]
             }
         })

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ function main() {`
`26`	`26`
`27`	`27`	`const coreSettings = coreLibPackageJson.contributes.configuration.properties`
`28`	`28`	`Object.keys(coreSettings).forEach(key => {`
`29`		`- if (key.startsWith('aws.amazonq') \|\| key.startsWith('aws.codeWhisperer')) {`
	`29`	`+ if (key.startsWith('aws.amazonQ')) {`
`30`	`30`	`packageJson.contributes.configuration.properties[key] = coreSettings[key]`
`31`	`31`	`}`
`32`	`32`	`})`
Original file line number	Diff line number	Diff line change
`@@ -113,9 +113,7 @@ export async function activate(context: ExtContext): Promise<void> {`
`113`	`113`	`EditorContext.updateTabSize(getTabSizeSetting())`
`114`	`114`	`}`
`115`	`115`
`116`		`- if (`
`117`		`- configurationChangeEvent.affectsConfiguration('aws.codeWhisperer.includeSuggestionsWithCodeReferences')`
`118`		`- ) {`
	`116`	`+ if (configurationChangeEvent.affectsConfiguration('aws.amazonQ.includeSuggestionsWithCodeReferences')) {`
`119`	`117`	`ReferenceLogViewProvider.instance.update()`
`120`	`118`	`if (auth.isEnterpriseSsoInUse()) {`
`121`	`119`	`await vscode.window`
`@@ -131,7 +129,7 @@ export async function activate(context: ExtContext): Promise<void> {`
`131`	`129`	`}`
`132`	`130`	`}`
`133`	`131`
`134`		`- if (configurationChangeEvent.affectsConfiguration('aws.codeWhisperer.shareCodeWhispererContentWithAWS')) {`
	`132`	`+ if (configurationChangeEvent.affectsConfiguration('aws.amazonQ.shareCodeWhispererContentWithAWS')) {`
`135`	`133`	`if (auth.isEnterpriseSsoInUse()) {`
`136`	`134`	`await vscode.window`
`137`	`135`	`.showInformationMessage(`
`@@ -170,10 +168,10 @@ export async function activate(context: ExtContext): Promise<void> {`
`170`	`168`	`if (id === 'codewhisperer') {`
`171`	`169`	`await vscode.commands.executeCommand(`
`172`	`170`	`'workbench.action.openSettings',`
`173`		- `@id:aws.codeWhisperer.includeSuggestionsWithCodeReferences`
	`171`	+ `@id:aws.amazonQ.includeSuggestionsWithCodeReferences`
`174`	`172`	`)`
`175`	`173`	`} else {`
`176`		- await vscode.commands.executeCommand('workbench.action.openSettings', `aws.codeWhisperer`)
	`174`	+ await vscode.commands.executeCommand('workbench.action.openSettings', `aws.amazonQ`)
`177`	`175`	`}`
`178`	`176`	`}),`
`179`	`177`	`Commands.register('aws.codewhisperer.refreshAnnotation', async (forceProceed: boolean = false) => {`
Original file line number	Diff line number	Diff line change
`@@ -263,7 +263,7 @@ export function errorPromptHelper(error: Error) {`
`263`	`263`	`)`
`264`	`264`	`.then(async resp => {`
`265`	`265`	`if (resp === viewSettings) {`
`266`		`- openSettings('aws.codeWhisperer.javaCompilationOutput').catch(e => {`
	`266`	`+ openSettings('aws.amazonQ.javaCompilationOutput').catch(e => {`
`267`	`267`	`getLogger().error('openSettings failed: %s', (e as Error).message)`
`268`	`268`	`})`
`269`	`269`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ const description = {`
`9`	`9`	`importRecommendation: Boolean,`
`10`	`10`	`shareCodeWhispererContentWithAWS: Boolean,`
`11`	`11`	`}`
`12`		`-export class CodeWhispererSettings extends fromExtensionManifest('aws.codeWhisperer', description) {`
	`12`	`+export class CodeWhispererSettings extends fromExtensionManifest('aws.amazonQ', description) {`
`13`	`13`	`public isSuggestionsWithCodeReferencesEnabled(): boolean {`
`14`	`14`	return this.get(`includeSuggestionsWithCodeReferences`, false)
`15`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -244,7 +244,7 @@ export class JavaDependencyGraph extends DependencyGraph {`
`244`	`244`	`}`
`245`	`245`
`246`	`246`	`private autoDetectClasspath(projectPath: string, projectName: string, extension: string) {`
`247`		`- const compileOutput = vscode.workspace.getConfiguration('aws.codeWhisperer').get('javaCompilationOutput')`
	`247`	`+ const compileOutput = vscode.workspace.getConfiguration('aws.amazonQ').get('javaCompilationOutput')`
`248`	`248`	`if (compileOutput && typeof compileOutput === 'string') {`
`249`	`249`	`this._outputDirs.add(compileOutput)`
`250`	`250`	`}`
Original file line number	Diff line number	Diff line change
`@@ -637,10 +637,10 @@ export class ToolkitPromptSettings extends Settings.define(`
`637`	`637`	`}`
`638`	`638`	`}`
`639`	`639`
`640`		`-export const amazonQPrompts = settingsProps['aws.amazonq.suppressPrompts'].properties`
	`640`	`+export const amazonQPrompts = settingsProps['aws.amazonQ.suppressPrompts'].properties`
`641`	`641`	`type amazonQPromptName = keyof typeof amazonQPrompts`
`642`	`642`	`export class AmazonQPromptSettings extends Settings.define(`
`643`		`- 'aws.amazonq.suppressPrompts',`
	`643`	`+ 'aws.amazonQ.suppressPrompts',`
`644`	`644`	`toRecord(keys(amazonQPrompts), () => Boolean)`
`645`	`645`	`) {`
`646`	`646`	`public async isPromptEnabled(promptName: amazonQPromptName): Promise<boolean> {`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ function main() {`
`41`	`41`
`42`	`42`	`// Remove Amazon Q extension settings stored in core`
`43`	`43`	`Object.keys(coreSettings).forEach(key => {`
`44`		`- if (key.startsWith('aws.amazonq') \|\| key.startsWith('aws.codeWhisperer')) {`
	`44`	`+ if (key.startsWith('aws.amazonQ')) {`
`45`	`45`	`delete coreSettings[key]`
`46`	`46`	`}`
`47`	`47`	`})`