https://github.com/wesley-dean/mega-linter-plugin-fmlint
https://github.com/wesley-dean/mega-linter-plugin-fmlint
Last synced: 28 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/wesley-dean/mega-linter-plugin-fmlint
- Owner: wesley-dean
- License: cc0-1.0
- Created: 2025-04-11T13:16:41.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2025-04-11T17:08:37.000Z (about 1 month ago)
- Last Synced: 2025-04-11T17:46:10.511Z (about 1 month ago)
- Language: Shell
- Size: 38.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# mega-linter-plugin-frontmatter-linter
[](https://github.com/wesley-dean/mega-linter-plugin-fmlint/actions/workflows/megalinter.yml)
[](https://github.com/wesley-dean/mega-linter-plugin-fmlint/actions/workflows/dependabot/dependabot-updates)
[](https://github.com/wesley-dean/mega-linter-plugin-fmlint/actions/workflows/scorecard.yml)
This is a MegaLinter plugin for linting YAML frontmatter found in Markdown
files.
## Introduction
[MegaLinter](https://github.com/oxsecurity/megalinter) by
[OxSecurity](https://github.com/oxsecurity) is a linter tool that supports
various programming languages and file formats. This repository contains a
MegaLinter plugin for linting YAML frontmatter found in Markdown files.
[yamllint](https://github.com/adrienverge/yamllint) by
[adrienverge](https://github.com/adrienverge) is used to perform the actual
linting while [GNU sed](https://www.gnu.org/software/sed/) is used to extract
the frontmatter from the Markdown files. This plugin is designed to be used
with MegaLinter and is not intended to be used as a standalone tool.
## Usage
To use this plugin, you need to have MegaLinter installed. Please refer to the
[MegaLinter documentation](https://nvuillam.github.io/megalinter/) for
installation instructions.
### MegaLinter Configuration
To use this plugin, add the following to your MegaLinter configuration:
```yaml
PLUGINS:
- "https://raw.githubusercontent.com/wesley-dean/mega-linter-plugin-fmlint/refs/heads/main/mega-linter-plugin-fmlint/fmlint.megalinter-descriptor.yml
```
> [!TIP]
> Simply adding the plugin to the `PLUGINS` section will cause MegaLiner to read
> the descriptor and make it available for use. However, depending on your
> MegaLinter configuration, you may need to enable the linter in the
> `ENABLE_LINTERS` section as well. For example:
```yaml
ENABLE_LINTERS:
- "MARKDOWN_FMLINT""
```
### Selecting files to lint
The plugin uses `yamllint` to lint the frontmatter of Markdown files. By
default, this plugin will lint all Markdown files in the repository. That's
probably not the desired behavior as it'll attempt to lint Markdown files that
don't have any frontmatter at which point `yamllint` will throw an error saying
that there's no `---` found. To prevent this, limit the files to only those
that actually are expected to include frontmatter. This can be done by setting
`MARKDOWN_FMLINT_FILTER_REGEX_*` options in the `.mega-linter.yml` file. For
example, if you only want to lint Markdown files the `pages` and `posts`
directories, you can add the following to your `.mega-linter.yml` file:
```yaml
MARKDOWN_FMLINT_FILTER_REGEX_INCLUDE: "(pages\|posts)/.*\\.md"
```
### Configuring the Linter
To configure `yamllint` (the tool that performs the actual linting), you may
create a `.fmlint.yml` file in the root of your repository. For more
information on configuring, refer to the
[yamllint documentation](https://yamllint.readthedocs.io/en/stable/configuration.html)
> [!NOTE]
> Because `yamllint` is doing the linting, the configuration file must be a
> valid configuration for `yamllint`. By default, the plugin will look for a
> file named `.fmlint.yml` in the root of your repository. It will not look for
> a file named `.yamllint.yml` or any other name. If you want to use a
> different name, you can specify the name of the file in the
> `FMLINT_CONFIG_FILE` option. This is because one is likely to have a
> different configuration for `yamllint` than for `fmlint`. If you want to
> use the same configuration for both, you can simply create a symlink to the
> file in the root of your repository.