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

@darkobits/publish-root

v1.0.0

Published

Massage your package tarballs.

Downloads

2

Readme

publish-root

NPM Version david Code Style

In large/complex packages, it is often handy to utilize the filesystem in addition to exports to organize and namespace things. However, it can be obnoxious to require your consumers to include a path segment like dist when importing a module from your package; it bears no semantic meaning and is often required on every import because it's where all of your package's build artifacts live.

This package attempts to address that issue. Tell it what folder your build artifacts are in, and it ensures your tarballs are packed correctly.

Setup

Install:

$ npm install @darkobits/publish-root

Then, add the following scripts to your project's package.json:

"scripts": {
  "prepack": "pr:pre",
  "postpack": "pr:post"
}

It is assumed that your build artifacts are located in dist. If this is not the case, you may indicate where they are by passing an argument to pr:pre:

"scripts": {
  "prepack": "pr:pre foo"
}

To do a dry run, you can run npm pack (set the LOG_LEVEL environment variable to verbose for additional logging) and inspect the contents of the tarball it produces:

$ npm pack
$ tar -tvf your-package-name-1.2.3.tgz

You do not need to change anything in package.json; relevant fields will be re-written and restored automagically.


This approach has the following benefits:

  • Works with Lerna (install in each package, not at the root)
  • Does not break npm link.

See Also