Remove YAML front matter from JS files before linting

Usage no npm install needed!

<script type="module">
  import eslintPluginFrontmatter from '';



Build Status

Remove YAML frontmatter from .js files before calling ESLint. Given the following file:

process: true

const cat = () => console.log('meow')

This plugin removes the frontmatter and sends the remaining content to ESLint:

const cat = () => console.log('meow')

The use case for this plugin was JavaScript development for a site built with Jekyll.


You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-frontmatter:

$ npm install eslint-plugin-frontmatter --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-frontmatter globally.


Add frontmatter to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

  "plugins": [

After adding this plugin, frontmatter will be removed from your JavaScript files before they're linted.


To start the tests, run:

npm run test