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/pkgu

v0.6.2

Published

Automatically build @guardian packages for publishing to NPM inline with our recommendations.

Downloads

16

Readme

@guardian/pkgu

Automatically build @guardian packages for publishing to NPM inline with our recommendations.

npm (scoped)

Installation

Generic badge

yarn add -D @guardian/pkgu

or

npm install -D @guardian/pkgu

Usage

@guardian/pkgu installs a CLI tool called pkgu that you can use to create your build.

Commands

build

Example
// package.json
{
    ...,
    "scripts": {
        "prebuild": "rm -rf dist",
        "build": "pkgu build"
    },
    ...,
}

This will compile your project to a dist directory ready for publishing, performing the following steps:

  1. Lint your package.json and tsconfig.json files and update/add/remove any fields as necessary.
  2. Compile 3 versions of your project:
    1. CommonJS version targetting ES2018 (for Node 10+).
    2. ESM version targetting ES2020 for use by bundlers (see Using @guardian NPM packages in the recommendations for more info).
    3. TypeScript declaration files.
  3. Check that the build artefacts match the package.json config.
  4. If your package provides a CLI it will set the permissions needed to make it executable.

You should then be good to publish.

Requirements

  • Your source code is written in TypeScript.
  • The source code lives in a directory called src at the package root level.
  • There is one entry point: src/index.ts.