readme.md

pkg-upgrader

Forked from lib-upgrader props to @jfmengels for starting this cool tool.

Codemods, or jscodeshift transforms, are small programs that help automate changes in a codebase. Think of them as search and replace on steroids. This tool helps you to create a simple CLI to apply the codemods that you wrote, so that users can easily upgrade their code between various releases of your library.

Install

$ yarn add pkg-upgrader jscodeshift

Usage

Create a cli.js file at the root of your project that will serve as your upgrader executable, and add this sample code (sample available here):

#!/usr/bin/env node

import upgrader from 'pkg-upgrader';
import pkg from './package.json';
import releases from './releases.json';

var settings = {
	libraryName: 'Your library name',
	releases: releases,
	pkg: pkg,
	dirname: __dirname
};

upgrader.handleCliArgs(settings)
	.then(upgrader.checkForUpdates)
	.then(upgrader.checkGitIsClean)
	.then(upgrader.prompt)
	.then(upgrader.applyCodemods)
	.then(upgrader.printTip)
	.catch(function (err) {
		console.error(err.message);
		process.exit(1);
	});

and create a releases.json file next to cli.js, which looks like the following (sample available here):

[{
	"version": "0.14.0",
	"transforms": [
		{
		"title": "title of transform a",
		"path": "path/to/transform/a.js"
		},
		{
		"title": "title of transform b",
		"path": "path/to/transform/b.js"
		}
	]
}, {
	"version": "0.15.0",
	"transforms": [
		{
		"title": "title of transform c",
		"path": "path/to/transform/c.js"
		},
		{
		"title": "title of transform d",
		"path": "path/to/transform/d.js"
		}
	]
}, {
	"version": "1.0.0",
	"transforms": [
		{
		"title": "title of transform e",
		"path": "path/to/transform/e.js"
		},
		{
		"title": "title of transform f",
		"path": "path/to/transform/f.js"
		}
	]
}, {
	"version": "2.0.0",
	"transforms": [
		{
		"title": "title of transform g",
		"path": "path/to/transform/g.js"
		},
		{
		"title": "title of transform h",
		"path": "path/to/transform/h.js"
		}
	]
}]

Give execution right to your script

chmod +x script

and you should now be able to run the cli using

./cli.js

Unless you committed your changes and your directory is clean, when you run it, the program will exit and ask you to either commit or stash your changes. You can force through it by adding --force to the command line.

License

MIT © Ben Monro MIT © Jeroen Engels