Skip to content

Commit dc9f51d

Browse files
authored
Prep 7.1.0, add note in docs for badges (#59)
1 parent e038ada commit dc9f51d

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,15 @@ To customise your analysis, use the following options, placed in a `codehawk.jso
120120
| `excludeDirectories` | Directory matches that should be excluded from analysis. Relative to the root. E.g. `['/fixtures', '/test']` | `['/dist', '/bin', '/build']` |
121121
| `skipDirectories` | Directories that should be excluded completely. The defaults will always be skipped. | `['/node_modules', '/flow-typed', '/coverage']` |
122122

123+
## Badges
124+
125+
By default, codehawk-cli generates 2 badges (in `generated/*.svg`) when called via the main CLI interface:
126+
127+
- Average: the average maintainbility score of all targeted source code
128+
- Worst: the worst case score in the targeted source code
129+
130+
A higher score is better (simpler, more maintainable code).
131+
123132
## Complexity Metrics
124133

125134
Codehawk gathers various complexity metrics, including:

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "codehawk-cli",
3-
"version": "7.0.1",
3+
"version": "7.1.0",
44
"description": "Static analysis tool for JavaScript projects",
55
"scripts": {
66
"build:watch": "tsc --watch",

0 commit comments

Comments
 (0)