feat: e.code key codes hint suggestions

Author: zardoy

.vscode/settings.json

@@ -11,5 +11,8 @@
     ],
     "githubPullRequests.ignoredPullRequestBranches": [
         "develop"
+    ],
+    "cSpell.words": [
+        "unpatch"
     ]
 }

pnpm-lock.yaml

@@ -0,0 +1,71 @@
+import { matchParents, buildNotStrictStringCompletion } from '../utils'
+import { sharedCompletionContext } from './sharedContext'
+
+export default (): ts.CompletionEntry[] | void => {
+    const { node, program } = sharedCompletionContext
+    if (!node) return
+    const comparisonNode = getComparisonNode(node)
+    if (!comparisonNode) return
+    if (ts.isPropertyAccessExpression(comparisonNode) && ts.isIdentifier(comparisonNode.name) && comparisonNode.name.text === 'code') {
+        const typeChecker = program.getTypeChecker()
+        const symbol = typeChecker.getSymbolAtLocation(comparisonNode.name)
+        const decl = symbol?.declarations?.[0]
+        if (!decl) return
+        if (
+            decl.getSourceFile().fileName.endsWith('node_modules/typescript/lib/lib.dom.d.ts') &&
+            matchParents(decl.parent, ['InterfaceDeclaration'])?.name.text === 'KeyboardEvent'
+        ) {
+            return allKeyCodes.map(keyCode => buildNotStrictStringCompletion(node as ts.StringLiteralLike, keyCode))
+        }
+    }
+}
+
+// type: https://github.com/zardoy/contro-max/blob/master/src/types/keyCodes.ts
+const singleNumber = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
+const fNumbers = [...singleNumber.filter(x => x !== 0), 10, 11, 12].map(x => `F${x}`) // actually can go up to 24, but used rarely
+const letterKeys = ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z'].map(
+    x => `Key${x.toUpperCase()}`,
+)
+const someOtherKeys = [
+    'Space',
+    'Esc',
+    'Tab',
+    'Enter',
+    'Equal',
+    'Minus',
+    'Backslash',
+    'Slash',
+    'Period',
+    'Comma',
+    'Capslock',
+    'Numlock',
+    'PrintScreen',
+    'Scrolllock',
+    'Pause',
+    'Backspace',
+    'Delete',
+    'Insert',
+    'Backquote',
+    'BracketLeft',
+    'BracketRight',
+    ...['Up', 'Down', 'Left', 'Right'].map(x => `Arrow${x}`),
+    'Home',
+    'End',
+    'PageUp',
+    'PageDown',
+]
+
+const digitKeys = singleNumber.map(x => `Digit${x}`)
+const modifierOnlyKeys = ['Meta', 'Control', 'Alt', 'Shift'].flatMap(x => ['', 'Left', 'Right'].map(j => x + j))
+
+const numpadKeys = [...singleNumber, 'Divide', 'Multiply', 'Subtract', 'Add', 'Enter', 'Decimal'].map(x => `Numpad${x}`)
+const allKeyCodes = [...digitKeys, ...letterKeys, ...fNumbers, ...someOtherKeys, ...modifierOnlyKeys, ...numpadKeys]
+
+const getComparisonNode = (node: ts.Node) => {
+    if (!ts.isStringLiteralLike(node)) return
+    const binaryExpr = matchParents(node.parent, ['BinaryExpression'])
+    return binaryExpr?.right === node &&
+        [ts.SyntaxKind.EqualsEqualsEqualsToken, ts.SyntaxKind.ExclamationEqualsEqualsToken].includes(binaryExpr.operatorToken.kind)
+        ? binaryExpr.left
+        : matchParents(node.parent, ['CaseClause', 'CaseBlock', 'SwitchStatement'])?.expression
+}

typescript/src/completions/staticHintSuggestions.ts

@@ -31,6 +31,7 @@ import { getTupleSignature } from './tupleSignature'
 import stringTemplateTypeCompletions from './completions/stringTemplateType'
 import localityBonus from './completions/localityBonus'
 import functionCompletions from './completions/functionCompletions'
+import staticHintSuggestions from './completions/staticHintSuggestions'
 
 export type PrevCompletionMap = Record<
     string,
