lint

Author: justinmk3

packages/core/src/awsService/cloudWatchLogs/commands/tailLogGroup.ts

@@ -31,8 +31,8 @@ export async function tailLogGroup(
             throw new CancellationError('user')
         }
         if (wizardResponse.logStreamFilter.type === 'menu' || wizardResponse.logStreamFilter.type === undefined) {
-            //logstream filter wizard uses type to determine which submenu to show. 'menu' is set when no type is selected
-            //and to show the 'menu' of selecting a type. This should not be reachable due to the picker logic, but validating in case.
+            // logstream filter wizard uses type to determine which submenu to show. 'menu' is set when no type is selected
+            // and to show the 'menu' of selecting a type. This should not be reachable due to the picker logic, but validating in case.
             throw new ToolkitError(`Invalid Log Stream filter type: ${wizardResponse.logStreamFilter.type}`)
         }
         const awsCredentials = await globals.awsContext.getCredentials()
@@ -134,8 +134,8 @@ async function handleSessionStream(
                     formatLogEvent(logEvent)
                 )
                 if (formattedLogEvents.length !== 0) {
-                    //Determine should scroll before adding new lines to doc because adding large
-                    //amount of new lines can push bottom of file out of view before scrolling.
+                    // Determine should scroll before adding new lines to doc because adding large
+                    // amount of new lines can push bottom of file out of view before scrolling.
                     const editorsToScroll = getTextEditorsToScroll(document)
                     await updateTextDocumentWithNewLogEvents(formattedLogEvents, document, session.maxLines)
                     editorsToScroll.forEach(scrollTextEditorToBottom)
@@ -146,13 +146,13 @@ async function handleSessionStream(
         }
     } catch (e) {
         if (session.isAborted) {
-            //Expected case. User action cancelled stream (CodeLens, Close Editor, etc.).
-            //AbortSignal interrupts the LiveTail stream, causing error to be thrown here.
-            //Can assume that stopLiveTailSession() has already been called - AbortSignal is only
-            //exposed through that method.
+            // Expected case. User action cancelled stream (CodeLens, Close Editor, etc.).
+            // AbortSignal interrupts the LiveTail stream, causing error to be thrown here.
+            // Can assume that stopLiveTailSession() has already been called - AbortSignal is only
+            // exposed through that method.
             getLogger().info(`LiveTail session stopped: ${uriToKey(session.uri)}`)
         } else {
-            //Unexpected exception.
+            // Unexpected exception.
             session.stopLiveTailSession()
             throw ToolkitError.chain(
                 e,
@@ -178,8 +178,8 @@ function formatLogEvent(logEvent: LiveTailSessionLogEvent): string {
     return line
 }
 
-//Auto scroll visible LiveTail session editors if the end-of-file is in view.
-//This allows for newly added log events to stay in view.
+// Auto scroll visible LiveTail session editors if the end-of-file is in view.
+// This allows for newly added log events to stay in view.
 function getTextEditorsToScroll(document: vscode.TextDocument): vscode.TextEditor[] {
     return vscode.window.visibleTextEditors.filter((editor) => {
         if (editor.document !== document) {

packages/core/src/awsService/cloudWatchLogs/document/liveTailCodeLensProvider.ts

@@ -19,7 +19,7 @@ export class LiveTailCodeLensProvider implements vscode.CodeLensProvider {
         token: vscode.CancellationToken
     ): vscode.ProviderResult<vscode.CodeLens[]> {
         const uri = document.uri
-        //if registry does not contain session, it is assumed to have been stopped, thus, hide lenses.
+        // if registry does not contain session, it is assumed to have been stopped, thus, hide lenses.
         if (uri.scheme !== cloudwatchLogsLiveTailScheme || !this.registry.has(uriToKey(uri))) {
             return []
         }

packages/core/src/awsService/cloudWatchLogs/document/liveTailDocumentProvider.ts

@@ -7,7 +7,7 @@ import * as vscode from 'vscode'
 
 export class LiveTailDocumentProvider implements vscode.TextDocumentContentProvider {
     provideTextDocumentContent(uri: vscode.Uri, token: vscode.CancellationToken): vscode.ProviderResult<string> {
-        //Content will be written to the document via handling a LiveTail response stream in the TailLogGroup command.
+        // Content will be written to the document via handling a LiveTail response stream in the TailLogGroup command.
         return ''
     }
 }

packages/core/src/awsService/cloudWatchLogs/registry/liveTailSession.ts

@@ -42,7 +42,7 @@ export class LiveTailSession {
     private _eventRate: number
     private _isSampled: boolean
 
-    //While session is running, used to update the StatusBar each half second.
+    // While session is running, used to update the StatusBar each half second.
     private statusBarUpdateTimer: NodeJS.Timer | undefined
 
     static settings = new CloudWatchLogsSettings(Settings.instance)
@@ -110,11 +110,11 @@ export class LiveTailSession {
     }
 
     public getLiveTailSessionDuration(): number {
-        //Never started
+        // Never started
         if (this.startTime === undefined) {
             return 0
         }
-        //Currently running
+        // Currently running
         if (this.endTime === undefined) {
             return globals.clock.Date.now() - this.startTime
         }

packages/core/src/test/awsService/cloudWatchLogs/commands/tailLogGroup.test.ts

@@ -56,10 +56,10 @@ describe('TailLogGroup', function () {
             getSessionUpdateFrame(false, `${testMessage}-2`, startTimestamp + 2000),
             getSessionUpdateFrame(false, `${testMessage}-3`, startTimestamp + 3000),
         ]
-        //Returns the configured update frames and then indefinitely blocks.
-        //This keeps the stream 'open', simulating an open network stream waiting for new events.
-        //If the stream were to close, the event listeners in the TailLogGroup command would dispose,
-        //breaking the 'closes tab closes session' assertions this test makes.
+        // Returns the configured update frames and then indefinitely blocks.
+        // This keeps the stream 'open', simulating an open network stream waiting for new events.
+        // If the stream were to close, the event listeners in the TailLogGroup command would dispose,
+        // breaking the 'closes tab closes session' assertions this test makes.
         async function* generator(): AsyncIterable<StartLiveTailResponseStream> {
             for (const frame of updateFrames) {
                 yield frame
@@ -78,21 +78,21 @@ describe('TailLogGroup', function () {
         wizardSpy = sandbox.stub(TailLogGroupWizard.prototype, 'run').callsFake(async function () {
             return getTestWizardResponse()
         })
-        //Set maxLines to 1.
+        // Set maxLines to 1.
         cloudwatchSettingsSpy = sandbox.stub(CloudWatchLogsSettings.prototype, 'get').callsFake(() => {
             return 1
         })
 
-        //The mock stream doesn't 'close', causing tailLogGroup to not return. If we `await`, it will never resolve.
-        //Run it in the background and use waitUntil to poll its state.
+        // The mock stream doesn't 'close', causing tailLogGroup to not return. If we `await`, it will never resolve.
+        // Run it in the background and use waitUntil to poll its state.
         void tailLogGroup(registry, testSource, codeLensProvider, {
             groupName: testLogGroup,
             regionName: testRegion,
         })
         await waitUntil(async () => registry.size !== 0, { interval: 100, timeout: 1000 })
 
-        //registry is asserted to have only one entry, so this is assumed to be the session that was
-        //started in this test.
+        // registry is asserted to have only one entry, so this is assumed to be the session that was
+        // started in this test.
         let sessionUri: vscode.Uri | undefined
         registry.forEach((session) => (sessionUri = session.uri))
         if (sessionUri === undefined) {
@@ -104,8 +104,8 @@ describe('TailLogGroup', function () {
         assert.strictEqual(startLiveTailSessionSpy.calledOnce, true)
         assert.strictEqual(registry.size, 1)
 
-        //Validate writing to the document.
-        //MaxLines is set to 1, and "testMessage3" is the last event in the stream, its contents should be the only thing in the doc.
+        // Validate writing to the document.
+        // MaxLines is set to 1, and "testMessage3" is the last event in the stream, its contents should be the only thing in the doc.
         const window = getTestWindow()
         const document = window.activeTextEditor?.document
         assert.strictEqual(sessionUri.toString(), document?.uri.toString())
@@ -115,7 +115,7 @@ describe('TailLogGroup', function () {
         )
         assert.strictEqual(doesDocumentContainExpectedContent, true)
 
-        //Test that closing all tabs the session's document is open in will cause the session to close
+        // Test that closing all tabs the session's document is open in will cause the session to close
         let tabs: vscode.Tab[] = []
         window.tabGroups.all.forEach((tabGroup) => {
             tabs = tabs.concat(getLiveTailSessionTabsFromTabGroup(tabGroup, sessionUri!))

packages/core/src/test/awsService/cloudWatchLogs/registry/liveTailSession.test.ts

@@ -117,7 +117,7 @@ describe('LiveTailSession', async function () {
         assert.strictEqual(session.isAborted, true)
         assert.strictEqual(clock.countTimers(), 0)
 
-        //Session is stopped; ticking the clock forward should not change the session duration
+        // Session is stopped; ticking the clock forward should not change the session duration
         clock.tick(1000)
         assert.strictEqual(session.getLiveTailSessionDuration(), 1000)
     })