search

snyk / policy

Snyk policy parser and matching logic
Other
8 stars 8 forks source link

feat!: bundle library and emit types #125

Closed gclapperton closed 1 year ago

gclapperton commented 1 year ago

What does this PR do?

This PR bundles the library using Vite into a package that contains the following files

All nested packages have been rolled up into these top level files. Most of the contents of index.ts have been moved to policy.ts and now only the functions exported from index.ts are exposed as part of the public API. This better communicates what is public and what is not, as well as allowing us to make internal changes without the risk of breaking any clients that rely on nested packages.

Types are now also emitted for the first time!

How should this be manually tested?

Run npm pack to bundle the library and then npm install the resulting snyk-policy-0.0.0.tgz into Registry, CLI or any other consumer of the library to make sure that there are no breaking changes... besides updating/alignment of types.

team-narwhal-user commented 1 year ago

:tada: This PR is included in version 3.0.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket: