https://github.com/ableco/coding-standards-ruby
Automated linting Ruby code for Able projects, using https://github.com/ableco/rubocop-able
https://github.com/ableco/coding-standards-ruby
Last synced: about 1 month ago
JSON representation
Automated linting Ruby code for Able projects, using https://github.com/ableco/rubocop-able
- Host: GitHub
- URL: https://github.com/ableco/coding-standards-ruby
- Owner: ableco
- License: mit
- Created: 2019-10-31T04:04:24.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-10-31T06:00:34.000Z (over 6 years ago)
- Last Synced: 2026-01-01T13:23:19.140Z (5 months ago)
- Language: Ruby
- Size: 7.81 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# able-coding-standards-ruby
Automated linting for Able using https://github.com/ableco/rubocop-able
## How does it work?
`able-coding-standards` requires you to run `rake coding_standards:install` in your project's root directory to copy [Rubocop](https://rubocop.readthedocs.io) configuration file.
It also installs `lefthook` and copy a `lefthook.yml` file to run **Rubocop** based on `rubocop-able` configuration in a pre-commit stage.
In case any of these configuration files already exists, they should be updated manually to reflect the contents of the ones provided by `able-coding-standards` (for example, in case a project already has an Rubocop configuration file).
## Installation
Add `able-coding-standards` in your `Gemfile`:
```ruby
gem "able-coding-standards", "0.1.0"
```
## Usage
Run `rake coding_standards:install` and follow the instructions.
It will try to copy the following files:
* `.rubocop.yml`
* `lefthook.yml`
In case any of these files already exists, it will shows the content of those files in the console's output and let you copy and paste those configurations manually.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ableco/coding-standards-ruby.