npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@rojo2/gulp-gray-matter

v4.0.1

Published

A gulp plugin for extracting data header from file contents using gray-matter.

Downloads

5

Readme

gulp-gray-matter

A gulp plugin for extracting data header from file contents using gray-matter.

"See the benchmarks. gray-matter is 20-30x faster than front-matter." (@jonschlinkert)

npm Package Version MIT License Travis Build Status Codecov Test Coverage Dependencies Status devDependencies Status



About

gulp-gray-matter is a plugin for gulp, to extract data headers from file contents using gray-matter.

The extracted data is set as a property of the file object for further processing. You can customize the property name and also use nested properties (via object-path).

If the file object already has data attached on the defined property, existing data will be merged recursively with extracted data (using merge). You can define a custom function for setting data to change this behavior.

There are further custom options and of course you can also use all gray-matter options.

Setup and usage

Install gulp-gray-matter using npm:

npm i gulp-gray-matter

In your gulpfile.js:

import gulp from 'gulp'
import loadPlugins from 'gulp-load-plugins'

const plugins = loadPlugins()

gulp.task('default', function() {
  return gulp.src('./src/**.*')
    .pipe(plugins.grayMatter({ /* options */ }))
    // …
    .pipe(gulp.dest('./dest'));
});

A common workflow, after extracting front matter, could be using a template rendering plugin like gulp-jade.

Options

Beside its own options, gulp-gray-matter also supports all gray-matter options: delimiters, excerpt, excerpt_separator and language.

engines is currently not supported.

property

String

Default: 'data'

The file object property for setting data. can also be a nested property name like foo.bar.baz.

remove

Boolean

Default: true

Whether data header should be removed from file contents or not.

trim

Boolean

Default: true

Whether file contents should be trimmed after removing file header or not. (has no effect if options.remove is false.)

setData

Function

Default:

function setData(oldData, newData) {
  return require('merge').recursive(oldData, newData);
}

If there is already data attached to the file object on the property defined with options.property, existing data will be recursively merged with extracted data. Set your own function to change this behavior.

License

MIT © 2016 Simon Lepel

Before version 2.2.2, @jakwings was the original author and owner of the npm package gulp-gray-matter.