0.5.3 • Published 5 years ago
morbo-cli v0.5.3
Morbo
"to Tech Debt Stop it, stop it. It's fine. I will destroy you"
Getting started
yarn add morbo
Recommended: Create a .morborc
file
// Default options
{
"scanPath": process.cwd(),
"ignoredDirectories": [
"**/node_modules/**",
".git/**",
".hg/**",
"**/flow-typed/**",
"**/morbo_report/**",
"build/**",
"dist/**",
"config/**",
],
"filesToScan": ["**/*.{js,php,go}"],
"fileEncoding": "utf8",
"lineLengthLimit": 1000,
"skipChecks": [],
"customDefinitions": {},
"openReportOnCompletion": false,
"projectId": "YOUR_MORBO_PROJECT_ID",
"sendReportOnCompletion": false,
"showGitBlame": true,
"showSkippedChecks": false,
}
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": { "myCustomDefinition": { "description": "Replace all occurences of @stylus with emotion components", "regex": "@stylus", "label": "Stylus Components" } }
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
0.5.3
5 years ago
0.5.2
5 years ago
0.5.1
5 years ago
0.5.0
5 years ago
0.4.5
5 years ago
0.4.4
5 years ago
0.4.3
5 years ago
0.4.2
5 years ago
0.4.1
5 years ago
0.4.0
5 years ago
0.3.2
5 years ago
0.3.1
5 years ago
0.3.0
5 years ago
0.2.6
5 years ago
0.2.5
5 years ago
0.2.4
5 years ago
0.2.3
5 years ago
0.2.2
5 years ago
0.2.1
5 years ago
0.2.0
5 years ago