typescript-language-server · rchl · Aug 21, 2022 · Aug 21, 2022
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -14,7 +14,7 @@ module.exports = {
     rules: {
         'array-bracket-spacing':  'error',
         'brace-style': 'error',
-        'comma-dangle': 'error',
+        'comma-dangle': ['error', 'always-multiline'],
         'comma-spacing': 'error',
         'computed-property-spacing': 'error',
         curly: 'error',

diff --git a/package.json b/package.json
@@ -24,6 +24,7 @@
     "test:watch": "cross-env CONSOLE_LOG_LEVEL=warn TS_NODE_PROJECT=./tsconfig.json mocha --watch",
     "test:compiled": "cross-env CONSOLE_LOG_LEVEL=warn mocha \"./lib/**/*.spec.js\"",
     "lint": "eslint --ext \".js,.ts\" src",
+    "fix": "eslint --ext \".js,.ts\" --fix src",
     "build": "concurrently -n compile,lint -c blue,green \"yarn compile\" \"yarn lint\"",
     "compile": "tsc -b",
     "watch": "tsc -b --watch --verbose",

diff --git a/src/calls.ts b/src/calls.ts
@@ -28,7 +28,7 @@ export async function computeCallers(tspClient: TspClient, args: lsp.TextDocumen
         const location = toLocation(callerReference, undefined);
         calls.push({
             location,
-            symbol
+            symbol,
         });
     }
     return { calls, symbol: contextSymbol };
@@ -59,7 +59,7 @@ export async function computeCallees(tspClient: TspClient, args: lsp.TextDocumen
         const location = toLocation(reference, undefined);
         calls.push({
             location,
-            symbol: definitionSymbol
+            symbol: definitionSymbol,
         });
     }
     return { calls, symbol: contextSymbol };
@@ -128,7 +128,7 @@ async function getDefinition(tspClient: TspClient, args: lsp.TextDocumentPositio
     const definitionResult = await tspClient.request(CommandTypes.Definition, {
         file,
         line: args.position.line + 1,
-        offset: args.position.character + 1
+        offset: args.position.character + 1,
     });
     return definitionResult.body ? definitionResult.body[0] : undefined;
 }
@@ -180,7 +180,7 @@ function findEnclosingSymbolInTree(parent: tsp.NavigationTree, range: lsp.Range)
         name: candidate.text,
         kind: toSymbolKind(candidate.kind),
         range: spanRange,
-        selectionRange: selectionRange
+        selectionRange: selectionRange,
     };
 }
 
@@ -197,7 +197,7 @@ async function findReferences(tspClient: TspClient, args: tsp.FileSpan): Promise
     const result = await tspClient.request(CommandTypes.References, {
         file,
         line: args.start.line,
-        offset: args.start.offset
+        offset: args.start.offset,
     });
     if (!result.body) {
         return [];

diff --git a/src/cli.ts b/src/cli.ts
@@ -43,5 +43,5 @@ createLspConnection({
     tsserverPath: options.tsserverPath as string,
     tsserverLogFile: options.tsserverLogFile as string,
     tsserverLogVerbosity: options.tsserverLogVerbosity as string,
-    showMessageLevel: logLevel as lsp.MessageType
+    showMessageLevel: logLevel as lsp.MessageType,
 }).listen();
diff --git a/src/commands.ts b/src/commands.ts
@@ -16,5 +16,5 @@ export const Commands = {
     APPLY_COMPLETION_CODE_ACTION: '_typescript.applyCompletionCodeAction',
     /** Commands below should be implemented by the client */
     SELECT_REFACTORING: '_typescript.selectRefactoring',
-    SOURCE_DEFINITION: SourceDefinitionCommand.id
+    SOURCE_DEFINITION: SourceDefinitionCommand.id,
 };
diff --git a/src/completion.ts b/src/completion.ts
@@ -38,10 +38,10 @@ export function asCompletionItem(entry: tsp.CompletionEntry, file: string, posit
                 entry.source || entry.data ? {
                     name: entry.name,
                     source: entry.source,
-                    data: entry.data
-                } : entry.name
-            ]
-        }
+                    data: entry.data,
+                } : entry.name,
+            ],
+        },
     };
 
     if (entry.source && entry.hasAction) {
@@ -192,7 +192,7 @@ function asCommitCharacters(kind: ScriptElementKind): string[] | undefined {
 }
 
 export async function asResolvedCompletionItem(
-    item: lsp.CompletionItem, details: tsp.CompletionEntryDetails, client: TspClient, options: WorkspaceConfigurationCompletionOptions, features: SupportedFeatures
+    item: lsp.CompletionItem, details: tsp.CompletionEntryDetails, client: TspClient, options: WorkspaceConfigurationCompletionOptions, features: SupportedFeatures,
 ): Promise<lsp.CompletionItem> {
     item.detail = asDetail(details);
     item.documentation = asDocumentation(details);
@@ -364,8 +364,8 @@ function asCommand(codeActions: tsp.CodeAction[], filepath: string): lsp.Command
             arguments: [filepath, codeActions.map(codeAction => ({
                 commands: codeAction.commands,
                 description: codeAction.description,
-                changes: codeAction.changes.filter(x => x.fileName !== filepath)
-            }))]
+                changes: codeAction.changes.filter(x => x.fileName !== filepath),
+            }))],
         };
     }
 }

