No description, website, or topics provided.
Clone or download
Pull request Compare This branch is 2 commits behind tam-borine:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
keymaps
lib
menus
public/audio
spec
styles
.gitignore
CHANGELOG.md
LICENSE.md
README.md
package.json

README.md

TDDetective 🎩

The atom package that sneakily watches you spiking functions and reminds you to keep it TDD! This package is currently available for Ruby.

Installation

apm install TDDetective

Usage

Once the package is installed, you will be able to activate it through the toggle option, which can be found by right clicking on the atom window.

Imgur

The package assumes that your tests will be located in a '/spec' directory and works through matching the class name and method name with the relevant _spec file, to ensure you're TDDing!

Customisation

If you wish to customise any of the visual features, you can edit the tddetective.less file, which is located in the styles directory.

Imgur

Contributing

Please do contact us and let us know about your contributions!

  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 😄

User Stories

As a user,
So that I can ensure my class has a spec file,
I would like the name to be highlighted in red, until a spec has file been created

As a user,
So that I can ensure my method has a test,
I would like it to be highlighted red until a test has been written.

As a user,
So that I can customise the amount of linting,
I would like to choose how it appears in atom.

The TDDetective Team

Ewan Sheldon

James Hamann

Matt Vickers

Peter Miklos

Tam Borine

License

Please view our License for more information.