Standard - Ruby style guide, linter, and formatter

This gem is a spiritual port of StandardJS and aims to save you (and others!) time in the same three ways:

• No configuration. The easiest way to enforce consistent style in your project. Just drop it in.
• Automatically format code. Just run standard --fix and say goodbye to messy or inconsistent code.
• Catch style issues & programmer errors early. Save precious code review time by eliminating back-and-forth between reviewer & contributor.

No decisions to make. It just works.

Install by adding it to your Gemfile:

gem "standard", :require => false

And running bundle install.

Run StandardRB from the command line with:

$ bundle exec standard

And if you'd like, StandardRB can autocorrect your code by tacking on a --fix flag.

StandardRB — The Rules

• 2 spaces – for indentation
• Double quotes for string literals - because pre-committing to whether you'll need interpolation in a string slows people down
• Hashrockets - Hashrockets.
• Semantic blocks - {/} for functional blocks that return a value, and do/end for procedural blocks that have side effects. More here and here
• Trailing dots on multi-line method chains - chosen because it makes copying lines into a REPL easier
• And a good deal more

If you're familiar with RuboCop, you can look at StandardRB's current base configuration in config/base.yml.

[NOTE: until StandardRB hits 1.0.0, we consider this configuration to be a non-final work in progress and we encourage you to submit your opinions (and reasoned arguments) for the addition, removal, or change to a rule by opening an issue. If you start using StandardRB, don't be shocked if things change a bit!]

Usage

ONce you've installed standard, you should be able to use the standard program. The simplest use case would be checking the style of all JavaScript files in the current working directory:

$ bundle exec standard
standard: Use Ruby Standard Style (https://github.com/testdouble/standard)
standard: Run `standard --fix` to automatically fix some problems.
  /Users/code/cli.rb:31:23: Style/Semicolon: Do not use semicolons to terminate expressions.

You can optionally pass in a directory (or directories) using the glob pattern. Be sure to quote paths containing glob patterns so that they are expanded by standard instead of your shell:

$ bundle exec standard "lib/**/*.rb" test

Note: by default standard will look for all *.rb files (and some other files typically associated with Ruby like *.gemspec and `Gemfile)

What you might do if you're clever

If you want or need to configure StandardRB, there are a handful of options are available creating a .standard.yml file in the root of your project.

Here's an example yaml file with every option set:

fix: true
parallel: true
format: progress

ignore:
  - 'db/schema.rb'
  - 'vendor/bundle/**/*'
  - 'test/**/*':
    - Style/BlockDelimiters

What you might do if you're REALLY clever

Because StandardRB is essentially a wrapper on top of RuboCop, it will actually forward the vast majority of CLI and ENV arguments forward to RuboCop.

You can see a list of RuboCop's CLI flags here.

Why should I use Ruby Standard Style?

(This section will look familiar if you've used StandardJS.)

The beauty of Ruby Standard Style is that it's simple. No one wants to maintain multiple hundred-line style configuration files for every module/project they work on. Enough of this madness!

This module saves you (and others!) time in three ways:

• No configuration. The easiest way to enforce consistent style in your project. Just drop it in.
• Automatically format code. Just run standard --fix and say goodbye to messy or inconsistent code.
• Catch style issues & programmer errors early. Save precious code review time by eliminating back-and-forth between reviewer & contributor.

Adopting standard style means ranking the importance of code clarity and community conventions higher than personal style. This might not make sense for 100% of projects and development cultures, however open source can be a hostile place for newbies. Setting up clear, automated contributor expectations makes a project healthier.

Who uses Ruby Standard Style?

(This section will not look very familiar if you've used StandardJS.)

Almost nobody! (Yet!)

Is there a readme badge?

Yes! If you use standard in your project, you can include one of these badges in your readme to let people know that your code is using the standard style.

[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)

I disagree with rule X, can you change it?

[NOTE: until StandardRB hits 1.0.0, the answer is yes! It just requires opening an issue and convincing @searls (the BDFNow) to make the change.]

No. The whole point of standard is to save you time by avoiding bikeshedding about code style. There are lots of debates online about tabs vs. spaces, etc. that will never be resolved. These debates just distract from getting stuff done. At the end of the day you have to 'just pick something', and that's the whole philosophy of standard -- its a bunch of sensible 'just pick something' opinions. Hopefully, users see the value in that over defending their own opinions.

Pro tip: Just use standard and move on. There are actual real problems that you could spend your time solving! :P

Is there an automatic formatter?

Yes! You can use standard --fix to fix most issues automatically.

standard --fix is built into standard for maximum convenience. Most problems are fixable, but some errors (like forgetting to handle errors) must be fixed manually.

To save you time, standard outputs the message "Run standard --fix to automatically fix some problems" when it detects problems that can be fixed automatically.

How do I ignore files?

Sometimes you need to ignore additional folders or specific minified files. To do that, add a .standard.yml file to the root of your project and specify a list of files and globs that should be excluded:

ignore:
  - 'db/schema.rb'
  - 'vendor/bundle/**/*'

How do I hide a certain warning?

In rare cases, you'll need to break a rule and hide the warning generated by standard.

Ruby Standard Style uses RuboCop under-the-hood and you can hide warnings as you normally would if you used RuboCop directly.

To ignore only certain rules from certain globs (not recommended, but maybe your test suite uses a non-standardable DSL, you can specify an array of RuboCop rules to ignore for a particular glob:

ignore:
  - 'test/**/*':
    - Style/BlockDelimiters

You can also use special comments to disable all or certain rules within your source code. See RuboCop's docs for details.

How do I change the output?

StandardRB's built-in formatter is intentionally minimal, printing only unfixed failures or (if successful) a "Done" message. If you'd like to use a different formatter, you can specify any of RuboCopy's built-in formatters or write your own.

For example, if you'd like to see colorful progress dots, you can either run standard with:

$ bundle exec standard --format progress
Inspecting 15 files
...............

15 files inspected, no offenses detected
✨  Done in 0.42s.

Or, in your project's .standard.yml file, specify:

format: progress

Refer to RuboCop's documentation on formatters for more information.

License

MIT. Copyright (c) Test Double, LLC.