/pkg-rename

CLI to quickly rename a npm package

Primary LanguageJavaScriptMIT LicenseMIT

pkg-rename

CLI to quickly rename a npm package
npm package version npm downloads standard JS linter prettier code formatting travis ci build status project license make a pull request

Github Watch Badge Github Star Badge Tweet

Built with ❤︎ by tiaanduplessis and contributors

Table of Contents

Table of Contents
  • Install
  • Usage
  • Contribute
  • License

    • Install

    $ npm -g install @tiaanduplessis/pkg-rename
# OR
$ yarn add global @tiaanduplessis/pkg-rename

    Usage

    cd into your package's directory after renaming it. You can then run:

    $ pkg-rename old-package-name
# or 
$ pkg-rename --old=old-package-name

    This will get the latest version of the old package from npm and deprecate this and all previous published versions with a message:

    WARNING: This project has been renamed to new-package-name. Install using new-package-name instead.

    new-package-name is retrieved from the closest package.json

    You can also publish directly after:

    $ pkg-rename old-package-name --publish

    Contributing

    Contributions are welcome!

    1. Fork it.
    2. Create your feature branch: git checkout -b my-new-feature
    3. Commit your changes: git commit -am 'Add some feature'
    4. Push to the branch: git push origin my-new-feature
    5. Submit a pull request :D

    Or open up a issue.

    License

    Licensed under the MIT License.