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

remark-frontmatter-validator

v1.0.0

Published

Validate the values in your frontmatter

Downloads

51

Readme

remark-frontmatter-validator Test

A remark plugin to validate the values in your frontmatter.

Install

Install the plugin and remark-frontmatter:

npm install remark-frontmatter-validator remark-frontmatter --save-dev

Add the plugin to your .remarkrc and define the shape of your frontmatter:

{
  "plugins": [
    ["remark-frontmatter", ["yaml"]],
    [
      "remark-frontmatter-validator",
      [
        2,
        {
          "title": {
            "type": "string",
            "required": true
          },
          "image": {
            "type": "string",
            "required": true
          },
          "tags": {
            "type": "array"
          }
        }
      ]
    ]
  ]
}

Options

The plugin accepts an object that describes the fields in your frontmatter. Each key of the object should match a key in your frontmatter. The key's value is an object that describes the value.

In the example below, title is a required value and it must be a string:

"title": {
  "type": "string",
  "required": true
}

Field object

The key's value is an object that describes the value.

  • type - The value's type: string, object, number, boolean, array, or date.
  • maxLength - The value's maximum length.
  • oneOf - An array of options that the value must match.
  • match - A regular expression that the value must match.
  • required - Set the value as true if it is required.

In the example below, there can be up to 2 tags and it can match "writing", "code", or "notes":

"tags": {
  "type": "array",
  "maxLength": 2,
  "oneOf": ["writing", "code", "notes"]
}

In the example below, the image path must match the regex (where 2020-10-31-cat.png is valid and cat.gif is invalid) and it is required:

"image": {
  "match": "^\\d\\d\\d\\d-\\d\\d-\\d\\d-.*.(png|jpg)",
  "type": "string",
  "required": true
},