Morbo
"[to Tech Debt] Stop it, stop it. It's fine. I will destroy you"
Getting started
yarn add morbo
.morborc
file
Recommended: Create a // Default options
Configure Options (In More Detail)
- scanPath: The path to scan through for notes, defaults to process.cwd()
- ignoredDirectories: Glob patterns for directories to ignore. Passes these straight to minimatch so check there for more information on proper syntax.
- filesToScan: Glob patterns for files to scan. Also uses minimatch.
- fileEncoding: The encoding the files scanned will be opened as.
- lineLengthLimit: The number of max characters a line can be before Morbo gives up and doen not scan it for matches. If a line is too long, the regular expression will take an extremely long time to finish. You have been warned!
- skipChecks: List of check names to skip. Valid options:
note
,optimize
,todo
,hack
,xxx
,fixme
,bug
,line
.line
will disable the line length warning. - customDefinitions: Hashmap of custom defined regex terms. Follows the following format:
"customDefinitions":
CLI Usage
morbo --help
More Examples
Take a look at the examples/annotation.test.js
file, all of those comments in there are supported and expected to parse with Morbo.
Thanks to JohnPostlethwait and his project fixme on which this project gets its roots