@fedran/lint
v0.1.0
Published
A lint program for running against Fedran fiction projects in standard layout.
Downloads
3
Readme
Fedran Linter
A command-line lint program that checks for various conventions in the Fedran fiction.
This includes checking for:
- Missing
summary
in the header. - Missing
title
in the header. - Missing epigraph as the first line of the contents.
This only checks the following paths, both .md
and .markdown
:
chapters/chapter-*.md
src/*.md
src/*/chapters/chapter-*.md
If an error is found, then this will return with a non-zero exit code.
Usage
The basic usage implies that it is run on the root level of the project.
$ fedran-lint
$ fedran-lint -d directory/path