https://github.com/boennemann/unbreak

:broken_heart: :arrow_forward: :heart:
https://github.com/boennemann/unbreak

Last synced: about 16 hours ago
JSON representation

:broken_heart: :arrow_forward: :heart:

• Host: GitHub
• URL: https://github.com/boennemann/unbreak
• Owner: boennemann
• Created: 2015-10-30T21:02:35.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2015-10-30T23:13:41.000Z (almost 9 years ago)
• Last Synced: 2024-10-02T09:01:39.205Z (1 day ago)
• Homepage: http://npm.im/unbreak
• Size: 125 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# :broken_heart: unbreak :heart:

> Don’t leave me in all this pain. Don’t leave me out in the rain.

_Note: At this point `unbreak` is an idea without implementation._

`unbreak` aims to automatically update code so it stays compatible with its dependencies across [~~major~~](https://twitter.com/boennemann/status/597862058517000194) breaking version changes. In fact `unbreak` doesn’t do that all by itself. Rather it provides a standardized way for authors to attach transforms to a certain module and for consumers to execute them.

There are great tools like facebook’s [jscodeshift](https://github.com/facebook/jscodeshift) or substack’s [falafel](https://github.com/substack/node-falafel) that we can use to write such transforms.

For a module called `my-module` the author may publish a new module with the "unbreak" prefix – `unbreak-my-module` – that contains a transform for every major version that the package has.

_To encourage the use of semver `unbreak` supports transforms for major versions only._

_Transforms are published as a separate module so it's not necessary to add transformation tools as dependencies to the original module._

If you then run `unbreak` against your project it will look at the `npm outdated` output, update dependencies, find available transforms and correctly apply them to your codebase.