parseTree - Option to keep comments

[dsherret]

Thanks for this library! I wrote a jsonc code formatter using it.

Right now I'm using the scanner to get the comments around the nodes in the tree. It would be slightly faster to not rescan these out and instead get all the comments when calling parseTree.

A simple solution would may be to have an option that returns all the comments in an array. Maybe something like...

export function parseTree(text: string, errors: ParseError[] = [], options: ParseOptions = ParseOptions.DEFAULT): Node;

Goes to:

export function parseTree(text: string, options: ParseOptions = ParseOptions.DEFAULT): ParseResult;

interface ParseResult {
	file: Node;
	errors: ParseError[];
	/** Included when `options.includeComments` is true. **/
	comments?: Comment[];
};

Then:

export interface ParseOptions {
	disallowComments?: boolean;
	allowTrailingComma?: boolean;
	allowEmptyContent?: boolean;
}

Goes to:

export interface ParseOptions {
	disallowComments?: boolean;
	includeComments?: boolean;
	allowTrailingComma?: boolean;
	allowEmptyContent?: boolean;
}

Thoughts? I could submit a PR for this, but will just need some direction on how the public API should look.

[aeschli]

Proposal looks fine with, if you want to make a PR.

[tjx666]

I want to make a vscode extension to sort the json fileds. I try this package, but can't find a good way to get the comment node info

[aeschli]

@tjx666 You can use the scanner. Also, the JSONVisitor has a onComment callback. It's still up to you to associate a comment with a node.
Note that we just recently added a JSON: Sort Document command to VS Code

[tjx666]

@aeschli I know that and had make a feature request: microsoft/vscode#175343

[felixhaeberle]

Hey, I also want to simply keep the comments in the parsed jsonc, modify a property and insert the content back while preserving the comments. Can somebody help?