https://github.com/andyw8/codeclimate-doby
https://github.com/andyw8/codeclimate-doby
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/andyw8/codeclimate-doby
- Owner: andyw8
- Created: 2015-08-31T15:34:03.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-09-20T19:15:11.000Z (over 10 years ago)
- Last Synced: 2025-02-23T23:25:06.102Z (10 months ago)
- Language: Ruby
- Size: 176 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Code Climate DoBy Engine
`codeclimate-doby` is a Code Climate engine based on [DoBy](https://github.com/andyw8/do_by), a tool for setting expiry dates on TODO notes.
You can run it on the command line using the Code Climate CLI, or on the Code Climate hosted analysis platform.
### Usage
The engine looks for `TODO` notes in your code, for example:
`TODO: 2038-01-19 fix date handling`
The date must be formatted as YYYY-MM-DD.
When the checker runs on or after this date, CodeClimate will report an Overdue Task issue.
### Installation
1. If you haven't already, [install the Code Climate CLI](https://github.com/codeclimate/codeclimate).
1. Run `codeclimate engines:enable doby`. This command both installs the engine and enables it in your `.codeclimate.yml` file.
1. You're ready to analyze! Browse into your project's folder and run `codeclimate analyze`.
### Development
```sh
docker build -t codeclimate/codeclimate-doby .
codeclimate analyze --dev
```