@ianwremmel/pkgshift
Inspired by jscodeshift to help keep package.json consistent
Last updated 3 years ago by ianwremmel .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @ianwremmel/pkgshift 
SYNC missed versions from official npm registry.

@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

Current Tags

  • 1.1.1                                ...           latest (3 years ago)

7 Versions

  • 1.1.1                                ...           3 years ago
  • 1.1.0                                ...           3 years ago
  • 1.0.4                                ...           3 years ago
  • 1.0.3                                ...           3 years ago
  • 1.0.2                                ...           3 years ago
  • 1.0.1                                ...           3 years ago
  • 1.0.0                                ...           3 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (6)

Copyright 2014 - 2017 © taobao.org |