microsoft / microsoft/node-jsonc-parser
insertSpaces formatting option doesn't always work
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 759
- Forks
- 66
- Avg merge
- 5d 10h
- Merged PRs (30d)
- 7
Description
Steps to reproduce. Run the following program using ts-node or similar.
import { format, applyEdits } from 'jsonc-parser';
const JSONString = `{"hello": \t"\tworld"}`;
const edit = format(JSONString, undefined, { insertSpaces: true});
const res = applyEdits(JSONString, edit);
console.log(res);
We would expect the following output
{
"hello": " world"
}
But we actually get
{
"hello": " world"
}
Interestingly, if we remove the tab inside the quotes, the tab outside is removed as expected. This seems like an error since formatting should only care about tabs outside quotes.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by running the provided ts-node reproduction and tracing the format and applyEdits entry points. Add a regression test covering a tab inside a quoted value alongside an indentation tab, and verify that formatting removes only the tab outside the quotes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100