@stoplight/yaml-ast-parser

v0.0.50

[![Build Status](https://travis-ci.org/mulesoft-labs/yaml-ast-parser.svg?branch=master)](https://travis-ci.org/mulesoft-labs/yaml-ast-parser) For more information about how to use this package see README

Latest version published 8 months ago

License: Apache-2.0

NPM

GitHub

Package Health Score

66 / 100

security
No known security issues
popularity
Popular
maintenance
Sustainable
community
Limited

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.0.50	\|	03/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Popular

Weekly Downloads (913,564)

GitHub Stars: 3
Forks: 3
Contributors: 9

Direct Usage Popularity

The npm package @stoplight/yaml-ast-parser receives a total of 913,564 downloads a week. As such, we scored @stoplight/yaml-ast-parser popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package @stoplight/yaml-ast-parser, we found that it has been starred 3 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 9
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like @stoplight/yaml-ast-parser is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

No Recent Commits

Open Issues: 0
Open PR: 4
Last Release: 8 months ago
Last Commit: 5 years ago

Further analysis of the maintenance status of @stoplight/yaml-ast-parser based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that @stoplight/yaml-ast-parser demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 5 years
Dependencies: 0 Direct
Versions: 9
Install Size: 447 kB
Dist-tags: 1
# of Files: 162
Maintainers: 1
TS Typings: Yes

@stoplight/yaml-ast-parser has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

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.

@stoplight/yaml-ast-parser development dependencies

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

FAQs

What is @stoplight/yaml-ast-parser?

[![Build Status](https://travis-ci.org/mulesoft-labs/yaml-ast-parser.svg?branch=master)](https://travis-ci.org/mulesoft... Visit Snyk Advisor to see a full health score report for @stoplight/yaml-ast-parser, including popularity, security, maintenance & community analysis.

Is @stoplight/yaml-ast-parser popular?

The npm package @stoplight/yaml-ast-parser receives a total of 913,564 weekly downloads. As such, @stoplight/yaml-ast-parser popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @stoplight/yaml-ast-parser well maintained?

We found indications that @stoplight/yaml-ast-parser maintenance is sustainable demonstrating some project activity. We saw a total of 9 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @stoplight/yaml-ast-parser safe to use?

The npm package @stoplight/yaml-ast-parser was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 3 November-2024, at 05:03 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP