ci: require space at start of // comment aws#6112

Problem:
Inconsistent comment style.

Solution:
Add a lint rule.

Author: justinmk3

.eslintrc.js

@@ -12,7 +12,7 @@ module.exports = {
         mocha: true,
         es2024: true,
     },
-    plugins: ['@typescript-eslint', 'unicorn', 'header', 'security-node', 'aws-toolkits'],
+    plugins: ['@typescript-eslint', '@stylistic', 'unicorn', 'header', 'security-node', 'aws-toolkits'],
     extends: [
         'eslint:recommended',
         'plugin:@typescript-eslint/eslint-recommended',
@@ -113,6 +113,20 @@ module.exports = {
         'no-constant-condition': ['error', { checkLoops: false }],
         'no-empty': 'off',
 
+        // https://eslint.style/rules/default/spaced-comment
+        // Require space after // comment.
+        '@stylistic/spaced-comment': [
+            'error',
+            'always',
+            {
+                block: {
+                    markers: ['!'], // Allow the /*!…*/ license header.
+                    // exceptions: ['*'],
+                    // balanced: true
+                },
+            },
+        ],
+
         // Rules from https://github.com/sindresorhus/eslint-plugin-unicorn
         // TODO: 'unicorn/no-useless-promise-resolve-reject': 'error',
         // TODO: 'unicorn/prefer-at': 'error',

package-lock.json

@@ -41,6 +41,7 @@
     "devDependencies": {
         "@aws-toolkits/telemetry": "^1.0.287",
         "@playwright/browser-chromium": "^1.43.1",
+        "@stylistic/eslint-plugin": "^2.11.0",
         "@types/he": "^1.2.3",
         "@types/vscode": "^1.68.0",
         "@types/vscode-webview": "^1.57.1",

package.json

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  *
  */
-//TODO: Refactor the common functionality between Transform, FeatureDev, CWSPRChat, Scan and UTG to a new Folder.
+// TODO: Refactor the common functionality between Transform, FeatureDev, CWSPRChat, Scan and UTG to a new Folder.
 
 export default class MessengerUtils {
     static stringToEnumValue = <T extends { [key: string]: string }, K extends keyof T & string>(

packages/amazonq/src/app/amazonqScan/chat/controller/messenger/messengerUtils.ts

@@ -53,7 +53,7 @@ export async function activateAmazonQCommon(context: vscode.ExtensionContext, is
     errors.init(fs.getUsername(), env.isAutomation())
     await initializeComputeRegion()
 
-    globals.contextPrefix = 'amazonq.' //todo: disconnect from above line
+    globals.contextPrefix = 'amazonq.' // todo: disconnect from above line
 
     // Avoid activation if older toolkit is installed
     // Amazon Q is only compatible with AWS Toolkit >= 3.0.0

packages/amazonq/src/extension.ts

@@ -108,7 +108,7 @@ zoomoutBtn.addEventListener('click', () => {
 
 // Message passing from extension to webview.
 // Capture state machine definition
-window.addEventListener('message', event => {
+window.addEventListener('message', (event) => {
     // event.data is object passed in from postMessage from vscode
     const message = event.data
     switch (message.command) {

packages/core/resources/js/graphStateMachine.js

@@ -4,7 +4,7 @@
  */
 
 export enum FollowUpTypes {
-    //UnitTestGeneration
+    // UnitTestGeneration
     ViewDiff = 'ViewDiff',
     AcceptCode = 'AcceptCode',
     RejectCode = 'RejectCode',
@@ -14,7 +14,7 @@ export enum FollowUpTypes {
     InstallDependenciesAndContinue = 'InstallDependenciesAndContinue',
     ContinueBuildAndExecute = 'ContinueBuildAndExecute',
     ViewCodeDiffAfterIteration = 'ViewCodeDiffAfterIteration',
-    //FeatureDev
+    // FeatureDev
     GenerateCode = 'GenerateCode',
     InsertCode = 'InsertCode',
     ProvideFeedbackAndRegenerateCode = 'ProvideFeedbackAndRegenerateCode',

packages/core/src/amazonq/commons/types.ts

@@ -360,7 +360,7 @@ export class LspController {
                 })
             }
         } catch (error) {
-            //TODO: use telemetry.run()
+            // TODO: use telemetry.run()
             getLogger().error(`LspController: Failed to build index of project`)
             telemetry.amazonq_indexWorkspace.emit({
                 duration: performance.now() - start,

packages/core/src/amazonq/lsp/lspController.ts

@@ -66,7 +66,7 @@ export const QueryVectorIndexRequestType: RequestType<QueryVectorIndexRequest, a
 
 export type IndexConfig = 'all' | 'default'
 
-//RepoMapData
+// RepoMapData
 export type QueryRepomapIndexRequestPayload = { filePaths: string[] }
 export type QueryRepomapIndexRequest = string
 export const QueryRepomapIndexRequestType: RequestType<QueryRepomapIndexRequest, any, any> = new RequestType(

packages/core/src/amazonq/lsp/types.ts

@@ -33,7 +33,7 @@ export interface MessageData {
     tabID: string
     type: TestMessageType
 }
-//TODO: Refactor testChatConnector, scanChatConnector and other apps connector files post RIV
+// TODO: Refactor testChatConnector, scanChatConnector and other apps connector files post RIV
 export class Connector extends BaseConnector {
     override getTabType(): TabType {
         return 'testgen'