Web Packages

Web Packages integrates Node.js packages into Ruby projects using Bake. It delegates installation and scripts to npm-compatible package managers, then materializes selected packages as deterministic static assets.

Features

Supports npm, pnpm, Yarn and Bun without replacing their package-management behavior.
Treats registry dependencies and local workspace packages consistently through node_modules.
Copies complete distributions or carefully selected files into public/_components.
Generates a deterministic manifest and browser import map.
Provides Bake tasks for installation, scripts, static deployment and verification.

Usage

Please browse the reference index or refer to the guides below.

Getting Started

This guide explains how to use web-packages to install an external JavaScript dependency and expose it as static assets from a Ruby project.

Internal Packages

This guide explains how to organize JavaScript developed inside a Ruby project as independent workspace packages while using Web Packages for testing and static deployment.

Static Packages

This guide explains how to control which installed package files are deployed, generate browser import maps and verify the resulting static projection.

Releases

Please browse the releases for more details.

Contributing

We welcome contributions to this project.

Fork the repository.
Create your feature branch (git checkout -b my-new-feature).
Commit your changes (git commit -am 'Add some feature.').
Push to the branch (git push origin my-new-feature).
Create a new pull request.

Running Tests

To run the test suite:

$ bundle exec bake test

Making Releases

To make a new release:

$ bundle exec bake gem:release:patch # or minor or major

Developer Certificate of Origin

In order to protect users of this project, we require all contributors to comply with the Developer Certificate of Origin. This ensures that all contributions are properly licensed and attributed.

Community Guidelines

This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.