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

@guardian/automat-client

v0.2.17

Published

Client lib for Automat

Downloads

29

Readme

@guardian/automat-client

A basic (JS) client for Automat. If you are reading this and don't know what Automat is, this library is probably not useful for you.

Local dev

Watch for changes

$ yarn dev

Point a project to your local version of automat-client

With yarn link you can develop against a locally checked out version of this client:

In your local checkout of automat-client:

$ yarn link

And then in the project consuming the client:

$ yarn link "@guardian/automat-client"

To revert back to using the published version of the package:

$ yarn unlink "@guardian/automat-client"
$ yarn install --force

NOTE: Ensure you build this library before adding it locally to your project, by running yarn build.

Publishing

On your feature branch, increment the version in the package.json file. Once we hit version 1 we should use semver when doing this.

Once the feature branch is merged into master, run:

yarn publishToNPM

This will build and then publish to NPM.

You should then push your (updated) master to origin.

You can then update the clients!

Note: you'll need to be part of the @guardian org on npm to do this.
Speak to a suitable person if you don't have access.