Add Windows and Mac CI runner (typescript-language-server#248)

Author: rchl

.gitattributes

@@ -0,0 +1,2 @@
+# Force LF line endings everywhere (especially for Windows CI)
+* text eol=lf

.github/workflows/ci.yaml

@@ -10,14 +10,15 @@ on:
     - master
 
 jobs:
-  build:
-    runs-on: ubuntu-latest
-    env:
-      CI: true
+  tests:
     strategy:
       matrix:
+        os: [windows-latest, macos-latest, ubuntu-latest]
         node-version: [12.x, 14.x, 16.x]
-    name: Use Node.js ${{ matrix.node-version }}
+    runs-on: ${{ matrix.os }}
+    env:
+      CI: true
+    name: ${{ matrix.os }} (Node.js ${{ matrix.node-version }})
     steps:
       - uses: actions/checkout@v2
       - name: Setup node

package.json

@@ -31,7 +31,7 @@
   "scripts": {
     "clean": "rimraf lib *.tsbuildinfo",
     "test": "mocha --exit --reporter spec \"./lib/**/*.spec.js\"",
-    "lint": "eslint --ext '.js,.ts' src",
+    "lint": "eslint --ext \".js,.ts\" src",
     "build": "concurrently -n compile,lint -c blue,green \"yarn compile\" \"yarn lint\"",
     "compile": "tsc -b",
     "watch": "tsc -b --watch --verbose"

src/organize-imports.spec.ts

@@ -1,13 +1,15 @@
 import tsp from 'typescript/lib/protocol';
 import * as chai from 'chai';
 import { provideOrganizeImports } from './organize-imports';
+import { filePath } from './test-utils';
 
 describe('provideOrganizeImports', () => {
     it('converts tsserver response to lsp code actions', () => {
+        const fileName = filePath('file');
         const response = {
             body: [
                 {
-                    fileName: '/my/file',
+                    fileName,
                     textChanges: []
                 }
             ]
@@ -19,7 +21,7 @@ describe('provideOrganizeImports', () => {
             command: {
                 title: '',
                 command: '_typescript.organizeImports',
-                arguments: ['/my/file']
+                arguments: [fileName]
             }
         }];
         chai.assert.deepEqual(actual, expected);

src/organize-imports.ts

@@ -8,6 +8,7 @@
 import * as lsp from 'vscode-languageserver/node';
 import tsp from 'typescript/lib/protocol';
 import { Commands } from './commands';
+import { normalizeFileNameToFsPath } from './protocol-translation';
 import { CodeActionKind } from 'vscode-languageserver/node';
 
 export function provideOrganizeImports(response: tsp.OrganizeImportsResponse | undefined): Array<lsp.CodeAction> {
@@ -16,7 +17,7 @@ export function provideOrganizeImports(response: tsp.OrganizeImportsResponse | u
     }
     return response.body.map(edit => lsp.CodeAction.create(
         'Organize imports',
-        lsp.Command.create('', Commands.ORGANIZE_IMPORTS, edit.fileName),
+        lsp.Command.create('', Commands.ORGANIZE_IMPORTS, normalizeFileNameToFsPath(edit.fileName)),
         CodeActionKind.SourceOrganizeImports
     ));
 }

src/protocol-translation.ts

@@ -34,6 +34,18 @@ export function pathToUri(filepath: string, documents: LspDocuments | undefined)
     return document ? document.uri : fileUri.toString();
 }
 
+/**
+ * Normalizes the file system path.
+ *
+ * On systems other than Windows it should be an no-op.
+ *
+ * On Windows, an input path in a format like "c:/path/file.ts"
+ * will be normalized to "c:\path\file.ts" (same as returned through URI.fsPath).
+ */
+export function normalizeFileNameToFsPath(fileName: string): string {
+    return URI.file(fileName).fsPath;
+}
+
 function currentVersion(filepath: string, documents: LspDocuments | undefined): number {
     const fileUri = URI.file(filepath);
     const document = documents && documents.get(fileUri.fsPath);

src/test-utils.ts

@@ -8,9 +8,10 @@
 import * as path from 'path';
 import * as fs from 'fs';
 import * as lsp from 'vscode-languageserver/node';
-import { pathToUri } from './protocol-translation';
+import { normalizeFileNameToFsPath, pathToUri } from './protocol-translation';
 import { LspServer } from './lsp-server';
 import { ConsoleLogger } from './logger';
+import { getTsserverExecutable } from './utils';
 import { TextDocument } from 'vscode-languageserver-textdocument';
 
 export function getDefaultClientCapabilities(): lsp.ClientCapabilities {
@@ -38,7 +39,7 @@ export function uri(suffix = ''): string {
 }
 
 export function filePath(suffix = ''): string {
-    return path.resolve(__dirname, '../test-data', suffix);
+    return normalizeFileNameToFsPath(path.resolve(__dirname, '../test-data', suffix));
 }
 
 export function readContents(path: string): string {
@@ -75,7 +76,7 @@ export async function createServer(options: {
     const logger = new ConsoleLogger(false);
     const server = new LspServer({
         logger,
-        tsserverPath: 'tsserver',
+        tsserverPath: getTsserverExecutable(),
         tsserverLogVerbosity: options.tsserverLogVerbosity,
         tsserverLogFile: path.resolve(__dirname, '../tsserver.log'),
         lspClient: {

src/tsp-client.spec.ts

@@ -12,12 +12,13 @@ import { ConsoleLogger } from './logger';
 import { filePath, readContents } from './test-utils';
 import { CommandTypes } from './tsp-command-types';
 import { findPathToModule } from './modules-resolver';
+import { getTsserverExecutable } from './utils';
 
 const assert = chai.assert;
 
 const executableServer = new TspClient({
     logger: new ConsoleLogger(),
-    tsserverPath: 'tsserver'
+    tsserverPath: getTsserverExecutable()
 });
 
 const tsserverModuleRelativePath = path.join('typescript', 'lib', 'tsserver.js');