lint: maximum name length #3109

Problem:

    extremelyLongNamesThatExplainTooMuchShouldLiveInTheDocstringNotTheName()

Solution:
Enforce lessLongName by lint rule. https://eslint.org/docs/latest/rules/id-length

Author: justinmk3

.eslintrc.js

@@ -19,6 +19,16 @@ module.exports = {
     ],
     rules: {
         curly: 2, // Enforce braces on "if"/"for"/etc.
+        'id-length': [
+            'error',
+            {
+                min: 1,
+                max: 40,
+                exceptionPatterns: [
+                    '^codecatalyst_', // CodeCatalyst telemetry names are verbose :(
+                ],
+            },
+        ],
         // https://typescript-eslint.io/rules/naming-convention/
         '@typescript-eslint/naming-convention': [
             'error',

src/cloudWatchLogs/commands/viewLogStream.ts

@@ -81,7 +81,7 @@ export class DefaultSelectLogStreamWizardContext implements SelectLogStreamWizar
                     },
                     request,
                 }),
-            response => convertDescribeLogStreamsToQuickPickItems(response)
+            response => convertDescribeLogToQuickPickItems(response)
         )
 
         const controller = new picker.IteratingQuickPickController(qp, populator)
@@ -112,7 +112,7 @@ export class DefaultSelectLogStreamWizardContext implements SelectLogStreamWizar
     }
 }
 
