v0.7.1

Summary

Release v0.7.x adds new options regarding in- and output streams.

Output

The --output=[stream or filepath] option has been introduced.

Examples

ruboclean --output=/absolute/path.yml
ruboclean --output=relative/path.yml    # relative to current working directory
ruboclean --output=STDOUT               # does not write anything to a file

Input

It's now possible to read from STDIN using the --stdin option:

echo "SomeConfig: True" | ruboclean --stdin

Using STDIN will automatically set the output to STDOUT. You can use the --output flag to override this.

Also, if you use STDIN, your current working directory should be the root directory of your project, so that the
cleanup of unused paths/references (see --preserve-paths) works properly. If your current working directory
is something else, you have to explicitly provide the project's root directory using the input argument.

echo "SomeConfig: True" | ruboclean /path/to/the/project/directory --stdin

v0.6.0

This release adds the --verify option. Can be used to simulate the cleaning, the exit code will return 1 if there were changes, and 0 if the output remained the same.

v0.5.0

This releease introduces a new functionality where unused paths in Include: and Exclude: properties are removed.

Example input:

AllCops:
  Exclude:
  - path/file_exists.rb
  - path_with_files/**/*
  - path/file_does_not_exist.rb # Will be removed if the file doesn't exist. Skip with --preserve-paths option.
  - path_without_files/**/* # Will be removed if no files within pattern exist. Skip with --preserve-paths option.

Example output:

---

AllCops:
  Exclude:
  - path/file_exists.rb
  - path_with_files/**/*

This feature can be disabled using the --preserve-paths CLI option flag.

v0.4.0

This release adds new flags to the ruboclean command:

• --silent can be used to suppress any output displayed on the screen when executing the command.
• --preserve-comments will preserve preceding comments for each top-level entry in the configuration. Inline comments are not preserved. This addresses #23

v0.3.0

• This release permits the loading of Ruby Regexp from YAML files.