Skip to content

Commit d9d1059

Browse files
docs: explain auto-renaming of package.json to _package.json
1 parent de646f7 commit d9d1059

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,16 @@ npx stackscan scan --color brand
8181

8282
---
8383

84+
## Dependabot & Security
85+
86+
When hosting `package.json` files for analysis, security tools like Dependabot may incorrectly flag them as vulnerable dependencies of your project.
87+
88+
To prevent this, StackScan will **automatically rename** any `package.json` found in `public/stackscan/` to `_package.json`.
89+
- Dependabot ignores `_package.json`.
90+
- StackScan prioritizes reading `_package.json` on future runs.
91+
92+
---
93+
8494
## Output
8595

8696
For each project in `public/stackscan/`, a `stack.json` is generated in the same folder.

0 commit comments

Comments
 (0)