https://github.com/airslie/styleguide

Style configuration for Airslie Ruby projects
https://github.com/airslie/styleguide

Last synced: about 1 month ago
JSON representation

Style configuration for Airslie Ruby projects

• Host: GitHub
• URL: https://github.com/airslie/styleguide
• Owner: airslie
• License: mit
• Created: 2017-07-21T09:17:19.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2023-01-26T11:42:04.000Z (almost 2 years ago)
• Last Synced: 2024-03-15T12:12:14.464Z (10 months ago)
• Size: 43 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Airslie Style Guide

Airslie shared style configuration and guide.

## Rubocop

To use the shared rubocop configuration in a project use the following three files:

.codeclimate.yml

```yaml

prepare:

  fetch:

  - url: "https://raw.githubusercontent.com/airslie/airslie-styleguide/master/rubocop.yml"

    path: "default.yml"

```

.rubocop.yml

```yaml

# Note that the local default.yml is overwritten on CodeClimate with the contents of

# the remote rubocop.yml pulled from GitHub in a codeclimate prepare step.

inherit_from:

  - default.yml

```

default.yml

```yaml

inherit_from:

  - https://raw.githubusercontent.com/airslie/airslie-styleguide/master/rubocop.yml

# Don't add anything to this file other than the inherit_from above

# as this file is overwritten on codeclimate with the contents of the above

# remote url which is downloaded in a codeclimate prepare step.

```

When running locally, rubocop inherits from the remote github styleguide default.yml.

When running on CodeClimate, a prepare step replaces the local default.yml with the remote

styleguide one.