@@ -53,7 +54,7 @@ export type GetCompletionAtPositionReturnType = {
     completions: ts.CompletionInfo
     /** Let default getCompletionEntryDetails to know original name or let add documentation from here */
     prevCompletionsMap: PrevCompletionMap
-    prevCompletionsAdittionalData: PrevCompletionsAdditionalData
+    prevCompletionsAdditionalData: PrevCompletionsAdditionalData
 }
 
 export const getCompletionsAtPosition = (
@@ -289,6 +290,7 @@ export const getCompletionsAtPosition = (
     if (c('improveJsxCompletions') && leftNode) prior.entries = improveJsxCompletions(prior.entries, leftNode, position, sourceFile, c('jsxCompletionsMap'))
 
     prior.entries = localityBonus(prior.entries) ?? prior.entries
+    prior.entries.push(...(staticHintSuggestions() ?? []))
 
     const processedEntries = new Set<ts.CompletionEntry>()
     for (const rule of c('replaceSuggestions')) {
@@ -410,7 +412,7 @@ export const getCompletionsAtPosition = (
     return {
         completions: prior,
         prevCompletionsMap,
-        prevCompletionsAdittionalData: {
+        prevCompletionsAdditionalData: {
             enableMethodCompletion: goodPositionForMethodCompletions,
             completionsSymbolMap,
         },

typescript/src/completionsAtPosition.ts

@@ -44,7 +44,7 @@ export const decorateLanguageService = (
     const proxy = getInitialProxy(languageService, existingProxy)
 
     let prevCompletionsMap: PrevCompletionMap
-    let prevCompletionsAdittionalData: PrevCompletionsAdditionalData
+    let prevCompletionsAdditionalData: PrevCompletionsAdditionalData
 
     proxy.getEditsForFileRename = (oldFilePath, newFilePath, formatOptions, preferences) => {
         let edits = languageService.getEditsForFileRename(oldFilePath, newFilePath, formatOptions, preferences)
@@ -127,11 +127,11 @@ export const decorateLanguageService = (
         const result = getCompletionsAtPosition(fileName, position, options, c, languageService, scriptSnapshot, formatOptions, { scriptKind, compilerOptions })
         if (!result) return
         prevCompletionsMap = result.prevCompletionsMap
-        prevCompletionsAdittionalData = result.prevCompletionsAdittionalData
+        prevCompletionsAdditionalData = result.prevCompletionsAdditionalData
         return result.completions
     }
 
-    proxy.getCompletionEntryDetails = (...inputArgs) => completionEntryDetails(inputArgs, languageService, prevCompletionsMap, c, prevCompletionsAdittionalData)
+    proxy.getCompletionEntryDetails = (...inputArgs) => completionEntryDetails(inputArgs, languageService, prevCompletionsMap, c, prevCompletionsAdditionalData)
 
     decorateCodeActions(proxy, languageService, languageServiceHost, c)
     decorateCodeFixes(proxy, languageService, languageServiceHost, c)

typescript/src/decorateProxy.ts

@@ -1,6 +1,7 @@
 /* eslint-disable @typescript-eslint/no-require-imports */
 import { Except, SetOptional } from 'type-fest'
 import * as semver from 'semver'
+import type { MatchParentsType } from './utilTypes'
 
 export function findChildContainingPosition(typescript: typeof ts, sourceFile: ts.SourceFile, position: number): ts.Node | undefined {
     function find(node: ts.Node): ts.Node | undefined {
@@ -164,12 +165,13 @@ export const isWeb = () => {
 }
 
 // spec isnt strict as well
-export const notStrictStringCompletion = (entry: ts.CompletionEntry): ts.CompletionEntry => ({
-    ...entry,
-    // todo
-    name: `◯${entry.name}`,
-    insertText: entry.insertText ?? entry.name,
-})
+export const buildNotStrictStringCompletion = (node: ts.StringLiteralLike, text: string): ts.CompletionEntry =>
+    buildStringCompletion(node, {
+        // ...entry,
+        sortText: '07',
+        name: `💡${text}`,
+        insertText: text,
+    })
 
 export function addObjectMethodResultInterceptors<T extends Record<string, any>>(
     object: T,
@@ -295,3 +297,18 @@ export const patchMethod = <T, K extends keyof T>(obj: T, method: K, overriden:
 
 export const insertTextAfterEntry = (entryOrName: ts.CompletionEntry | string, appendText: string) =>
     (typeof entryOrName === 'string' ? entryOrName : entryOrName.name).replace(/\$/g, '\\$') + appendText
+
+export const matchParents: MatchParentsType = (node, treeToCompare) => {
+    let first = true
+    for (const toCompare of treeToCompare) {
+        if (!first) {
+            node = node?.parent
+            first = false
+        }
+        if (!node) return
+        if (!(ts[`is${toCompare}` as keyof typeof ts] as (node) => boolean)(node)) {
+            return
+        }
+    }
+    return node as any
+}