Fixes code format and respect tabSize settings #19

Author: vknabel

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 2.3.2
+* Code format did fail #19
+* Code format always indented by 4 spaces. Now configurable.
+
+### Tabwidth
+By default `editor.tabSize` will be used. As this setting is global and affects all code, you can optionally override it using `"[swift]": { "tabSize": 2 }`.
+
 ## 2.3.1
 * Accidentially logged SourceKit's `key.kind` and `key.description`
 * Removed unused config `editor.quickSuggestions`

package.json

@@ -8,7 +8,7 @@
     "url": "https://github.com/vknabel"
   },
   "license": "Apache-2.0",
-  "version": "2.3.1",
+  "version": "2.3.2",
   "publisher": "vknabel",
   "icon": "icons/icon.png",
   "galleryBanner": {
@@ -146,9 +146,10 @@
   },
   "devDependencies": {
     "@types/bunyan": "latest",
+    "@types/js-yaml": "^3.11.1",
     "@types/node": "latest",
     "@types/xml-js": "^1.0.0",
-    "js-yaml": "^3.7.0",
+    "js-yaml": "^3.11.0",
     "mocha": "^2.3.3",
     "pegjs": "^0.10.0",
     "typescript": "^2.0.0",

projects/Watch/.gitignore

@@ -0,0 +1 @@
+.build

src/clientMain.ts

@@ -59,7 +59,7 @@ export function activate(context: ExtensionContext) {
 		// Register the server for plain text documents
 		documentSelector: ['swift'],
 		synchronize: {
-			configurationSection: 'swift',
+			configurationSection: ['swift', 'editor', '[swift]'],
 			// Notify the server about file changes to '.clientrc files contain in the workspace
 			fileEvents: workspace.createFileSystemWatcher('**/*.swift')
 		},

src/server/server.ts

@@ -131,7 +131,7 @@ connection.onInitialize((params: InitializeParams, cancellationToken): Initializ
 			// signatureHelpProvider: {
 			// 	triggerCharacters: ['[', ',']
 			// },
-			// We're prividing completions.
+			// We're providing completions.
 			completionProvider: {
 				resolveProvider: false,
 				triggerCharacters: [
@@ -147,13 +147,18 @@ connection.onInitialize((params: InitializeParams, cancellationToken): Initializ
 // The settings interface describe the server relevant settings part
 interface Settings {
 	swift: any;
+	editor: {
+		tabSize?: number
+	},
+	'[swift]': {}
 }
 
 
 //external
 export let sdeSettings: any;
 export let swiftDiverBinPath: string = null;
 export let maxBytesAllowedForCodeCompletionResponse: number = 0;
+export let editorSettings: Settings['editor'] = {};
 //internal
 export let skProtocolPath = null
 export let skProtocolProcessAsShellCmd = false
@@ -165,7 +170,8 @@ let shellPath = null
 connection.onDidChangeConfiguration((change) => {
 	trace("-->onDidChangeConfiguration")
 	const settings = <Settings>change.settings
-	sdeSettings = settings.swift;//FIXME configs only accessed via the language id?
+	sdeSettings = settings.swift;
+	editorSettings = { ...settings.editor, ...settings['[swift]'] };
 
 	//FIXME does LS client support on-the-fly change?
 	maxNumProblems = sdeSettings.diagnosis.max_num_problems
@@ -490,8 +496,6 @@ connection.onDefinition(({textDocument, position}): Promise<Definition> => {
 		});
 })
 
-
-
 connection.onDocumentFormatting(({textDocument, options}): Promise<TextEdit[]> => {
 	const document: TextDocument = documents.get(textDocument.uri);
 	const srcPath = fromDocumentUri(document);

src/server/sourcekites.ts

@@ -7,7 +7,9 @@ import {
 } from 'vscode-languageserver'
 
 import * as stream from 'stream'
+import * as yaml from 'js-yaml'
 import { ChildProcess } from "child_process";
+import { editorSettings } from './server';
 
 let skProtocolProcess: ChildProcess | null = null
 let skeHandler: SourcekiteResponseHandler | null = null
@@ -144,16 +146,16 @@ let reqCount = 0 //FIXME
 
 type RequestType = "codecomplete" | "cursorinfo" | "demangle" | "editor.open" | "editor.formattext"
 
-function parseSkResponse(resp: string): any {
-    return JSON.parse(jsonify(resp))
-}
-
 function pluck<T, K extends keyof T>(prop: K): (ofTarget: T) => T[K] {
     return target => target[prop];
 }
 
-function typedResponse(request: string, requestType: RequestType,
-    extraState: any = null, retries = 0): Promise<string> {
+function typedResponse<T>(request: string, requestType: RequestType,
+    extraState: any = null, retries = 0): Promise<T> {
+    function parseSkResponse(resp: string): any {
+        return yaml.safeLoad(resp);
+    }
+
     server.trace('to write request: ', request)
     const rid = reqCount++
     skProtocolProcess.stdin.write(rid + "\n")
@@ -168,7 +170,7 @@ function typedResponse(request: string, requestType: RequestType,
                 restartSourcekite();
                 return typedResponse(request, requestType, extraState, retries);
             }
-        })
+        }).then(parseSkResponse)
 }
 
 function request(
@@ -225,13 +227,12 @@ function request(
 //== codeComplete
 export function codeComplete(srcText: string, srcPath: string, offset: number): Promise<any> {
     return request("codecomplete", srcText, srcPath, offset)
-        .then(parseSkResponse).then(pluck("key.results"));
+        .then(pluck("key.results"));
 }
 
 //== cursorInfo
 export function cursorInfo(srcText: string, srcPath: string, offset: number): Promise<any> {
-    return request("cursorinfo", srcText, srcPath, offset)
-        .then(parseSkResponse);
+    return request("cursorinfo", srcText, srcPath, offset);
 }
 
 //== demangle
@@ -243,8 +244,8 @@ export function demangle(...demangledNames: string[]): Promise<any> {
 }
 
 `
-    return typedResponse(request, "demangle")
-        .then(parseSkResponse).then(pluck("key.results"))
+    return typedResponse<any>(request, "demangle")
+        .then(pluck("key.results"))
 }
 
 
@@ -260,7 +261,7 @@ export function editorFormatText(
         editorOpen(srcPath, srcText, false, false, true)
             .then((v) => {
                 // discard v
-                let p = requestEditorFormatText(srcPath, lineStart, 1, document)
+                let p = requestEditorFormatText({ file: srcPath, line: lineStart, document })
 
                 //TODO async-await
                 function nextp(fts: FormatTextState) {
@@ -269,7 +270,7 @@ export function editorFormatText(
                         let sPos: Position = { line: fts.line, character: 0 }
                         let ePos: Position = document.positionAt(
                             document.offsetAt({ line: fts.line + 1, character: 0 }) - 1)
-                        requestEditorFormatText(srcPath, fts.line + 1, 1, document)
+                        requestEditorFormatText({ file: srcPath, line: fts.line + 1, document })
                             .then(nextp)
                             .catch((err) => {
                                 reject(err)
@@ -307,52 +308,61 @@ function editorOpen(
 }
 
 `
-    return typedResponse(request, "editor.open")
-        .then(parseSkResponse)
+    return typedResponse(request, "editor.open");
 }
 
 interface FormatTextState {
     line: number,
     textEdit: TextEdit
 }
 
-function requestEditorFormatText(
-    keyName: string,
-    keyLine: number,
-    keyLength: number,//FIXME unuseful now
+interface SkFormatTextResponse {
+    'key.line': number;
+    'key.length': number;
+    'key.sourcetext': string;
+}
+
+function requestEditorFormatText(options: {
+    file: string,
+    line: number,
     document: TextDocument
-): Promise<FormatTextState> {
+}): Promise<FormatTextState> {
+    const indentationOptions = !editorSettings.tabSize
+        ? ''
+        : `key.editor.format.options: {
+            key.editor.format.indentwidth: ${editorSettings.tabSize},
+            key.editor.format.tabwidth: ${editorSettings.tabSize},
+            key.editor.format.usetabs: 0
+          }`;
     let request = `{
   key.request: source.request.editor.formattext,
-  key.name: "${keyName}",
-  key.line: ${keyLine},
-  key.length: ${keyLength},
+  key.name: "${options.file}",
+  key.line: ${options.line},
+  key.length: 1,
+  ${indentationOptions}
 }
 
 `;
-    let firstStartPos: Position = { line: keyLine - 1, character: 0 }
+    let firstStartPos: Position = { line: options.line - 1, character: 0 }
     let firstEndPos: Position =
-        keyLine != document.lineCount ?
-            document.positionAt(
-                document.offsetAt({ line: keyLine, character: 0 }) - 1) :
-            document.positionAt(
-                document.offsetAt({ line: document.lineCount, character: 0 }))
+        options.line != options.document.lineCount ?
+            options.document.positionAt(
+                options.document.offsetAt({ line: options.line, character: 0 }) - 1) :
+            options.document.positionAt(
+                options.document.offsetAt({ line: options.document.lineCount, character: 0 }))
     const extraState = {
-        keyLine: keyLine,
+        keyLine: options.line,
         lineRange: { start: firstStartPos, end: firstEndPos }//NOTE format req is 1-based
     }
     return typedResponse(request, "editor.formattext")
-        .then((resp: string) => {
+        .then((resp: SkFormatTextResponse) => {
             const keyLine = extraState.keyLine
             const lineRange = extraState.lineRange
-            let offSetEnd = resp.lastIndexOf("\"");
-            let offSetStart = resp.indexOf("\"", resp.lastIndexOf("key.sourcetext:")) + 1
-            let lineText = resp.substring(offSetStart, offSetEnd)
             return {
                 line: keyLine,
                 textEdit: {
                     range: lineRange,
-                    newText: JSON.parse(`"${lineText}"`) //NOTE convert back, silly...
+                    newText: resp['key.sourcetext']
                 }
             }
         })
@@ -373,17 +383,3 @@ function debugLog(msg: string) {
 function booleanToInt(v: boolean): Number {
     return v ? 1 : 0
 }
-
-const cutOffPrefix = "key.results:";
-function cutOffResponse(s: string): string {
-    s = s.substring(s.indexOf(cutOffPrefix) + cutOffPrefix.length, s.length)
-    s = s.substring(0, s.lastIndexOf("key.kind:"))
-    s = s.substring(0, s.lastIndexOf(",")) + "]"
-    return jsonify(s);
-}
-
-function jsonify(s: string): string {
-    return s
-        .replace(/(key\.[a-z_.]+):/g, '"$1":')
-        .replace(/(source\.[a-z_.]+),/g, '"$1",')
-}

yarn.lock

@@ -8,6 +8,10 @@
   dependencies:
     "@types/node" "*"
 
+"@types/js-yaml@^3.11.1":
+  version "3.11.1"
+  resolved "https://registry.yarnpkg.com/@types/js-yaml/-/js-yaml-3.11.1.tgz#ac5bab26be5f9c6f74b6b23420f2cfa5a7a6ba40"
+
 "@types/node@*", "@types/node@latest":
   version "8.0.51"
   resolved "https://registry.yarnpkg.com/@types/node/-/node-8.0.51.tgz#b31d716fb8d58eeb95c068a039b9b6292817d5fb"
@@ -928,9 +932,9 @@ [email protected]:
     commander "0.6.1"
     mkdirp "0.3.0"
 
-js-yaml@^3.7.0:
-  version "3.10.0"
-  resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.10.0.tgz#2e78441646bd4682e963f22b6e92823c309c62dc"
+js-yaml@^3.11.0:
+  version "3.11.0"
+  resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.11.0.tgz#597c1a8bd57152f26d622ce4117851a51f5ebaef"
   dependencies:
     argparse "^1.0.7"
     esprima "^4.0.0"