npmpackage.info

json-parse-ast

JSON AST parser written in JavaScript. For usage in conjunction with the monaco editor to enhance JSON autocomplete experience.

1.0.8

JavaScript

1.58 kB

16,533 1.3

Installations

npm install json-parse-ast

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

14.15.4

NPM Version

7.5.4 Score

73.3

Supply Chain

84.7

Quality

75.6

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View All 1 Contributors

Languages

JavaScript

JavaScript (100%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

JohannesOehm

Download Statistics

Total Downloads

16,533

Last Day

Last Week

Last Month

278

Last Year

4,090

GitHub Statistics

4 Stars

13 Commits

1 Watchers

1 Branches

1 Contributors

Updated on Jun 04, 2024

Bundle Size

5.56 kB

Minified

1.58 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.0.8

Package Id

json-parse-ast@1.0.8

Unpacked Size

30.35 kB

Size

6.32 kB

File Count

NPM Version

7.5.4

Node Version

14.15.4

Total Downloads

Cumulative downloads

Total Downloads

16,533

Last Day

-31.6%

Compared to previous day

Last Week

-28.2%

Compared to previous week

Last Month

-8.3%

278

Compared to previous month

Last Year

-22.9%

4,090

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

jest

json-parse-ast

JSON Tokenizer & AST (Abstract Syntax Tree) parser

Background

I wrote my custom parser since monaco's built-in JSON library does not expose any syntax tree which can be used to check position in file and enhance autocomplete experience.

Usage

Currently, only tokenizer is stable:

1var tokens = tokenize('{"json": "string"}'); //returns list of tokens
2//tokens have the following attributes
3// type: "inlinecomment"|"multilinecomment"|"whitespace"|"string"|"literal"|"number"|"punctuaction" 
4// position: IRange compatible with monaco's IRange-interface
5// raw: string 
6// value: string Unescaped JSON string, parsed number, parsed literal (null, true, false)

Tokenizer additional features

1var [path, willBeValue] = getPathInObject(tokenize('{"foo": {"bar": "'));
2//returns path == ["foo", "bar"] and willBeValue == true

Parser

1var ast = parseTokens(tokenize(testString));
2//AST elements have
3// type 
4// position: IRange
5// raw: string
6// value?: string
7// parent?: AST 
8// children?: AST[]
9
10//Find node at specified position
11var node = findAtPosition(ast, {lineNumber: 4, column: 16})

Usage with monaco

This libraries intended use is for enhancing experience with custom JSON formats. See example use-cases below:

Enhancing autocomplete/IntelliSense

1monaco.languages.registerCompletionItemProvider('json', {
2    provideCompletionItems: function(model, position) {
3        let textUntilPosition = model.getValueInRange({startLineNumber: 1, startColumn: 1, endLineNumber: position.lineNumber, endColumn: position.column});
4        let [jsonPath, willBeValue] = getPathInObject(tokenize(textUntilPosition));
5        if (willBeValue && jsonPath[jsonPath.length-1] === "dependencies") {
6             return { suggestions: listDependencies() };
7        } else {
8             return { suggestions: [] };
9        }
10    }
11});

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.3

/10

Last Scanned on 2025-02-10

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to json-parse-ast

json-parser

3.1.2

JSON parser to parse the AST of JSON object even with comments.

@lottiefiles/relottie-parse

1.11.0

Parse Lottie JSON format to LAST

json-asty

1.2.2

Lossless JSON-to-AST Parser and AST-to-JSON Generator

json5-writer

0.2.0

Comment-preserving JSON / JSON5 parser