https://github.com/metaory/noseyparker-compact
🚧 Compact report formats for Nosey Parker
https://github.com/metaory/noseyparker-compact
Last synced: 3 months ago
JSON representation
🚧 Compact report formats for Nosey Parker
- Host: GitHub
- URL: https://github.com/metaory/noseyparker-compact
- Owner: metaory
- License: mit
- Created: 2025-03-09T21:39:12.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2025-03-09T22:39:28.000Z (3 months ago)
- Last Synced: 2025-03-09T23:25:22.182Z (3 months ago)
- Size: 1.95 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
noseyparker-compact
compact report formatters for
noseyparker
transforms verbose noseyparker JSON reports
into concise summaries in JSON or CSV format
## Install
```bash
npm install -g noseyparker-compact
```
## Usage
```bash
npc -f (-i | < file) [-o ]
```
### Options
- `-f, --format` Output format (csv|json) [required]
- `-i, --input` Input file [required unless using stdin]
- `-o, --output` Output file [optional, defaults to stdout]
### Examples
```bash
# Using stdin
cat report.json | npc -f csv
cat report.json | npc -f json -o compact.json
# Directly using noseyparker
noseyparker report -f json | npc -f csv
noseyparker report -f json | npc -f json
# Using input file
npc -f csv -i report.json
npc -f json -i report.json -o output.json
# Using npx (no installation required)
npx noseyparker-compact -f csv -i report.json
cat report.json | npx noseyparker-compact -f json
```
### Structure
```jsonc
[
{
"rule_name": "Generic Password",
"mime_essence": "text/plain",
"kind": "git_repo",
"repo_path": "./xxxxxxxxxxxx/.git",
"blob_path": "xxxxxxxxx/xxxxxxxxxxxxxxxx/xxxxxx.xx",
"commit_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"committer_name": "John",
"committer_email": "[email protected]",
"committer_timestamp": "9999999999 +1000",
"author_name": "John",
"author_email": "[email protected]",
"author_timestamp": "8888888888 +1000",
"message": "xxxx xxxxxxx, xxxxxx xxxxxxx, xxxxx xxxxxxxxx xxx xxxxxxxx",
"source_span": "25@28:25@59",
"offset_span": "531:563",
"snippet_after": "# 'xxxxxxxx':\"xxxxxxxxxxxxxxxxxx\", # 'xxxx':'xxxxxxxxxxxxxxx', 'xxxx':\"xxxxxxxxxxxxxxxx\", 'xxxxxxxx':\"xxxxxxxxxxxxxxxxxxxx\"",
"snippet_matching": "xxxxxxxx':\"xxxxxxxxxxxxxxxxxxxx\"",
"snippet_before": "xxxxxx = { 'xxxxxxx':\"xxxxxxx.xxxxxxxxxxxxxx.xxxxx\", 'xxxxxxxxx':\"xxxxxxxxxx\", 'xxxxxx':\"xxxxx\", # 'xxxx': \"xxxxxxxxxxxxxxx\""
},
// ...
]
```
## License
[MIT](LICENSE)