diff --git a/src/configuration-manager.ts b/src/configuration-manager.ts
@@ -36,7 +36,7 @@ const DEFAULT_TSSERVER_PREFERENCES: Required<tsp.UserPreferences> = {
     providePrefixAndSuffixTextForRename: true,
     provideRefactorNotApplicableReason: false,
     quotePreference: 'auto',
-    useLabelDetailsInCompletionEntries: true
+    useLabelDetailsInCompletionEntries: true,
 };
 
 export interface WorkspaceConfiguration {
@@ -88,20 +88,20 @@ export class ConfigurationManager {
         this.tspClient = client;
         const formatOptions: tsp.FormatCodeSettings = {
             // We can use \n here since the editor should normalize later on to its line endings.
-            newLineCharacter: '\n'
+            newLineCharacter: '\n',
         };
         const args: tsp.ConfigureRequestArguments = {
             ...hostInfo ? { hostInfo } : {},
             formatOptions,
-            preferences: this.tsPreferences
+            preferences: this.tsPreferences,
         };
         await this.tspClient?.request(CommandTypes.Configure, args);
     }
 
     public async configureGloballyFromDocument(filename: string, formattingOptions?: lsp.FormattingOptions): Promise<void> {
         const args: tsp.ConfigureRequestArguments = {
             formatOptions: this.getFormattingOptions(filename, formattingOptions),
-            preferences: this.getPreferences(filename)
+            preferences: this.getPreferences(filename),
         };
         await this.tspClient?.request(CommandTypes.Configure, args);
     }
@@ -115,12 +115,12 @@ export class ConfigurationManager {
         const preferences = Object.assign<tsp.UserPreferences, tsp.UserPreferences, tsp.UserPreferences>(
             {},
             this.tsPreferences,
-            workspacePreferences?.inlayHints || {}
+            workspacePreferences?.inlayHints || {},
         );
 
         return {
             ...preferences,
-            quotePreference: this.getQuoteStylePreference(preferences)
+            quotePreference: this.getQuoteStylePreference(preferences),
         };
     }
 
@@ -129,7 +129,7 @@ export class ConfigurationManager {
 
         const opts: tsp.FormatCodeSettings = {
             ...workspacePreferences?.format,
-            ...formattingOptions
+            ...formattingOptions,
         };
 
         if (opts.convertTabsToSpaces === undefined) {

diff --git a/src/diagnostic-queue.ts b/src/diagnostic-queue.ts
@@ -21,7 +21,7 @@ class FileDiagnostics {
         protected readonly uri: string,
         protected readonly publishDiagnostics: (params: lsp.PublishDiagnosticsParams) => void,
         protected readonly documents: LspDocuments,
-        protected readonly features: SupportedFeatures
+        protected readonly features: SupportedFeatures,
     ) { }
 
     update(kind: EventTypes, diagnostics: tsp.Diagnostic[]): void {
@@ -52,7 +52,7 @@ export class DiagnosticEventQueue {
         protected readonly publishDiagnostics: (params: lsp.PublishDiagnosticsParams) => void,
         protected readonly documents: LspDocuments,
         protected readonly features: SupportedFeatures,
-        protected readonly logger: Logger
+        protected readonly logger: Logger,
     ) { }
 
     updateDiagnostics(kind: EventTypes, event: tsp.DiagnosticEvent): void {

diff --git a/src/document-symbol.ts b/src/document-symbol.ts
@@ -48,7 +48,7 @@ function collectDocumentSymbolsInRange(parent: tsp.NavigationTree, symbols: lsp.
                 kind: toSymbolKind(parent.kind),
                 range: spanRange,
                 selectionRange: selectionRange,
-                children
+                children,
             });
         }
     }
@@ -76,9 +76,9 @@ export function collectSymbolInformation(uri: string, current: tsp.NavigationTre
                 kind: toSymbolKind(current.kind),
                 location: {
                     uri,
-                    range
+                    range,
                 },
-                containerName
+                containerName,
             });
             symbols.push(...children);
         }

