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

packito

v0.5.0

Published

clean your package before publishing it !

Downloads

1,873

Readme

📦 Packito

Build Status codecov NPM version License

Packito is a cli tool to clean package before publishing it.

Purpose

Before publishing to npm, did you take care of your package.json ?

  • devDependencies, some scripts and other entries("husky", ...) could be removed.
  • add some new or change entries, like "main" source file name
  • use a dist file and copy some extra files/directories in it (README.md, LICENSE, ...).
  • and finally publish your package using npm, np or lerna.

Simple using one command:

$ packito

By default it will remove "scripts" and "devDependencies", copy README.md and LICENSE if they exist to './dist' folder.

Install

$ yarn add --dev packito

Or using npm

$ npm add --dev packito

Usage

$ packito [options] [bin-to-publisher]

Options

| name | alias | description | | ----------- | --- | ----------- | | --dist | -d | Path to publish from | | --nopublish | -n | Skips publishing step | | --help | -h | Displays help informations |

Bin to publisher

| name | description | | ----------- | ----------- | | npm | Publish using npm | | lerna | Publish using npm | | np | Publish using np |

.packito.json

It is the configuration file. This json should be at root of the project, a sample:

{
  "remove": {
    "devDependencies": "*",
    "scripts": "*",
    "type": true,
    "esm": true,
    "husky": true,
    "commitlint": true
  },
  "replace": {
    "main": "index.js",
    "module": "index.mjs"
  },
  "publisher":  "np"
}

| name | type | description | | ----------- | --- | ----------- | | remove | object | all keys to remove from packages.json (if =true or ='*' replace all) | | replace | object | all keys+values to replace in packages.json | | copy | object | all files to copy in dist | | output | string | folder to publish to | | publisher | string|object | The publisher to use (npm, np, lerna) |

Other command examples

Publish to path 'publish'

$ packito -d ./publish

Publish to path 'publish' and use np patchto publish

$ packito -d ./publish np patch

Coded using state of the art and simplicity in mind

  • Simple to use
  • Modern ES6+ syntax (import instead of require, await/async, ...)
  • Follows Node best practices

Requirements

  • Node >= 10

Contribution

Read Contributing Guide for development setup instructions.