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

@stash-it/dev-tools

v0.0.4

Published

![logo-stash-it-color-dark 2x](https://user-images.githubusercontent.com/1819138/30385483-99fd209c-98a7-11e7-85e2-595791d8d894.png)

Downloads

16

Readme

@stash-it/dev-tools

logo-stash-it-color-dark 2x

Set of tools for development purposes.

If you want to create an adapter or a plugin for stash-it, you can use this package to help you with that.

Installation

npm

npm install @stash-it/dev-tools

deno

deno add @stash-it/dev-tools

yarn

yarn dlx jsr add @stash-it/dev-tools

pnpm

pnpm dlx jsr add @stash-it/dev-tools

bun

bunx jsr add @stash-it/dev-tools

Usage

runAdapterTests

If you want to create an adapter, it should pass all of those tests. Here's how you can use them. Oh, and you should use vitest for testing, the function uses it under the hood. If you're not using vitest yet, you should start using it. It's awesome.

Perhaps in the future, I'll add support for other testing libraries or be more abstract, but for now it is what it is.

// Vitest stuff
import { describe } from "vitest";

import { runAdapterTests } from '@stash-it/dev-tools';

// Your adapter.
import { YourAdapter } from './your-adapter';

describe('YourAdapter', () => {
  const adapter = new YourAdapter();
  
  // Add whatever validation or other stuff you need.
  
  // Run the tests.
  runAdapterTests(adapter);
});

This helper function accepts an adapter instance and runs tests on it. It will throw an error if any of the tests fail. It is also capable of cleaning up after self. Meaning, if you're operating on a persistent storage, it will delete all the items created during the tests.

getHandler

If you want to creat a plugin, you can use this helper function to get a handler for a specific hook. Here's how you can use it:

// Vitest stuff
import { describe, it, expect } from "vitest";

import { getHandler } from '@stash-it/dev-tools';

// Your plugin.
import { createPlugin } from './your-plugin';

describe('YourPlugin', () => {
  it('does something on buildKey', async () => {
    const plugin = createPlugin();
    const key = "key";
    const handler = getHandler('buildKey', plugin);
    
    // Here is where you can test the handler that you created.
    const result = await handler(key);
    
    // expect ... etc.
  });
});

Why not simply do this?

const handler = plugin.hookHandlers.buildKey;

Well ... current types set around plugins are not that great. This helper function will throw an error if the handler is not a function. Also, thanks to the argument passed (hook name), it will know what arguments the handler should accept etc. And you don't need to reach to plugin internals. You simply request a handler for a specific hook and that's it.

License

MIT

Contribution

Feel free to open an issue or a pull request.