https://github.com/sparksuite/rugged
Orchestrate package testing across uneven terrain
https://github.com/sparksuite/rugged
orchestration test-automation test-runner testing testing-tools
Last synced: about 1 year ago
JSON representation
Orchestrate package testing across uneven terrain
- Host: GitHub
- URL: https://github.com/sparksuite/rugged
- Owner: sparksuite
- License: mit
- Created: 2021-02-26T20:46:10.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-29T20:51:56.000Z (about 1 year ago)
- Last Synced: 2025-04-29T21:36:58.441Z (about 1 year ago)
- Topics: orchestration, test-automation, test-runner, testing, testing-tools
- Language: TypeScript
- Homepage: https://ruggedjs.io
- Size: 3.51 MB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
#
Rugged
Rugged orchestrates testing JavaScript packages across the variety of real-world environments and contexts where they’ll actually be used, with the files that will actually be published.
- ⚡️ Performant design
- 🔧 Configurable
- 📦 Written entirely in TypeScript
- 🌎 Works in CLI and CI environments
- 🔬 Thoroughly tested
- ✨ Tiny size
- 📖 Well documented
## The problem
Today, people can consume your package in many contexts—in Node.js, in a browser, in an ECMAScript module, in a Common JS module, within a library (e.g., React, Angular, etc.), with assistance from compilers/transpilers/bundlers (e.g., TypeScript, Babel, Webpack, etc.), even inside test runners (e.g., Jest, Mocha, etc.). Each of these contexts has a unique set of capabilities, limitations, requirements, global variables, etc. that could impact or even break your package’s behavior.
Further, testing often only occurs against the source files that are available in the repository, which is problematic in two ways… First, tools may manipulate the source code in such a way that the compiled/transpiled/bundled version behaves slightly differently than the source code. Second, misconfigurations in your `package.json` may cause necessary files to be excluded from the published version of your package.
## How Rugged helps
Rugged facilitates testing your package in the environments and contexts where your package will be used, using the files that would be published (i.e., the compiled/transpiled/bundled files that are included according to your `package.json` settings).
This is done by injecting the compiled & packaged version of your package into a series of minimal test projects you create, which mimic the various contexts in which your package could be used/consumed. These test projects live in your package’s repository and simply need a `test` script in their `package.json` files. Rugged will run the `test` script in each test project to verify your package works as expected in each environment/context.
## Quick start
Install with Yarn or npm:
```
yarn add --dev rugged
```
```
npm install --save-dev rugged
```
Add `rugged` to the `test` script in the `package.json` file:
```json
{
"scripts": {
"test": "rugged"
}
}
```
Create a `test-projects/` directory with at least one test project inside of it (check out [Rugged’s own test projects](https://github.com/sparksuite/rugged/tree/master/test-projects) for examples, or [the docs](https://ruggedjs.io/docs/getting-started/create-test-projects) for more details and suggested projects).
## Documentation
Read the docs at: https://ruggedjs.io/docs/
## Badge
Let the world know your package is being tested with Rugged!
```markdown
[](https://github.com/sparksuite/rugged)
```
```html
```
## Contributing
We love contributions! Contributing is easy; [learn how](https://github.com/sparksuite/rugged/blob/master/CONTRIBUTING.md).