Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
docmatter
Advanced tools
Changelog
v4.7.0 2023 December 29
Readme
Battle tested SSG front matter parser. Extracted from DocPad. Delimiter lines have 3+ of the same character (such as /***
and ***/
) allowing front matters to work with the syntax highlighting of your code editor. Supports custom parsers, e.g. --- cson
. Parsers are handled externally.
docmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you
const docmatter = require('docmatter')
const yamljs = require('yamljs')
function parse (input) {
const matter = docmatter(input)
// if no front matter: {content}
if (!matter.header) return { content: matter.content.trim() }
// if front matter: {delimiter, parser, header, body, content}
let data = null
switch (matter.parser) {
case 'json':
if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {
data = JSON.parse(matter.header)
}
else {
data = JSON.parse(`{${matter.header}}`)
}
break;
case 'yaml':
default:
data = yamljs.parse(
matter.header.replace(/\t/g, ' ') // YAML doesn't support tabs that well
)
break;
}
return { data, content: matter.body.trim() }
}
// no content and only front matter
console.log(parse(`
---
title: Hello World
---
`))
// => { data: { title: 'Hello World' }, content: '' }
// markdown content with default front matter
console.log(parse(`
---
title: Hello World
---
**hello world**
`))
// => { data: { title: 'Hello World' }, content: '**hello world**' }
// markdown content with json front matter
console.log(parse(`
--- json
"title": "Hello World"
---
**hello world**
`))
// => { data: { title: 'Hello World' }, content: '**hello world**' }
// markdown content with no front matter
console.log(parse(`
**hello world**
`))
// => { content: '**hello world**' }
// javascript content with default front matter
console.log(parse(`
/***
minify: true
***/
alert('Hello World')
`))
// => { data: { minify: true }, content: 'alert(\'Hello World\')' }
npm install --save docmatter
import * as pkg from ('docmatter')
const pkg = require('docmatter')
This package is published with the following editions:
docmatter/source/index.coffee
is CoffeeScript source code with Require for modulesdocmatter
aliases docmatter/edition-esnext/index.js
docmatter/edition-esnext/index.js
is CoffeeScript compiled for Node.js 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modulesDiscover the release history by heading on over to the HISTORY.md
file.
Discover how to contribute via the CONTRIBUTING.md
file.
Unless stated otherwise all works are:
and licensed under:
FAQs
Battle tested SSG front matter parser. Extracted from DocPad. Delimiter lines have 3+ of the same character (such as `/***` and `***/`) allowing front matters to work with the syntax highlighting of your code editor. Supports custom parsers, e.g. `--- cso
The npm package docmatter receives a total of 314 weekly downloads. As such, docmatter popularity was classified as not popular.
We found that docmatter demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.