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

@ianwremmel/pkgshift

v1.1.1

Published

Inspired by jscodeshift to help keep package.json consistent

Downloads

21

Readme

@ianwremmel/pkgshift

license standard-readme compliant

Greenkeeper badge dependencies Status devDependencies Status semantic-release

CircleCI Coverage Status

Inspired by jscodeshift to help keep package.json consistent

Install

npm install @ianwremmel/pkgshift

or

npm install @ianwremmel/pkgshift

Usage

For the most up to date docs, run pkgshift --help.

run

`pkgshift run ./package.json -t ./tranform.js

pkgshift's only command, run, applies a transform file to a package.json.

A transform file is of the form

module.exports = function transform(pkg, {api}) {
    return Object.assign(pkg);
};

where transform implements the transformCallback and api is a reference to the TransformAPI.

API

TransformAPI

Helper methods passed to your transform function

Type: Object

setOrReplaceScript

Sets a script, or, if that script already exists, transforms it into the new script

Parameters

  • pkg Package
  • options Object
    • options.from (string | RegExp) The original script definition. Must be an exact match, but if a RegExp is supplied, the substring matches will be available to to
    • options.name string The name in pkg.scripts
    • options.to string The final script definition. If from is a RegExp, to may include substring references.

Package

The Object defined by a package.json

Type: Object

pkgShift

Asynchronously apply the specified transform to the specified package.

Parameters

Returns Promise<Package>

transformCallback

Type: Function

Parameters

Returns (Package | Promise<Package>)

apply

Asynchronously apply the specified transform to the specified package.

Parameters

Returns Promise<Package>

Meta

cli

Main command line entry point

Parameters

PkgShiftOptions

Type: Object

Properties

  • path string File to transform
  • transform string Path to the transform file.
  • verbose number Show more information about the transform process
  • dry boolean Dry run (no changes are made to files)
  • print boolean Print output, useful for development
  • silent boolean No output

pkgshift

Parameters

Meta

  • deprecated: please use cli Main command line entry point

Maintainers

Ian Remmel

Contribute

See CONTRIBUTE

License

© MIT