https://github.com/mataku/danger-local_rules
A Danger plugin to manage local rules.
https://github.com/mataku/danger-local_rules
danger-plugin ruby
Last synced: about 2 months ago
JSON representation
A Danger plugin to manage local rules.
- Host: GitHub
- URL: https://github.com/mataku/danger-local_rules
- Owner: mataku
- License: mit
- Created: 2018-03-27T10:44:48.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-02-09T07:56:52.000Z (over 4 years ago)
- Last Synced: 2025-06-11T04:17:33.337Z (4 months ago)
- Topics: danger-plugin, ruby
- Language: Ruby
- Homepage:
- Size: 31.3 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# danger-local_rules
A [Danger](http://danger.systems) plugin to manage local rules.
## Installation
$ gem install danger-local_rules
## Usage
Create `.danger_local_rules.yml` in project root, and add contents to fail or warn.
```yml
# See: example/.danger_local_rules.yml
failure:
'legacyFunc': ':cry:'
warning:
'TODO': 'You should check'
'FIXME': 'Yet?'
```
Add this to Dangerfile.
```ruby
# Optional: you can specify yml file path. (Default: $projectRoot/.danger_local_rules)
# local_rules.rules_file = './scripts/file.yml'
local_rules.check
```
## Changelog
See [changelog.md](./changelog.md).
## Development
1. Clone this repo
2. Run `bundle install` to setup dependencies.
3. Run `bundle exec rake spec` to run the tests.
4. Use `bundle exec guard` to automatically have tests run as you make changes.
5. Make your changes.