diff --git a/src/features/fix-all.ts b/src/features/fix-all.ts
@@ -24,7 +24,7 @@ async function buildIndividualFixes(
     client: TspClient,
     file: string,
     documents: LspDocuments,
-    diagnostics: readonly lsp.Diagnostic[]
+    diagnostics: readonly lsp.Diagnostic[],
 ): Promise<lsp.TextDocumentEdit[]> {
     const edits: lsp.TextDocumentEdit[] = [];
     for (const diagnostic of diagnostics) {
@@ -35,7 +35,7 @@ async function buildIndividualFixes(
 
             const args: tsp.CodeFixRequestArgs = {
                 ...Range.toFileRangeRequestArgs(file, diagnostic.range),
-                errorCodes: [+diagnostic.code!]
+                errorCodes: [+diagnostic.code!],
             };
 
             const response = await client.request(CommandTypes.GetCodeFixes, args);
@@ -58,7 +58,7 @@ async function buildCombinedFix(
     client: TspClient,
     file: string,
     documents: LspDocuments,
-    diagnostics: readonly lsp.Diagnostic[]
+    diagnostics: readonly lsp.Diagnostic[],
 ): Promise<lsp.TextDocumentEdit[]> {
     const edits: lsp.TextDocumentEdit[] = [];
     for (const diagnostic of diagnostics) {
@@ -69,7 +69,7 @@ async function buildCombinedFix(
 
             const args: tsp.CodeFixRequestArgs = {
                 ...Range.toFileRangeRequestArgs(file, diagnostic.range),
-                errorCodes: [+diagnostic.code!]
+                errorCodes: [+diagnostic.code!],
             };
 
             const response = await client.request(CommandTypes.GetCodeFixes, args);
@@ -90,9 +90,9 @@ async function buildCombinedFix(
             const combinedArgs: tsp.GetCombinedCodeFixRequestArgs = {
                 scope: {
                     type: 'file',
-                    args: { file }
+                    args: { file },
                 },
-                fixId: fix.fixId
+                fixId: fix.fixId,
             };
 
             const combinedResponse = await client.request(CommandTypes.GetCombinedCodeFix, combinedArgs);
@@ -126,15 +126,15 @@ class SourceFixAll extends SourceAction {
         client: TspClient,
         file: string,
         documents: LspDocuments,
-        diagnostics: readonly lsp.Diagnostic[]
+        diagnostics: readonly lsp.Diagnostic[],
     ): Promise<lsp.CodeAction | null> {
         const edits: lsp.TextDocumentEdit[] = [];
         edits.push(...await buildIndividualFixes([
             { codes: errorCodes.incorrectlyImplementsInterface, fixName: fixNames.classIncorrectlyImplementsInterface },
-            { codes: errorCodes.asyncOnlyAllowedInAsyncFunctions, fixName: fixNames.awaitInSyncFunction }
+            { codes: errorCodes.asyncOnlyAllowedInAsyncFunctions, fixName: fixNames.awaitInSyncFunction },
         ], client, file, documents, diagnostics));
         edits.push(...await buildCombinedFix([
-            { codes: errorCodes.unreachableCode, fixName: fixNames.unreachableCode }
+            { codes: errorCodes.unreachableCode, fixName: fixNames.unreachableCode },
         ], client, file, documents, diagnostics));
         if (!edits.length) {
             return null;
@@ -151,10 +151,10 @@ class SourceRemoveUnused extends SourceAction {
         client: TspClient,
         file: string,
         documents: LspDocuments,
-        diagnostics: readonly lsp.Diagnostic[]
+        diagnostics: readonly lsp.Diagnostic[],
     ): Promise<lsp.CodeAction | null> {
         const edits = await buildCombinedFix([
-            { codes: errorCodes.variableDeclaredButNeverUsed, fixName: fixNames.unusedIdentifier }
+            { codes: errorCodes.variableDeclaredButNeverUsed, fixName: fixNames.unusedIdentifier },
         ], client, file, documents, diagnostics);
         if (!edits.length) {
             return null;
@@ -171,10 +171,10 @@ class SourceAddMissingImports extends SourceAction {
         client: TspClient,
         file: string,
         documents: LspDocuments,
-        diagnostics: readonly lsp.Diagnostic[]
+        diagnostics: readonly lsp.Diagnostic[],
     ): Promise<lsp.CodeAction | null> {
         const edits = await buildCombinedFix([
-            { codes: errorCodes.cannotFindName, fixName: fixNames.fixImport }
+            { codes: errorCodes.cannotFindName, fixName: fixNames.fixImport },
         ], client, file, documents, diagnostics);
         if (!edits.length) {
             return null;
@@ -189,7 +189,7 @@ export class TypeScriptAutoFixProvider {
     private static kindProviders = [
         SourceFixAll,
         SourceRemoveUnused,
-        SourceAddMissingImports
+        SourceAddMissingImports,
     ];
 
     public static get kinds(): CodeActionKind[] {

diff --git a/src/features/inlay-hints.ts b/src/features/inlay-hints.ts
@@ -29,7 +29,7 @@ export class TypeScriptInlayHintsProvider {
         documents: LspDocuments,
         tspClient: TspClient,
         lspClient: LspClient,
-        configurationManager: ConfigurationManager
+        configurationManager: ConfigurationManager,
     ): Promise<lsp.InlayHint[]> {
         if (tspClient.apiVersion.lt(TypeScriptInlayHintsProvider.minVersion)) {
             lspClient.showErrorMessage('Inlay Hints request failed. Requires TypeScript 4.4+.');

diff --git a/src/features/source-definition.ts b/src/features/source-definition.ts
@@ -28,7 +28,7 @@ export class SourceDefinitionCommand {
         documents: LspDocuments,
         tspClient: TspClient,
         lspClient: LspClient,
-        reporter: lsp.WorkDoneProgressReporter
+        reporter: lsp.WorkDoneProgressReporter,
     ): Promise<lsp.Location[] | void> {
         if (tspClient.apiVersion.lt(SourceDefinitionCommand.minVersion)) {
             lspClient.showErrorMessage('Go to Source Definition failed. Requires TypeScript 4.7+.');
@@ -57,7 +57,7 @@ export class SourceDefinitionCommand {
         const args = Position.toFileLocationRequestArgs(file, position);
         return await lspClient.withProgress<lsp.Location[] | void>({
             message: 'Finding source definitions…',
-            reporter
+            reporter,
         }, async () => {
             const response = await tspClient.request(CommandTypes.FindSourceDefinition, args);
             if (response.type === 'response' && response.body?.length) {

diff --git a/src/file-lsp-server.spec.ts b/src/file-lsp-server.spec.ts
@@ -16,7 +16,7 @@ let server: LspServer;
 before(async () => {
     server = await createServer({
         rootUri: uri(),
-        publishDiagnostics: () => { }
+        publishDiagnostics: () => { },
     });
 });
 
@@ -35,15 +35,15 @@ describe('documentHighlight', () => {
             uri: uri('module2.ts'),
             languageId: 'typescript',
             version: 1,
-            text: readContents(filePath('module2.ts'))
+            text: readContents(filePath('module2.ts')),
         };
         server.didOpenTextDocument({
-            textDocument: doc
+            textDocument: doc,
         });
 
         const result = await server.documentHighlight({
             textDocument: doc,
-            position: lastPosition(doc, 'doStuff')
+            position: lastPosition(doc, 'doStuff'),
         });
         assert.equal(2, result.length, JSON.stringify(result, undefined, 2));
     });
@@ -55,12 +55,12 @@ describe('completions', () => {
             uri: uri('completion.ts'),
             languageId: 'typescript',
             version: 1,
-            text: readContents(filePath('completion.ts'))
+            text: readContents(filePath('completion.ts')),
         };
         server.didOpenTextDocument({ textDocument: doc });
         const proposals = await server.completion({
             textDocument: doc,
-            position: positionAfter(doc, 'doStuff')
+            position: positionAfter(doc, 'doStuff'),
         });
         assert.isNotNull(proposals);
         const completion = proposals!.items.find(item => item.label === 'doStuff');