Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/barbosa/danger-clorox
A Danger plugin for Clorox.
https://github.com/barbosa/danger-clorox
Last synced: about 2 months ago
JSON representation
A Danger plugin for Clorox.
- Host: GitHub
- URL: https://github.com/barbosa/danger-clorox
- Owner: barbosa
- License: mit
- Created: 2016-07-04T20:33:04.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-06-02T02:16:42.000Z (over 7 years ago)
- Last Synced: 2024-10-05T22:04:02.179Z (3 months ago)
- Language: Ruby
- Homepage: https://github.com/barbosa/clorox
- Size: 37.1 KB
- Stars: 12
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-danger - danger-clorox - A Danger plugin for Clorox. (Plugins / Ruby (danger))
README
[](https://circleci.com/gh/barbosa/danger-clorox)
# Danger Clorox
A [Danger](https://github.com/danger/danger) plugin for [Clorox](https://github.com/barbosa/clorox) that runs on macOS.
```diff
+//
+// DirtyFile.swift
+// MyApp
+//
+// Created by John Appleseed on 11/12/16.
+// Copyright © 2016 ACME. All rights reserved.
+//
+
+import Foundation
```
:scream:
## Installation
Add this line to your Gemfile:
```rb
gem 'danger-clorox'
```
## Usage
### Basic
Add the following line to your Danger file to check files inside the current directory:
```rb
clorox.check
```
### Advanced
Specify the directories where you want to run the script:
```rb
clorox.check ["YourProject", "YourProjectNotificationExtension"]
```
Set the script level so it displays failures/warnings in the specific markdown table
```rb
clorox.level = "failure"
clorox.check ["YourProject", "YourProjectNotificationExtension"]
```
### Output
1 Error
:no_entry_sign:
MyApp/Source/DirtyFile.swift contains Xcode's file header
## Attribution
Original structure, sequence, and organization of repo taken from [danger-prose](https://github.com/dbgrandi/danger-prose) by [David Grandinetti](https://github.com/dbgrandi/) and [danger-swiftlint](https://github.com/ashfurrow/danger-swiftlint) by [Ash Furrow](https://github.com/ashfurrow/).
## License
MIT