-export function convertDescribeLogStreamsToQuickPickItems(
+export function convertDescribeLogToQuickPickItems(
     response: CloudWatchLogs.DescribeLogStreamsResponse
 ): vscode.QuickPickItem[] {
     return (response.logStreams ?? []).map<vscode.QuickPickItem>(stream => ({

src/codewhisperer/activation.ts

@@ -186,7 +186,7 @@ export async function activate(context: ExtContext): Promise<void> {
             if (isInlineCompletionEnabled() && e.uri.fsPath !== InlineCompletionService.instance.filePath()) {
                 return
             }
-            RecommendationHandler.instance.reportUserDecisionOfCurrentRecommendation(vscode.window.activeTextEditor, -1)
+            RecommendationHandler.instance.reportUserDecisionOfRecommendation(vscode.window.activeTextEditor, -1)
             RecommendationHandler.instance.clearRecommendations()
         }),
 
@@ -246,11 +246,11 @@ export async function activate(context: ExtContext): Promise<void> {
                 ) || false
             const notificationLastShown: number =
                 context.extensionContext.globalState.get<number | undefined>(
-                    CodeWhispererConstants.accessTokenMigrationDoNotShowAgainLastShown
+                    CodeWhispererConstants.accessTokenMigrationDoNotShowLastShown
                 ) || 1
 
             //Add 7 days to notificationLastShown to determine whether warn message should show
-            if (doNotShowAgain || notificationLastShown + (1000 * 60 * 60 * 24 * 7) >= Date.now()) {
+            if (doNotShowAgain || notificationLastShown + 1000 * 60 * 60 * 24 * 7 >= Date.now()) {
                 return
             } else if (t <= CodeWhispererConstants.accessTokenCutOffDate) {
                 vscode.window
@@ -275,7 +275,7 @@ export async function activate(context: ExtContext): Promise<void> {
                         }
                     })
                 context.extensionContext.globalState.update(
-                    CodeWhispererConstants.accessTokenMigrationDoNotShowAgainLastShown,
+                    CodeWhispererConstants.accessTokenMigrationDoNotShowLastShown,
                     Date.now()
                 )
             } else {
@@ -311,7 +311,7 @@ export async function activate(context: ExtContext): Promise<void> {
 
     async function showCodeWhispererWelcomeMessage(): Promise<void> {
         const filePath = isCloud9()
-            ? context.extensionContext.asAbsolutePath(CodeWhispererConstants.welcomeCodeWhispererCloud9ReadmeFileSource)
+            ? context.extensionContext.asAbsolutePath(CodeWhispererConstants.welcomeCodeWhispererCloud9Readme)
             : context.extensionContext.asAbsolutePath(CodeWhispererConstants.welcomeCodeWhispererReadmeFileSource)
         const readmeUri = vscode.Uri.file(filePath)
         await vscode.commands.executeCommand('markdown.showPreviewToSide', readmeUri)
@@ -330,13 +330,12 @@ export async function activate(context: ExtContext): Promise<void> {
             vscode.workspace.getConfiguration('editor').get('suggest.showMethods') || false
         const isAutomatedTriggerEnabled: boolean = getAutoTriggerStatus()
         const isManualTriggerEnabled: boolean = await getManualTriggerStatus()
-        const isIncludeSuggestionsWithCodeReferencesEnabled =
-            codewhispererSettings.isIncludeSuggestionsWithCodeReferencesEnabled()
+        const isSuggestionsWithCodeReferencesEnabled = codewhispererSettings.isSuggestionsWithCodeReferencesEnabled()
         return {
             isShowMethodsEnabled,
             isManualTriggerEnabled,
             isAutomatedTriggerEnabled,
-            isIncludeSuggestionsWithCodeReferencesEnabled,
+            isSuggestionsWithCodeReferencesEnabled,
         }
     }
 
@@ -617,7 +616,7 @@ export async function activate(context: ExtContext): Promise<void> {
 
 export async function shutdown() {
     if (isCloud9()) {
-        RecommendationHandler.instance.reportUserDecisionOfCurrentRecommendation(vscode.window.activeTextEditor, -1)
+        RecommendationHandler.instance.reportUserDecisionOfRecommendation(vscode.window.activeTextEditor, -1)
         RecommendationHandler.instance.clearRecommendations()
     }
     if (isInlineCompletionEnabled()) {

src/codewhisperer/commands/invokeRecommendation.ts

@@ -58,7 +58,7 @@ export async function invokeRecommendation(
             vsCodeState.isIntelliSenseActive = false
             RecommendationHandler.instance.isGenerateRecommendationInProgress = true
             try {
-                RecommendationHandler.instance.reportUserDecisionOfCurrentRecommendation(editor, -1)
+                RecommendationHandler.instance.reportUserDecisionOfRecommendation(editor, -1)
                 RecommendationHandler.instance.clearRecommendations()
                 await RecommendationHandler.instance.getRecommendations(
                     client,

src/codewhisperer/commands/onAcceptance.ts

@@ -32,7 +32,7 @@ export async function onAcceptance(acceptanceEntry: OnRecommendationAcceptanceEn
         const start = acceptanceEntry.range.start
         const end = isCloud9() ? acceptanceEntry.editor.selection.active : acceptanceEntry.range.end
         const languageId = acceptanceEntry.editor.document.languageId
-        RecommendationHandler.instance.reportUserDecisionOfCurrentRecommendation(
+        RecommendationHandler.instance.reportUserDecisionOfRecommendation(
             acceptanceEntry.editor,
             acceptanceEntry.acceptIndex
         )

src/codewhisperer/commands/onInlineAcceptance.ts

@@ -84,7 +84,7 @@ export async function onInlineAcceptance(
         const start = acceptanceEntry.range.start
         const end = acceptanceEntry.editor.selection.active
         const languageId = acceptanceEntry.editor.document.languageId
-        RecommendationHandler.instance.reportUserDecisionOfCurrentRecommendation(
+        RecommendationHandler.instance.reportUserDecisionOfRecommendation(
             acceptanceEntry.editor,
             acceptanceEntry.acceptIndex
         )

src/codewhisperer/models/constants.ts

@@ -103,7 +103,7 @@ export const licenseFilter = 'CodeWhisperer suggestions were filtered due to ref
  */
 export const welcomeCodeWhispererReadmeFileSource = 'resources/markdown/WelcomeToCodeWhisperer.md'
 
-export const welcomeCodeWhispererCloud9ReadmeFileSource = 'resources/markdown/WelcomeToCodeWhispererCloud9.md'
+export const welcomeCodeWhispererCloud9Readme = 'resources/markdown/WelcomeToCodeWhispererCloud9.md'
 
 export const welcomeMessageKey = 'CODEWHISPERER_WELCOME_MESSAGE'
 
@@ -242,7 +242,7 @@ export const accessTokenMigrationDoNotShowAgain = `Don\'t Show Again`
 
 export const accessTokenMigrationDoNotShowAgainKey = 'CODEWHISPERER_ACCESS_TOKEN_MIGRATION_DO_NOT_SHOW_AGAIN'
 
-export const accessTokenMigrationDoNotShowAgainLastShown =
+export const accessTokenMigrationDoNotShowLastShown =
     'CODEWHISPERER_ACCESS_TOKEN_MIGRATION_DO_NOT_SHOW_AGAIN_LAST_SHOWN_TIME'
 
 export const accessTokenMigrationDoNotShowAgainInfo = `You will not receive this notification again. If you would like to continue using CodeWhisperer after January 31, 2023, you can still connect with AWS. [Learn More](https://docs.aws.amazon.com/toolkit-for-vscode/latest/userguide/codewhisper-setup-general.html).`

src/codewhisperer/models/model.ts

@@ -65,7 +65,7 @@ export interface ConfigurationEntry {
     readonly isShowMethodsEnabled: boolean
     readonly isManualTriggerEnabled: boolean
     readonly isAutomatedTriggerEnabled: boolean
-    readonly isIncludeSuggestionsWithCodeReferencesEnabled: boolean
+    readonly isSuggestionsWithCodeReferencesEnabled: boolean
 }
 
 export interface InlineCompletionItem {

src/codewhisperer/service/inlineCompletion.ts

@@ -136,7 +136,7 @@ export class InlineCompletion {
 
         RecommendationHandler.instance.cancelPaginatedRequest()
         // report all recommendation as rejected
-        RecommendationHandler.instance.reportUserDecisionOfCurrentRecommendation(editor, -1)
+        RecommendationHandler.instance.reportUserDecisionOfRecommendation(editor, -1)
     }
 
     async rejectRecommendation(
@@ -329,7 +329,7 @@ export class InlineCompletion {
         config: ConfigurationEntry,
         autoTriggerType?: CodewhispererAutomatedTriggerType
     ) {
-        RecommendationHandler.instance.reportUserDecisionOfCurrentRecommendation(editor, -1)
+        RecommendationHandler.instance.reportUserDecisionOfRecommendation(editor, -1)
         RecommendationHandler.instance.clearRecommendations()
         this.setCodeWhispererStatusBarLoading()
         const isManualTrigger = triggerType === 'OnDemand'
@@ -355,7 +355,7 @@ export class InlineCompletion {
                 )
                 this.setCompletionItems(editor)
                 if (RecommendationHandler.instance.checkAndResetCancellationTokens()) {
-                    RecommendationHandler.instance.reportUserDecisionOfCurrentRecommendation(editor, -1)
+                    RecommendationHandler.instance.reportUserDecisionOfRecommendation(editor, -1)
                     RecommendationHandler.instance.clearRecommendations()
                     break
                 }
@@ -397,7 +397,7 @@ export class InlineCompletion {
                     RecommendationHandler.instance.recommendations.forEach((r, i) => {
                         RecommendationHandler.instance.setSuggestionState(i, 'Discard')
                     })
-                    RecommendationHandler.instance.reportUserDecisionOfCurrentRecommendation(editor, -1)
+                    RecommendationHandler.instance.reportUserDecisionOfRecommendation(editor, -1)
                     RecommendationHandler.instance.clearRecommendations()
                     if (this._timer !== undefined) {
                         clearTimeout(this._timer)
@@ -427,7 +427,7 @@ export class InlineCompletion {
                         RecommendationHandler.instance.recommendations.forEach((r, i) => {
                             RecommendationHandler.instance.setSuggestionState(i, 'Discard')
                         })
-                        RecommendationHandler.instance.reportUserDecisionOfCurrentRecommendation(editor, -1)
+                        RecommendationHandler.instance.reportUserDecisionOfRecommendation(editor, -1)
                         RecommendationHandler.instance.clearRecommendations()
                     }
                     if (this._timer !== undefined) {
@@ -448,7 +448,7 @@ export class InlineCompletion {
                                     showTimedMessage(CodeWhispererConstants.noSuggestions, 2000)
                                 }
                             }
-                            RecommendationHandler.instance.reportUserDecisionOfCurrentRecommendation(editor, -1)
+                            RecommendationHandler.instance.reportUserDecisionOfRecommendation(editor, -1)
                             RecommendationHandler.instance.clearRecommendations()
                         }
                     }

src/codewhisperer/service/inlineCompletionService.ts

@@ -22,7 +22,7 @@ import { getPrefixSuffixOverlap } from '../util/commonUtil'
 import globals from '../../shared/extensionGlobals'
 import { AuthUtil } from '../util/authUtil'
 
-class CodeWhispererInlineCompletionItemProvider implements vscode.InlineCompletionItemProvider {
+class CWInlineCompletionItemProvider implements vscode.InlineCompletionItemProvider {
     private activeItemIndex: number | undefined
     public nextMove: number
 
@@ -86,7 +86,7 @@ class CodeWhispererInlineCompletionItemProvider implements vscode.InlineCompleti
         return index
     }
 
-    truncateSuggestionOverlapWithRightContext(document: vscode.TextDocument, suggestion: string): string {
+    truncateOverlapWithRightContext(document: vscode.TextDocument, suggestion: string): string {
         let rightContextRange: vscode.Range | undefined = undefined
         const pos = RecommendationHandler.instance.startPos
         if (suggestion.split(/\r?\n/).length > 1) {
@@ -110,7 +110,7 @@ class CodeWhispererInlineCompletionItemProvider implements vscode.InlineCompleti
         if (!r.content.startsWith(prefix)) {
             return undefined
         }
-        const truncatedSuggestion = this.truncateSuggestionOverlapWithRightContext(document, r.content)
+        const truncatedSuggestion = this.truncateOverlapWithRightContext(document, r.content)
         if (truncatedSuggestion.length === 0) {
             if (RecommendationHandler.instance.getSuggestionState(index) !== 'Showed') {
                 RecommendationHandler.instance.setSuggestionState(index, 'Discard')
@@ -210,7 +210,7 @@ const hideCommand = Commands.declare(
 )
 
 export class InlineCompletionService {
-    private inlineCompletionProvider?: CodeWhispererInlineCompletionItemProvider
+    private inlineCompletionProvider?: CWInlineCompletionItemProvider
     private inlineCompletionProviderDisposable?: vscode.Disposable
     private maxPage = 100
     private statusBar: vscode.StatusBarItem = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Left, 1)
@@ -289,7 +289,7 @@ export class InlineCompletionService {
             vsCodeState.isCodeWhispererEditing = false
             ReferenceInlineProvider.instance.removeInlineReference()
             RecommendationHandler.instance.cancelPaginatedRequest()
-            RecommendationHandler.instance.reportUserDecisionOfCurrentRecommendation(editor, -1)
+            RecommendationHandler.instance.reportUserDecisionOfRecommendation(editor, -1)
             RecommendationHandler.instance.clearRecommendations()
             this.disposeInlineCompletion()
             this.setCodeWhispererStatusBarOk()
@@ -312,7 +312,7 @@ export class InlineCompletionService {
             RecommendationHandler.instance.recommendations.forEach((r, i) => {
                 RecommendationHandler.instance.setSuggestionState(i, 'Discard')
             })
-            RecommendationHandler.instance.reportUserDecisionOfCurrentRecommendation(editor, -1)
+            RecommendationHandler.instance.reportUserDecisionOfRecommendation(editor, -1)
             RecommendationHandler.instance.clearRecommendations()
         } else if (RecommendationHandler.instance.recommendations.length > 0) {
             RecommendationHandler.instance.moveStartPositionToSkipSpaces(editor)
@@ -349,7 +349,7 @@ export class InlineCompletionService {
                     page
                 )
                 if (RecommendationHandler.instance.checkAndResetCancellationTokens()) {
-                    RecommendationHandler.instance.reportUserDecisionOfCurrentRecommendation(editor, -1)
+                    RecommendationHandler.instance.reportUserDecisionOfRecommendation(editor, -1)
                     RecommendationHandler.instance.clearRecommendations()
                     this.setCodeWhispererStatusBarOk()
                     return
@@ -377,7 +377,7 @@ export class InlineCompletionService {
         if (vscode.window.activeTextEditor) {
             vscode.window.showTextDocument(vscode.window.activeTextEditor.document)
         }
-        this.inlineCompletionProvider = new CodeWhispererInlineCompletionItemProvider(
+        this.inlineCompletionProvider = new CWInlineCompletionItemProvider(
             this.inlineCompletionProvider?.getActiveItemIndex,
             indexShift
         )