microsoft / microsoft/TypeScript

SourceFile text does not include BOM

Open
#63,850 5 comments 0 reactions 1 assignee View on GitHub

@andrewbranch is already working on this.

Since Jul 7, 2026.

Needs Investigation
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

## Steps to reproduce

The `sourceFile.{text,getFullText(),getText()}` properties return a string that does not include the BOM from the original file, however the node positions are relative to the string with the BOM. This means the node positions and their text do not align.

```ts
import * as ts from "@typescript/native-preview/unstable/ast";
import { createVirtualFileSystem } from "@typescript/native-preview/unstable/fs";
import { API } from "@typescript/native-preview/unstable/sync";

const UTF8_BOM = "\uFEFF";
const INPUT = `${UTF8_BOM}let answer:number=42;`;

const fs = createVirtualFileSystem({
"/tsconfig.json": JSON.stringify({ files: ["/input.ts"] }),
"/input.ts": INPUT,
});
const api = new API({
cwd: "/",
fs,
});
const snap = api.updateSnapshot({ openProject: "/tsconfig.json" });
const ast = snap.getProject("/tsconfig.json")!.program.getSourceFile("/input.ts")!;

walk(ast);

function walk(node: ts.Node) {
const start = node.getFullStart();
const end = node.getEnd();
const src = node.getSourceFile().getText();
console.log({ start, end, text: src.slice(start, end), text2: node.getFullText() });
node.forEachChild(walk);
}
```

## Behavior with `typescript@6.0`

```ts
import * as ts from "typescript";

const UTF8_BOM = "\uFEFF";
const INPUT = `${UTF8_BOM}let answer:number=42;`;

const ast = ts.createSourceFile("input.ts", INPUT, ts.ScriptTarget.ESNext, /* setParentNodes */true);

walk(ast);

function walk(node: ts.Node) {
const start = node.getFullStart();
const end = node.getEnd();
const fullText = node.getSourceFile().getFullText();
console.log({ start, end, text: fullText.slice(start, end), text2: node.getFullText() });
node.forEachChild(walk);
}
```

Prints:

```
...
{ start: 4, end: 11, text: ' answer', text2: ' answer' }
{ start: 12, end: 18, text: 'number', text2: 'number' }
{ start: 19, end: 21, text: '42', text2: '42' }
{ start: 22, end: 22, text: '', text2: '' }
```

## Behavior with `tsgo`

```
...
{ start: 4, end: 11, text: 'answer:', text2: 'answer:' }
{ start: 12, end: 18, text: 'umber=', text2: 'umber=' }
{ start: 19, end: 21, text: '2;', text2: '2;' }
{ start: 22, end: 22, text: '', text2: '' }
```

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.