https://github.com/dblock/obcd
Deal with obsessive compulsive issues of programmers in Objective-C.
https://github.com/dblock/obcd
Last synced: 9 months ago
JSON representation
Deal with obsessive compulsive issues of programmers in Objective-C.
- Host: GitHub
- URL: https://github.com/dblock/obcd
- Owner: dblock
- License: mit
- Created: 2014-03-28T16:23:20.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2014-04-21T11:26:24.000Z (about 12 years ago)
- Last Synced: 2025-09-04T10:18:17.769Z (9 months ago)
- Language: Ruby
- Size: 344 KB
- Stars: 41
- Watchers: 7
- Forks: 8
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
Obcd
====
[](https://travis-ci.org/dblock/obcd)
Deal with obsessive compulsive issues of programmers in Objective-C.
Eventually, the goal of OBCD is to become to Objective-C what [Rubocop](https://github.com/bbatsov/rubocop) is to Ruby. So far it does one useful thing: help you fix the comment style on top of .h and .m files. For example, it can tell you that the name of the file in that comment doesn't match the actual file name.
## Checks
* [HeaderStyle](docs/checks/HeaderStyle.md): Check header style on top of .h, .m and .pch files.
* [SpectaFocus](docs/checks/SpectaFocus.md): Detect instances of focused specs (e.g. fdescribe(…), fit(…)).
## Usage
```
gem install obcd
```
#### Get Help
```
obcd help
```
#### Example: Find Files with Invalid Headers
```
$ obcd --path=spec/fixtures find HeaderStyle
HeaderStyle/WrongExtension.m: 1 violation
/Users/artsy/HeaderStyle/WrongExtension.m:2:1: warning: HeaderStyle: Filename extension doesn't match, expected .m, got .h.
HeaderStyle/WrongFilename.h: 1 violation
/Users/artsy/HeaderStyle/WrongExtension.h:2:1: warning: HeaderStyle: Expected header to include file name, instead got // ThisFilenameIsWrong.h.
Found 2 violations.
```
#### Example: Find Focused Specs
```
$ obcd --path=spec/fixtures find SpectaFocus
SpectaFocus/FocusedSpec.m: 5 violations
/Users/artsy/SpectaFocus/FocusedSpec.m:5:1: warning: SpectaFocus: Unexpected fcontext(…) found.
/Users/artsy/SpectaFocus/FocusedSpec.m:6:1: warning: SpectaFocus: Unexpected fdescribe(…) found.
/Users/artsy/SpectaFocus/FocusedSpec.m:7:1: warning: SpectaFocus: Unexpected fexample(…) found.
/Users/artsy/SpectaFocus/FocusedSpec.m:9:1: warning: SpectaFocus: Unexpected fit(…) found.
/Users/artsy/SpectaFocus/FocusedSpec.m:11:1: warning: SpectaFocus: Unexpected fspecify(…) found.
SpectaFocus/InconsistentlyFormattedSpec.m: 2 violations
/Users/artsy/SpectaFocus/InconsistentlyFormattedSpec.m:4:1: warning: SpectaFocus: Unexpected fdescribe(…) found.
/Users/artsy/SpectaFocus/InconsistentlyFormattedSpec.m:5:1: warning: SpectaFocus: Unexpected fit(…) found.
Found 7 violations.
```
#### Xcode
You can also run OBCD as an Xcode build phase in order to see warnings inline in your files.
1. Add a new Run Script Build Phase
2. Add something like:
```
source ~/.zshrc # or `source ~/.bashrc`
obcd find HeaderStyle
```
The next time you build your project you should see any OBCD warnings alongside others:
## Contributing
See [CONTRIBUTING](CONTRIBUTING.md).
## Copyright and License
Copyright (c) 2014, Daniel Doubrovkine, [Artsy](http://artsy.github.io).
This project is licensed under the [MIT License](LICENSE.md).