yaml front matter for JS. Parse yaml or JSON from the beginning of files. 

dworthen

yaml-front-matter

Error

Ignore

Warn

License

Maintenance

Miscellaneous

Quality

Supply chain risk

Vulnerability

Admins only

Organization members

Dashboard

<upgradeLink>Upgrade</upgradeLink> to access this feature

About

Blog

Socket CLI

Customers

Socket Dependency Search

Docs

Socket for GitHub

Love

Impersonation Mode Active

Update your browser to the latest version for the best experience.

Your web browser is outdated

Use another browser for the best experience.

Your web browser is unsupported

{{count, number}} commits last two months

{{count, number}} critical severity alert

{{count, number}} critical severity alerts

{{count, number}} dependency vulnerability

{{count, number}} dependency vulnerabilities

{{count, number}} development dependencies

{{count, number}} transitive dependencies

{{count, number}} version published last month

{{count, number}} versions published last month

{{count, number}} version published in last two months

{{count, number}} versions published in last two months

{{count, number}} version published last week

{{count, number}} versions published last week

{{count, number}} version published last year

{{count, number}} versions published last year

Socket undergoes annual SOC2 Type II audits. Socket customers can request a copy of the full SOC2 Type II report.

Allows organization owners and admins to access detailed records of actions taken by members of their organization, complete with timestamps.

Prevent compromised packages from infiltrating your supply chain by monitoring for changes in real-time.

Join our Discord community to get help from Socket engineers and other Socket users.

Compare millions of open source packages on socket.dev

Detect malicious code and risky behavior (e.g. network) in your dependencies using "deep package inspection"

All data is encrypted in transit and at rest using industry standard encryption algorithms.

Get a dedicated Socket account manager and access to Socket’s Customer Success team.

Get dedicated support from Socket engineers via email and Slack.

"Shift left" with the Socket Chrome extension and give intervene early, before developers choose risky or low quality dependencies.

Catch developers using risky dependencies and give them a "speed bump" to encourage good behavior

Install the Socket GitHub app to receive real-time dependency scanning and reports with every pull request.

Integrate Socket into your GitHub SCM to prevent risky dependencies from being installed.

Socket scans for vulnerabilities in your dependencies, including CVEs, security advisories, and more.

Socket supports dependencies in many languages, with most popular ecosystems coming in 2024. We've got you covered no matter what languages you use.

Enforce license policies across your organization

Receive a Microsoft Teams message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Get help migrating from Socket's free plan to Socket's paid plans.

Run Socket on-premises or in your own cloud environment.

Query for any dependency (at any version) across your entire organization

Integrate Socket into your CI/CD pipeline to prevent risky dependencies from being deployed to production.

Analyze an entire project to find supply chain risks

Tag projects to organize and filter your projects

Restrict access based on the roles of individual users within an organization.

Receive a Slack message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket is SOC2 Type II compliant and undergoes annual audits.

The Socket CLI allows teams to prevent risky dependencies from being installed, and to get dependency insights from the command line.

Socket supports SAML SSO for single sign-on and identity management.

Integrate Socket into your VS Code IDE to prevent risky dependencies from being installed.

Get a POST request anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket will analyzed your SBOMs up to a maximum number of dependencies.

API that allows you to analyze a project, lookup package scores and alerts, and more.

Create API tokens to authenticate with the Socket API and CLI.

The number of developers in your team. A developer is someone who made a commit to your organization's repositories scanned by Socket in the past month.

Use Socket to protect your private repositories.

Socket is always free for open source projects.

Socket retains all reporting data for 3 months, 1 year, or a custom term of your choice.

Access the threat feed that powers Socket.

Unlimited scale, self-hosting, and priority support for large teams.

For open-source projects, individuals, and small teams.

For growing teams with enhanced scale, security, and support.

There is a package with a similar name that is downloaded much more often.

There are packages with similar names that are downloaded much more often.

This may not be the package you want!

Instance

Alert Locations

Package

The {{ecosystem}} package {{- packageName}} receives a total of <strong>{{numWeeklyDownloadCount, number}}</strong> weekly downloads. As such, {{- packageName}} popularity was classified as <strong>{{popularity}}</strong>.

Is {{- packageName}} popular?

Is {{- packageName}} safe to use?

Is {{- packageName}} well maintained?

What is {{- packageName}}?

{{packageDescription}}Version: {{versionString}} was published by {{publisherName}}. Start using Socket to analyze {{- packageName}} and its {{dependencyCount, number}} dependencies to secure your app from supply chain attacks.

Sorry, it seems this package was removed from the registry

Package was removed

