Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement a new "payload" workspace/package #307

Open
fraxken opened this issue Aug 18, 2024 · 0 comments
Open

Implement a new "payload" workspace/package #307

fraxken opened this issue Aug 18, 2024 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@fraxken
Copy link
Member

fraxken commented Aug 18, 2024

A lot of our tools, such as the CLI, CI, and Report, rely on JSON payloads generated by the Scanner (via from/cwd APIs) to extract data, such as:

  • Authors/maintainers
  • Licenses
  • Number of pages
  • Size of all and each individual package
  • Flags
  • Files and dependencies (e.g., extensions, usage of Node.js core libs)
  • Vulnerabilities

Here are examples from our projects:

There are likely a few other places where we have similar needs. If you spot any, please don't hesitate to comment.

One of the constraints in many of these projects is performance. Iterating over the entire payload multiple times can be quite costly. So we somewhat need to found an API design that match that need.

@fraxken fraxken added enhancement New feature or request good first issue Good for newcomers labels Aug 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant