-
Notifications
You must be signed in to change notification settings - Fork 3
/
USAGE
43 lines (35 loc) · 1.62 KB
/
USAGE
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
Lint or fix files in the current working directory.
Usage:
hallmark [command] [options]
Commands:
lint [file...] Lint markdown files (default)
fix [file...] Fix markdown files
cc add <target...> Add release(s) to CHANGELOG.md.
cc init Create a CHANGELOG.md from scratch. Inserts releases
for all versions unless --gte or --lte are provided.
Arguments:
file By default hallmark includes files matching "*.md".
To override this provide one or more file arguments
which can be file paths or glob patterns.
target A release type (major, minor, patch, premajor,
preminor, prepatch, prerelease) or a version.
Options:
-i --ignore <file> File or glob pattern to ignore (can be repeated)
-h --help Print usage and exit
-v --version Print version and exit
--report <reporter> Specify reporter
--[no-]color Force color in report (detected by default)
--fix Backwards-compatible alias for fix command
--no-commits Don't populate release with commits
--gte <version> Only include versions greater than or equal to this
--lte <version> Only include versions less than or equal to this
--verbose Enable verbose output
Examples:
# Lint *.md files
$ hallmark
# Fix *.md files
$ hallmark fix
# Fix custom files
$ hallmark fix CHANGELOG.md docs/*.md
# Add new minor version to changelog
$ hallmark cc add minor