This package version has been unpublished, mostly likely due to security reasons

Package version was removed

Provide a detailed description of the malware...

Socket fights vulnerabilities and provides visibility, defense-in-depth, and proactive supply chain protection for JavaScript, Python, and Go dependencies.

Socket - Secure your dependencies. Ship with confidence.

Compare versions

{{- packageName}} - npm Package Compare versions

    , package = require('../package.json');

    .version(package.version, '-v, --version')

    .option('-c, --content [name]', 'set the property name for the files contents [__content]')

    .option('--pretty', 'prints the json output with spaces.')

        console.log('       yaml-front-matter <yaml-front-matter>');

        console.log('     Piping content from an input file to an output file')

        console.log('       cat ./some/file.txt | yaml-front-matter > output.txt');

    process.stdin.on('readable', function () {

        while (chunk = process.stdin.read()) {

    process.stdin.on('end', function () {

        // There will be a trailing \n from the user hitting enter. Get rid of it.

        // data = data.replace("\r\n", '\n');

    console.log(JSON.stringify(yamlFront.safeLoadFront(data,

        { contentKeyName: program.content || '__content' }), 

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

### [4.1.1](https://github.com/dworthen/js-yaml-front-matter/compare/v4.1.0...v4.1.1) (2020-12-13)

* update dependencies ([70fba4a](https://github.com/dworthen/js-yaml-front-matter/commit/70fba4af22c95eacaf5370a5b198602c452e3d68))

## [4.1.0](https://github.com/dworthen/js-yaml-front-matter/compare/v4.0.0...v4.1.0) (2019-12-24)

* Upgrade package dependencies ([39a68d2](https://github.com/dworthen/js-yaml-front-matter/commit/39a68d2c10de16b411cccb90865856c8cacbe265))

### [3.4.1](https://github.com/dworthen/js-yaml-front-matter/compare/v4.0.0-2...v3.4.1) (2018-02-27)

# [4.0.0](https://github.com/dworthen/js-yaml-front-matter/compare/v4.0.0-4...v4.0.0) (2018-03-08)

# [4.0.0-4](https://github.com/dworthen/js-yaml-front-matter/compare/v4.0.0-3...v4.0.0-4) (2018-02-28)

* Update API to be backward compatible with 3.x ([4a9aa0e](https://github.com/dworthen/js-yaml-front-matter/commit/4a9aa0e))

# [4.0.0-3](https://github.com/dworthen/js-yaml-front-matter/compare/v4.0.0-2...v4.0.0-3) (2018-02-27)

* list umd module as main entry point ([a63d69a](https://github.com/dworthen/js-yaml-front-matter/commit/a63d69a))

# [4.0.0-2](https://github.com/dworthen/js-yaml-front-matter/compare/v4.0.0-1...v4.0.0-2) (2018-02-27)

* Add --pretty flag to print formatted json ([f119924](https://github.com/dworthen/js-yaml-front-matter/commit/f119924))

# [4.0.0-1](https://github.com/dworthen/js-yaml-front-matter/compare/v4.0.0-0...v4.0.0-1) (2018-02-27)

* **cli:** Update cli to support latest version ([1f0bd9e](https://github.com/dworthen/js-yaml-front-matter/commit/1f0bd9e))

# [4.0.0-0](https://github.com/dworthen/js-yaml-front-matter/compare/v3.4.0...v4.0.0-0) (2018-02-27)

* Rewrite using es2015 ([2c24190](https://github.com/dworthen/js-yaml-front-matter/commit/2c24190))

- No longer modifies or exposes js-yaml. May need to

include js-yaml for yaml parsing needs outside of parsing

- No longer supports reading contents from the file system.

- Browser global is now exposed was yamlFront instead of jsYaml

- Browser script no longer comes bundled with underlying js-yaml.

Must now include js-yaml as a separate script.

- safeLoadFront to behave the same as safeLoad from js-yaml.

- loadFront and safeLoadFront now support all the same options

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

  "description": "yaml front matter for JS. Parse yaml or JSON from the beginning of files.",

    "url": "git+https://github.com/dworthen/js-yaml-front-matter"

    "yaml-front-matter": "bin/js-yaml-front.js"

    "test": "npm run build && mocha -u bdd --reporter spec",

    "start": "npm run build:browser && http-server ./docs -p 8080",

    "build": "webpack --mode production",

    "build:browser": "webpack --mode production --env.browser"

Parses yaml or json at the front of a string. Places the parsed content, plus the rest of the string content, into an object literal.

[Online Demo](https://dworthen.github.io/js-yaml-front-matter/).

This readme is for the 4.x release, which introduces breaking changes. View the [changelog](CHANGELOG.md) for more information.

[3.x readme](https://github.com/dworthen/js-yaml-front-matter/tree/v3.4.0)

var yamlFront = require('yaml-front-matter');

fs.readFile('./some/file.txt', 'utf8', function(fileContents) {

    console.log(yamlFront.loadFront(fileContents));

    contact: { email: 'email@domain.com', address: 'some location' },

> __NOTE:__ The `---` are required to denote the start and end of front matter. There must be a newline after the opening `---` and a newline preceding the closing `---`.

Use the `-g` flag if you plan on using the command line tool.

### Node or client with module bundler (webpack or browsify)

The [dist/yamlFront.js](dist/yamlFront.js) client script will expose the yaml-front-matter library as a global, `yamlFront`. The client script for [js-yaml](https://github.com/nodeca/js-yaml) is also required. May need to load espirma for some use cases. See [js-yaml](https://github.com/nodeca/js-yaml) for more information.

function parse(text, options, loadSafe) {

    let contentKeyName = options && typeof options === 'string'

        : options && options.contentKeyName 

    let passThroughOptions = options && typeof options === 'object'

    let re = /^(-{3}(?:\n|\r)([\w\W]+?)(?:\n|\r)-{3})?([\w\W]*)*/

        if (yamlOrJson.charAt(0) === '{') {

            conf = JSON.parse(yamlOrJson);

                conf = jsYaml.safeLoad(yamlOrJson, passThroughOptions);

                conf = jsYaml.load(yamlOrJson, passThroughOptions); 

    conf[contentKeyName] = results[3] || '';

export function loadFront (content, options) {

    return parse(content, options, false);

export function safeLoadFront (content, options) {

var jsYaml = require("../dist/yamlFront");

    path.resolve(__dirname, "./fixtures/yaml.txt"),

    path.resolve(__dirname, "./fixtures/yamlWithExtraDashes.txt"),

    path.resolve(__dirname, "./fixtures/safeYaml.txt"),

    path.resolve(__dirname, "./fixtures/json.txt"),

  //   var testJsonStr = '---\n{"post": "title one",\n"anArray": ["one","two"],\n"subObject":\n';

  //       testJsonStr += '{"obj1": "cool", "obj2": "two"}}\n---\ncontent\nmore';

    testStrWithExtraDashes = yamlWithDashes;

    results.should.have.property("post", "title one");

    results.should.have.property("anArray");

    results.anArray.should.containEql("one");

    results.anArray.should.containEql("two");

    results.should.have.property("subObject");

    results.subObject.should.have.property("obj1", "cool");

    results.subObject.should.have.property("obj2", "two");

    results.reg.should.be.an.instanceOf(RegExp);

    results[key].should.match(/content\r?\nmore/);

    results.subObject.should.have.property("obj2", "two ---");

		@@ -8,3 +8,3 @@ {
		"module": "src/index.js",
		"version": "4.1.0",
		"version": "4.1.1",
		"keywords": [
		@@ -20,15 +20,14 @@ "yaml",
		"dependencies": {
		"commander": "^2.14.1",
		"js-yaml": "^3.10.0"
		"commander": "^6.2.0",
		"js-yaml": "^3.14.1"
		},
		"devDependencies": {
		"@babel/core": "^7.7.7",
		"@babel/preset-env": "^7.7.7",
		"babel-loader": "^8.0.6",
		"http-server": "^0.11.1",
		"mocha": "^6.2.2",
		"@babel/core": "^7.12.10",
		"@babel/preset-env": "^7.12.10",
		"babel-loader": "^8.2.2",
		"mocha": "^8.2.1",
		"should": "^13.2.3",
		"standard-version": "^7.0.1",
		"webpack": "^4.41.4",
		"webpack-cli": "^3.3.10"
		"standard-version": "^9.0.0",
		"webpack": "^4.44.2",
		"webpack-cli": "^4.2.0"
		},
		@@ -35,0 +34,0 @@ "bin": {

Improved metrics

Worsened metrics

Dependency changes

		@@ -5,2 +5,9 @@ # Changelog

		### [4.1.1](https://github.com/dworthen/js-yaml-front-matter/compare/v4.1.0...v4.1.1) (2020-12-13)


		### Bug Fixes

		* update dependencies ([70fba4a](https://github.com/dworthen/js-yaml-front-matter/commit/70fba4af22c95eacaf5370a5b198602c452e3d68))

		## [4.1.0](https://github.com/dworthen/js-yaml-front-matter/compare/v4.0.0...v4.1.0) (2019-12-24)
		@@ -90,3 +97,1 @@
		All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.