Installations

npm install @stoplight/yaml-ast-parser

Score

99.8

Supply Chain

83.8

Quality

76.5

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

4

Total

8

Closed

0

Merged

4

Issues

Open

0

Total

0

Closed

0

Releases

1

0.0.45

Published on 20 Mar 2020

View all 1 releases

Developer

stoplightio

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

10.24.1

NPM Version

6.14.12 Statistics

3 Stars

128 Commits

3 Forks

2 Watching

10 Branches

55 Contributors

Updated on 09 Sept 2024

Bundle Size

44.09 kB

Minified

14.19 kB

Minified + Gzipped

Bundlephobia

Languages

TypeScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

65,755,191

Last day

-8.1%

179,054

Compared to previous day

Last week

1.8%

1,010,360

Compared to previous week

Last month

11.4%

4,160,220

Compared to previous month

Last year

101.6%

34,978,854

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

8

@types/chai @types/mocha @types/node chai dev-env-installer mocha rimraf typescript

Versions

yaml-ast-parser

This is a fork of JS-YAML which supports parsing of YAML into AST.

In additional to parsing YAML to AST, it has following features:

restoration after the errors and reporting errors as a part of AST nodes.
built-in support for !include tag used in RAML

Usage

The type information below is relevant when using TypeScript, if using from JavaScript only the field/method information is relevant.

load method can be used to load the tree and returns a YAMLNode.

YAMLNode

YAMLNode class is an ancestor for all node kinds. It's kind field determine node kind, one of Kind enum:

SCALAR, MAPPING, MAP, SEQ, ANCHOR_REF or INCLUDE_REF.

After node kind is determined, it can be cast to one of the YAMLNode descendants types:

YAMLScalar, YAMLMapping, YamlMap, YAMLSequence or YAMLAnchorReference.

class	important members
`YAMLNode`	`startPosition` and `endPosition` provide node range.
`YAMLScalar`	`string` `value` field
`YAMLMapping`	`YAMLScalar` `key` and `YAMLNode` `value` fields
`YAMLSequence`	`YAMLNode[]` `items` field
`YamlMap`	`YAMLMapping[]` `mappings` field
`YAMLAnchorReference`	`string` `referencesAnchor` and `YAMLNode` `value`

YAMLScalar

Scalars are one of the three main node types defined by YAML and are effectively leaf nodes.

There are many factors that can influence the type of datum represent in scalar node (context, schema, tag, etc.).

To help inspection of a YAMLScalar to determine its datatype when a document uses the Core Schema, you can pass the YAMLScalar to the determineScalarType function. It will return an enum value indicating null, bool, int, float, or string.

Once you know the type, there are also some helper functions to help read the value by passing them the string, value: parseYamlBoolean, parseYamlFloat, and parseYamlInteger.

No vulnerabilities found.

10

Binary-Artifacts

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

10

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

9

License

Determines if the project has defined a license.

1

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

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

0

CII-Best-Practices

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

0

SAST

Determines if the project uses static code analysis.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

Score

2.8

/10

Last Scanned on 2023-07-24

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