npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

rugged

v1.0.1

Published

Orchestrate package testing across uneven terrain

Downloads

91

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

Screen recording

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:

{
    "scripts": {
        "test": "rugged"
    }
}

Create a test-projects/ directory with at least one test project inside of it (check out Rugged’s own test projects for examples, or the docs 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!

[![tested with Rugged](https://img.shields.io/badge/tested%20with-Rugged-green)](https://github.com/sparksuite/rugged)
<a href="https://github.com/sparksuite/rugged">
    <img alt="tested with rugged" src="https://img.shields.io/badge/tested%20with-Rugged-green">
</a>

Contributing

We love contributions! Contributing is easy; learn how.