Skip to content
/ tcr Public

Get going with 'test && commit || revert' in seconds

Notifications You must be signed in to change notification settings

joejag/tcr

Repository files navigation

TCR

All Contributors PRs Welcome js-standard-style

TCR lets you instantly use the test && commit || revert method of software development on your project. TCR watches your files, and when you save any file, the tests are run, if they pass the change is committed if it fails the code is reverted.

Poof! The failing code is gone.

TCR helps you think of the smallest possible changes you can make, without ever having broken code hanging around.

Example Screenshot

Usage

TCR runs on Windows, Linux and Mac. First install node, then run npx tcr 'my test command' and you will be up and running.

Features

  • No installation necessary
  • Each save runs your test command. If it passes it's committed, if it fails it's reverted
  • Failure messages are kept in the console, rather than overridden by the next test run
  • .gitignore is respected to prevent watching compiled files
  • Stats on commits and reverts are shown along with the most recent file change detected
  • Cross-platform for Windows, Linux and Mac

Editor support

TCR is reliant on editors respecting changes on disk.

Editor Supported? Notes
VS Code You may have to disable some plugins like Prettier which interfere with listening to changes
Atom
Sublime Text
Vim You need to install the autoread bundle to get reloading to work without a prompt
IntelliJ suite IntelliJ doesn't like external apps changing things, instead use the limited wip plugin by Dmitry Kandalov

If you can try any other editors, then please update this section! PRs Welcome

Feedback

Feel free to send feedback on Twitter or file an issue. Feature requests are always welcome. If you wish to contribute, please take a quick look at the guidelines!

Further Reading

Kent Beck created this method in September 2018. He wrote the original article on Medium

Contributors

Thanks goes to these wonderful people (emoji key):

Joe Wright
Joe Wright

💻
Kent Beck
Kent Beck

🤔
Thomas Deniffel
Thomas Deniffel

📝 💡

This project follows the all-contributors specification. Contributions of any kind welcome!

About

Get going with 'test && commit || revert' in seconds

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published