akarzim / rubosort

Sort cops from a Rubocop configuration file in alphabetic order.

Rubosort

Sort cops from a Rubocop configuration file in alphabetic order.
Explore the docs »

Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

DISCLAIMER: This is a toy project to play with the dry-cli Ruby gem.

Built With

• dry-cli

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• git

Installation

1. Clone the repo

git clone https://github.com/akarzim/rubosort.git

Usage

In a terminal, step inside the Rubosort directory and run:

❯ ./rubosort --help
Commands:
  rubosort sort FILE           # Sort the given Rubocop file
  rubosort version             # Print version

The main command is sort which takes an argument and some options:

❯ ./rubosort sort --help
Command:
  rubosort sort

Usage:
  rubosort sort FILE

Description:
  Sort the given Rubocop file

Arguments:
  FILE                              # REQUIRED File to sort

Options:
  --output=VALUE, -o VALUE          # File to write in, default: "-"
  --[no-]force                      # Force write to output file, default: false
  --help, -h                        # Print this help

Examples:
  rubosort sort path/to/foo.yml            # Run Rubosort on foo.yml file
  rubosort sort foo.yml -o bar.yml         # Writes the result in bar.yml
  rubosort sort foo.yml -o bar.yml --foce  # Force writing into existing bar.yml file

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

François Vantomme - @akarzim

Project Link: https://github.com/akarzim/rubosort

Acknowledgements

• Othneil Drew for this readme template