NodeSecure / NodeSecure/scanner
(Tarball) deprecate old APIs
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 40
- Forks
- 23
- Avg merge
- 23h 23m
- Merged PRs (30d)
- 2
Description
It's about time we deprecate:
- scanDirOrArchive
- scanPackage
And then refactor Scanner APIs
We should also refactor verify API to properly split between spec and a path (right now it default to process.cwd which could be incorrect in some API scenario).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the scanDirOrArchive, scanPackage, Scanner, and verify APIs. Read how verify currently derives its path from process.cwd and how the tarball-related APIs are used. Done means the old APIs are deprecated, Scanner APIs are refactored, and verify clearly separates spec from path without relying on process.cwd by default.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- nodejs, typescript
- Domain
- cli, devtools
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100