Another fixes by suggestions from tslint (#24)

* tslint2 - squash it

* Rename BuiltinDoc to IBuiltinDoc

* Rename Pos to IPos

* Rename Node -> INode

* Sort key names

* Revert "Sort key names"

This reverts commit 120fd2f.

* object-literal-sort-keys excluded from tslint rules

Author: przepompownia

src/common/types.ts

@@ -33,7 +33,7 @@ export interface IConfig {
 }
 
 // builtin-doc
-export interface BuiltinDoc {
+export interface IBuiltinDoc {
   completionItems: {
     functions: CompletionItem[]
     commands: CompletionItem[]

src/common/util.ts

@@ -3,7 +3,7 @@ import findup from "findup";
 import path from "path";
 import { Readable } from "stream";
 import { CompletionItem, InsertTextFormat, Position, Range, TextDocument } from "vscode-languageserver";
-import { Node, StringReader, VimLParser } from "../lib/vimparser";
+import { INode, StringReader, VimLParser } from "../lib/vimparser";
 import { commentPattern, keywordPattern, kindPattern, wordNextPattern, wordPrePattern } from "./patterns";
 
 export function isSomeMatchPattern(patterns: kindPattern, line: string): boolean {
@@ -57,7 +57,7 @@ export function executeFile(
 
     // error will occur when cp get error
     if (!isPassAsText) {
-      input.pipe(cp.stdin).on("error", () => {});
+      input.pipe(cp.stdin).on("error", () => { return; });
     }
 
   });
@@ -150,19 +150,23 @@ export function getWordFromPosition(
 
   return {
     word,
-    wordLeft: wordLeft && wordLeft[1] ? preSegment.replace(new RegExp(`${wordLeft[1]}$`), word) : `${preSegment}${word}`,
-    wordRight: wordRight && wordRight[1] ? nextSegment.replace(new RegExp(`^${wordRight[1]}`), word) : `${word}${nextSegment}`,
     left: wordLeft && wordLeft[1] || "",
     right: wordRight && wordRight[1] || "",
+    wordLeft: wordLeft && wordLeft[1]
+      ? preSegment.replace(new RegExp(`${wordLeft[1]}$`), word)
+      : `${preSegment}${word}`,
+    wordRight: wordRight && wordRight[1]
+      ? nextSegment.replace(new RegExp(`^${wordRight[1]}`), word)
+      : `${word}${nextSegment}`,
   };
 }
 
 // parse vim buffer
-export async function handleParse(textDoc: TextDocument | string): Promise<[Node | null, string]> {
+export async function handleParse(textDoc: TextDocument | string): Promise<[INode | null, string]> {
   const text = textDoc instanceof Object ? textDoc.getText() : textDoc;
   const tokens = new StringReader(text);
   try {
-    const node: Node = new VimLParser(true).parse(tokens);
+    const node: INode = new VimLParser(true).parse(tokens);
     return [node, ""];
   } catch (error) {
     return [null, error];

src/lib/vimparser.d.ts

@@ -1,34 +1,34 @@
-export declare interface Pos {
+export declare interface IPos {
   lnum: number;
   col: number;
   offset: number;
 }
 
-export declare interface Node {
+export declare interface INode {
   type: number;
-  pos: Pos;
-  body: Node[];
+  pos: IPos;
+  body: INode[];
   ea: {
-    linepos: Pos
-    cmdpos: Pos
-    argpos: Pos
+    linepos: IPos
+    cmdpos: IPos
+    argpos: IPos
     cmd: {
       name: string,
     },
   };
-  cond?: Node;
-  elseif?: Node[];
-  _else?: Node;
+  cond?: INode;
+  elseif?: INode[];
+  _else?: INode;
   op?: string;
-  catch?: Node[];
-  _finally?: Node;
-  left: Node;
-  right: Node;
-  rlist: Node[];
+  catch?: INode[];
+  _finally?: INode;
+  left: INode;
+  right: INode;
+  rlist: INode[];
   str: string;
   value?: any;
-  endfunction?: Node;
-  list?: Node[];
+  endfunction?: INode;
+  list?: INode[];
 }
 
 export declare class StringReader {
@@ -39,5 +39,5 @@ export declare class StringReader {
 
 export declare class VimLParser {
   constructor(isNeovim: boolean)
-  public parse(stringReader: StringReader): Node;
+  public parse(stringReader: StringReader): INode;
 }

src/server/buffer.ts

@@ -1,7 +1,7 @@
 import { CompletionItem, CompletionItemKind, InsertTextFormat } from "vscode-languageserver";
 import { sortTexts } from "../common/constant";
 import logger from "../common/logger";
-import { Node, Pos } from "../lib/vimparser";
+import { INode, IPos } from "../lib/vimparser";
 
 const log = logger("buffer");
 
@@ -103,7 +103,7 @@ const NODE_CONST = 94;
  */
 export interface IFunction {
   name: string;
-  args: Node[];
+  args: INode[];
   startLine: number;
   startCol: number;
   endLine: number;
@@ -112,7 +112,7 @@ export interface IFunction {
 
 export interface IFunRef {
   name: string;
-  args: Node[];
+  args: INode[];
   startLine: number;
   startCol: number;
 }
@@ -147,7 +147,7 @@ export class Buffer {
   constructor(
     private uri: string,
     private projectRoot: string,
-    private node: Node,
+    private node: INode,
   ) {
     this.updateBufferByNode(this.node);
   }
@@ -192,7 +192,7 @@ export class Buffer {
     return this.projectRoot === workUri;
   }
 
-  public updateBufferByNode(node: Node) {
+  public updateBufferByNode(node: INode) {
     this.node = node;
     this.resetProperties();
     try {
@@ -394,8 +394,8 @@ export class Buffer {
     this.envRefs = {};
   }
 
-  private resolveCompletionItems(nodes: Node | Node[]) {
-    let nodeList: Node[] = [].concat(nodes);
+  private resolveCompletionItems(nodes: INode | INode[]) {
+    let nodeList: INode[] = [].concat(nodes);
     while (nodeList.length > 0) {
       const node = nodeList.pop();
       switch (node.type) {
@@ -509,7 +509,7 @@ export class Buffer {
           break;
         case NODE_DICT:
           nodeList = nodeList.concat(
-            (node.value || []).map((item: [Node, Node]) => item[1]),
+            (node.value || []).map((item: [INode, INode]) => item[1]),
           );
           break;
         case NODE_SLICE:
@@ -547,7 +547,7 @@ export class Buffer {
     // log.info(`parse_buffer: ${JSON.stringify(this)}`)
   }
 
-  private takeFunction(node: Node) {
+  private takeFunction(node: INode) {
     const { left, rlist, endfunction } = node;
     const name = this.getDotName(left);
     if (!name) {
@@ -584,7 +584,7 @@ export class Buffer {
    * - let funcName = function()
    * - let funcName = funcref()
    */
-  private takeFunctionByRef(node: Node): boolean {
+  private takeFunctionByRef(node: INode): boolean {
     const { left, right } = node;
     if (!right || right.type !== NODE_CALL) {
       return;
@@ -629,14 +629,14 @@ export class Buffer {
     return false;
   }
 
-  private takeFuncRef(node: Node) {
+  private takeFuncRef(node: INode) {
     const { left, rlist } = node;
     let name = "";
     if (left.type === NODE_IDENTIFIER) {
       name = left.value;
     // <SID>funName
     } else if (left.type === NODE_CURLYNAME) {
-      name = ((left.value || []) as Node[]).map((item) => item.value).join("");
+      name = ((left.value || []) as INode[]).map((item) => item.value).join("");
     } else if (left.type === NODE_DOT) {
       name = this.getDotName(left);
     }
@@ -675,7 +675,7 @@ export class Buffer {
    * - function('funcName')
    * - funcref('funcName')
    */
-  private takeFuncRefByRef(node: Node) {
+  private takeFuncRefByRef(node: INode) {
     const { left, rlist } = node;
     const funcNode = rlist && rlist[0];
     if (
@@ -717,7 +717,7 @@ export class Buffer {
    * - command
    * - map
    */
-  private takeFuncRefByExcmd(node: Node) {
+  private takeFuncRefByExcmd(node: INode) {
     const { pos, str } = node;
     if (!str) {
       return;
@@ -756,7 +756,7 @@ export class Buffer {
     }
   }
 
-  private takeLet(node: Node) {
+  private takeLet(node: INode) {
     const pos = this.getDotPos(node.left);
     const name = this.getDotName(node.left);
     if (!pos || !name) {
@@ -785,7 +785,7 @@ export class Buffer {
     }
   }
 
-  private takeFor(nodes: Node[]) {
+  private takeFor(nodes: INode[]) {
     nodes.forEach((node) => {
       if (node.type !== NODE_IDENTIFIER || !node.pos) {
         return;
@@ -815,7 +815,7 @@ export class Buffer {
     });
   }
 
-  private takeIdentifier(node: Node) {
+  private takeIdentifier(node: INode) {
     const name = this.getDotName(node);
     if (!name) {
       return;
@@ -847,7 +847,7 @@ export class Buffer {
     }
   }
 
-  private getDotPos(node: Node): Pos | null {
+  private getDotPos(node: INode): IPos | null {
     if (!node) {
       return null;
     }
@@ -862,7 +862,7 @@ export class Buffer {
     return this.getDotPos(left);
   }
 
-  private getDotName(node: Node) {
+  private getDotName(node: INode) {
     if (
       node.type === NODE_IDENTIFIER ||
       node.type === NODE_STRING ||
@@ -871,7 +871,7 @@ export class Buffer {
     ) {
       return node.value;
     } else if (node.type === NODE_CURLYNAME) {
-      return ((node.value || []) as Node[]).map((item) => item.value).join("");
+      return ((node.value || []) as INode[]).map((item) => item.value).join("");
     } else if (node.type === NODE_SUBSCRIPT) {
       return this.getDotName(node.left);
     }

src/server/builtin.ts

@@ -31,7 +31,7 @@ import {
   featurePattern,
   optionPattern,
 } from "../common/patterns";
-import { BuiltinDoc } from "../common/types";
+import { IBuiltinDoc } from "../common/types";
 import { isSomeMatchPattern, pcb } from "../common/util";
 import buildDocs from "../docs/builtin-docs.json";
 import config from "./config";
@@ -250,7 +250,7 @@ class Builtin {
     this.resolveHighlightArgValues();
 
     try {
-      const data: BuiltinDoc = buildDocs as BuiltinDoc;
+      const data: IBuiltinDoc = buildDocs as IBuiltinDoc;
       this.vimBuiltinFunctionItems = data.completionItems.functions;
       this.vimBuiltinFunctionItems.forEach((item) => {
         if (!this.vimBuiltinFunctionMap[item.label]) {

src/server/workspaces.ts

@@ -2,7 +2,7 @@ import URIParser from "vscode-uri";
 
 import { CompletionItem, Location, Position, Range } from "vscode-languageserver";
 import { findProjectRoot } from "../common/util";
-import { Node } from "../lib/vimparser";
+import { INode } from "../lib/vimparser";
 import { Buffer, IFunction, IIdentifier } from "./buffer";
 import config from "./config";
 // import logger from '../common/logger';
@@ -19,7 +19,7 @@ export class Workspace {
     return false;
   }
 
-  public async updateBuffer(uri: string, node: Node) {
+  public async updateBuffer(uri: string, node: INode) {
     if (!node) {
       return;
     }

tslint.json

@@ -4,6 +4,8 @@
         "tslint:recommended"
     ],
     "jsRules": {},
-    "rules": {},
+    "rules": {
+      "object-literal-sort-keys": false
+    },
     "rulesDirectory": []
 }