Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nikolalsvk/ordinare
Ordinare sorts gems in your Gemfile alphabetically
https://github.com/nikolalsvk/ordinare
gem rails sort
Last synced: 4 days ago
JSON representation
Ordinare sorts gems in your Gemfile alphabetically
- Host: GitHub
- URL: https://github.com/nikolalsvk/ordinare
- Owner: nikolalsvk
- License: mit
- Created: 2017-07-26T22:07:40.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-07-31T12:30:10.000Z (over 4 years ago)
- Last Synced: 2025-01-19T10:05:22.758Z (11 days ago)
- Topics: gem, rails, sort
- Language: Ruby
- Homepage: https://rubygems.org/gems/ordinare
- Size: 2.38 MB
- Stars: 179
- Watchers: 7
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ordinare
[](https://semaphoreci.com/nikolalsvk/ordinare)
[](https://badge.fury.io/rb/ordinare)
[](https://codecov.io/gh/nikolalsvk/ordinare)
[](CONTRIBUTING.md#5-make-a-pull-request)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fnikolalsvk%2Fordinare?ref=badge_shield)
[](https://www.codetriage.com/nikolalsvk/ordinare)
Ordinare sorts gems in your Gemfile alphabetically
In order to install the gem, do:
```
$ gem install ordinare
```
## Usage :pick:
Position yourself inside Rails project with Gemfile and do:
```
$ ordinare
```
And that's it!
Ordinare will sort your Gemfile and overwrite your current Gemfile.
If you don't want ordinare to overwrite your Gemfile, see [Don't overwrite Gemfile](#dont-overwrite-gemfile).
_NOTE: be sure to do `$ bundle install` after ordinare sorts your Gemfile just
to make sure everything is OK._
### Love for the gem groups :heart:
If you're using something along these lines in your Gemfile:
```ruby
...
group :test do
gem "webmock"
gem "cucumber-rails"
end
group :development do
gem "byebug"
gem "spring"
do
...
```
ordinare will consider groups inside your Gemfile and will sort
gems inside those groups, not messing them up.
### Love for the comment groups :green_heart:
If you're organizing your gems using comments in similar fashion:
```ruby
...
# Auth
gem "devise"
gem "oauth2"
# Assets
gem "sprockets"
gem "sprockets-es6"
gem "pusher"
...
```
ordinare will sort gems below your comments, treating them as groups
(e.g. "Auth" group and "Assets" group).
## Advanced usage :hammer_and_pick:
### Pass in path to Gemfile
You can pass in path to your gemfile:
```
$ ordinare --path my_awesome_project/Gemfile
```
And that's it!
You can find your ordered Gemfile at `my_awesome_project/Gemfile`.
### Don't overwrite Gemfile
Ordinare has an option that will make Gemfile.ordinare instead of overwriting
your original Gemfile.
Just call ordinare like this:
```
$ ordinare --no-overwrite
```
And that's it!
You can find your ordered Gemfile at `Gemfile.ordinare`.
### Check if Gemfile is sorted
There is an option to check your Gemfile to see if it's sorted.
This will not overwrite nor create a new sorted Gemfile.
Call ordinare like this:
```
ordinare --check
```
And that's it, ordinare will inform your whether your Gemfile is
sorted properly or not. This can be useful on some CI server
where you check if Gemfile is sorted.
## Contributing :writing_hand:
Any suggestions and improvements are more than welcome :bowing_man:.
If you'd like to contribute, you can check [CONTRIBUTING.md](CONTRIBUTING.md)
## License
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fnikolalsvk%2Fordinare?ref=badge_large)