feat: #355 - Add getLengthFromLineStartAtPos to replace `getColumnA…

…tPos` in next major.

src/compiler/common/Node.ts

@@ -950,13 +950,15 @@ export class Node<NodeType extends ts.Node = ts.Node> {
     /**
      * Gets the length from the start of the line to the start of the node.
      * @param includeJsDocComment - Whether to include the JS doc comment or not.
+     * @deprecated - Use `sourceFile.getLengthFromLineStartAtPos(node.getStart())`
      */
     getStartColumn(includeJsDocComment?: boolean) {
         return this.sourceFile.getColumnAtPos(this.getStart(includeJsDocComment));
     }
 
     /**
      * Gets the length from the start of the line to the end of the node.
+     * @deprecated - Use `sourceFile.getLengthFromLineStartAtPos(node.getEnd())`
      */
     getEndColumn() {
         return this.sourceFile.getColumnAtPos(this.getEnd());

src/compiler/file/SourceFile.ts

@@ -163,9 +163,18 @@ export class SourceFile extends SourceFileBase<ts.SourceFile> {
     /**
      * Gets the length from the start of the line to the provided position.
      * @param pos - Position.
+     * @deprecated - Use `getLengthFromLineStartAtPos`
      */
     getColumnAtPos(pos: number) {
-        return StringUtils.getColumnAtPos(this.getFullText(), pos);
+        return this.getLengthFromLineStartAtPos(pos);
+    }
+
+    /**
+     * Gets the character count from the start of the line to the provided position.
+     * @param pos - Position.
+     */
+    getLengthFromLineStartAtPos(pos: number) {
+        return StringUtils.getLengthFromLineStartAtPos(this.getFullText(), pos);
     }
 
     /**

src/next-major-deprecations.md

@@ -2,3 +2,6 @@
 
 * CompilerApiNodeBrandPropertyNamesType
 * getLineNumberFromPos
+* getStartColumn
+* getEndColumn
+* getColumnAtPos

src/tests/utils/stringUtilsTests.ts

@@ -44,21 +44,21 @@ describe(nameof(StringUtils), () => {
         });
     });
 
-    describe(nameof(StringUtils.getColumnAtPos), () => {
+    describe(nameof(StringUtils.getLengthFromLineStartAtPos), () => {
         it("should throw if providing a negative pos", () => {
-            expect(() => StringUtils.getColumnAtPos("", -1)).to.throw(errors.ArgumentOutOfRangeError);
+            expect(() => StringUtils.getLengthFromLineStartAtPos("", -1)).to.throw(errors.ArgumentOutOfRangeError);
         });
 
         it("should not throw if providing a pos the length of the string", () => {
-            expect(() => StringUtils.getColumnAtPos("", 1)).to.not.throw();
+            expect(() => StringUtils.getLengthFromLineStartAtPos("", 1)).to.not.throw();
         });
 
         it("should throw if providing a pos greater than the length + 1", () => {
-            expect(() => StringUtils.getColumnAtPos("", 2)).to.throw(errors.ArgumentOutOfRangeError);
+            expect(() => StringUtils.getLengthFromLineStartAtPos("", 2)).to.throw(errors.ArgumentOutOfRangeError);
         });
 
         function doTest(text: string, pos: number, expected: number) {
-            expect(StringUtils.getColumnAtPos(text, pos)).to.equal(expected);
+            expect(StringUtils.getLengthFromLineStartAtPos(text, pos)).to.equal(expected);
         }
 
         function doNewlineTest(newLineKind: string) {

src/utils/StringUtils.ts

@@ -41,7 +41,7 @@ export class StringUtils {
         return count + 1; // convert count to line number
     }
 
-    static getColumnAtPos(str: string, pos: number) {
+    static getLengthFromLineStartAtPos(str: string, pos: number) {
         errors.throwIfOutOfRange(pos, [0, str.length + 1], nameof(pos));
         const startPos = pos;