gimpact 0.1.6 → 0.1.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -20,3 +20,24 @@ npx gimpact@latest [options]
|
|
|
20
20
|
```bash
|
|
21
21
|
bunx gimpact@latest [options]
|
|
22
22
|
```
|
|
23
|
+
|
|
24
|
+
## Options
|
|
25
|
+
|
|
26
|
+
- `-V, --version`: Output the version number
|
|
27
|
+
- `-d, --days <number>`: Number of days to analyze (default: 30)
|
|
28
|
+
- `-s, --since <date>`: Start date (YYYY-MM-DD)
|
|
29
|
+
- `-u, --until <date>`: End date (YYYY-MM-DD)
|
|
30
|
+
- `-m, --mode <type>`: Analysis mode: `aggregate`, `periodic`, `ownership` (default: `aggregate`)
|
|
31
|
+
- `-p, --period-unit <type>`: Period unit for periodic mode: `daily`, `weekly`, `monthly` (default: `daily`)
|
|
32
|
+
- `-a, --authors <names...>`: Filter by specific author names (can specify multiple). Enables deep-dive stability analysis
|
|
33
|
+
- `-b, --branch <name>`: Analyze specific branch (default: current branch)
|
|
34
|
+
- `-c, --min-commits <number>`: Minimum number of commits to include an author (default: 1)
|
|
35
|
+
- `-h, --help`: Display help for command
|
|
36
|
+
|
|
37
|
+
## Commands
|
|
38
|
+
|
|
39
|
+
- `summary`: Show aggregate report with all analyses (default)
|
|
40
|
+
- `daily`: Show daily periodic report
|
|
41
|
+
- `weekly`: Show weekly periodic report
|
|
42
|
+
- `monthly`: Show monthly periodic report
|
|
43
|
+
- `ownership`: Show code ownership analysis (files, directories, authors)
|