Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces npm packaging support for the repository, enabling seamless integration with JavaScript/TypeScript applications. It adds a build system to auto-generate distributable modules, documentation for npm usage, and updates the repository metadata to reflect its new capabilities.
NPM Packaging Enablement:
package.jsonfile to define the npm package, including entry points, exports, included files, build scripts, and metadata for publishing as@cloudsmith/rego-recipes.scripts/build.js) that scans all.regopolicy files, extracts metadata, and generates bothdist/index.js(JavaScript module) anddist/index.d.ts(TypeScript definitions) for consumption as an npm package.Documentation Updates:
NPM.mdfile with detailed installation instructions, usage examples, available exports, and TypeScript type definitions for consumers of the npm package.README.mdto reference npm usage and the new documentation, making it clear how to consume the repository as an npm package.