refactor: align position apis with language server spec

Author: DylanPiercey

src/__tests__/main.test.ts

@@ -19,7 +19,7 @@ for (const entry of fs.readdirSync(FIXTURES)) {
     }[][] = Array.from({ length: lines.length }, () => []);
     const addRange = (label: string, range: Range) => {
       const pos = parser.positionAt(range.start);
-      partsByLine[pos.line - 1].push({
+      partsByLine[pos.line].push({
         label,
         range,
         pos,
@@ -152,7 +152,7 @@ for (const entry of fs.readdirSync(FIXTURES)) {
       if (len) {
         const padding = " ".repeat(linePrefix.length - 3);
         parts.sort((a, b) => {
-          const delta = (a.pos.column || 1) - (b.pos.column || 1);
+          const delta = (a.pos.character || 1) - (b.pos.character || 1);
           return delta === 0 ? b.range.start - a.range.start : delta;
         });
 
@@ -161,7 +161,7 @@ for (const entry of fs.readdirSync(FIXTURES)) {
 
         for (let i = 0; i < len; i++) {
           const part = parts[i];
-          const col = part.pos.column || 1;
+          const col = part.pos.character || 1;
           const delta = col - lastCol;
 
           if (delta > 0) {
@@ -185,13 +185,15 @@ for (const entry of fs.readdirSync(FIXTURES)) {
             }
           }
 
-          if (prevPart && (prevPart.pos.column || 1) === (pos.column || 1)) {
+          const column = pos.character || 1;
+
+          if (prevPart && (prevPart.pos.character || 1) === column) {
             label = `├${label}`;
           } else {
             label = `╰${label}`;
           }
 
-          label = `${columns.slice(0, (pos.column || 1) - 1)}${label}`;
+          label = `${columns.slice(0, column - 1)}${label}`;
           result += `\n${padding + (prevPart ? `│  ${label}` : `╰─ ${label}`)}`;
         }
       }

src/util/constants.ts

@@ -43,18 +43,32 @@ export const enum BODY_MODE {
   PARSED_TEXT, // Body of a tag is treated as text, but placeholders will be parsed
 }
 
+// Same format as https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#position
 export interface Position {
+  /**
+   * Line position in a document (zero-based).
+   */
   line: number;
-  column: number;
+  /**
+   * Character offset on a line in a document (zero-based).
+   */
+  character: number;
 }
 
+// Same format as https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#range
 export interface Location {
   start: Position;
   end: Position;
 }
 
 export interface Range {
+  /**
+   * The start characters offset from the beginning of the document (zero-based).
+   */
   start: number;
+  /**
+   * The end characters offset from the beginning of the document (zero-based).
+   */
   end: number;
 }
 

src/util/util.ts

@@ -12,9 +12,7 @@ export function isWhitespaceCode(code: number) {
 export function getLoc(lines: number[], range: Range): Location {
   const start = getPos(lines, 0, range.start);
   const end =
-    range.start === range.end
-      ? start
-      : getPos(lines, start.line - 1, range.end);
+    range.start === range.end ? start : getPos(lines, start.line, range.end);
   return { start, end };
 }
 
@@ -37,8 +35,8 @@ export function getPos(
   }
 
   return {
-    line: line + 1,
-    column: index - lines[line],
+    line,
+    character: index - lines[line],
   };
 }