litterboy-gb/rubocop-sketchup

Rubocop cops for SketchUp - test against our Extension Warehouse technical requirements and other pitfalls

RuboCop SketchUp

Code analysis for SketchUp extensions using the SketchUp Ruby API.

Tool intended to assist with development of SketchUp extension by providing static analysis for common issues.

Installation

TL;DR (Global Installation)

gem install rubocop -v 0.61.1
gem install rubocop-sketchup

The Long Version

For more information about the installation process and how to manage your gem dependencies locally for a project refer to the dedicated section in the manual:

• Manual: Requirements and Installation

Usage

TL;DR

Add .rubocop.yml in the root of your project:

require: rubocop-sketchup

AllCops:
  DisabledByDefault: true
  DisplayStyleGuide: true
  SketchUp:
    SourcePath: src # Path to extension sources in project directory.
    EncryptedExtension: false # Enable if you plan to encrypt your extension.
    TargetSketchUpVersion: 2016 M1

SketchupDeprecations:
  Enabled: true

SketchupPerformance:
  Enabled: true

SketchupRequirements:
  Enabled: true

SketchupSuggestions:
  Enabled: true

SketchupBugs:
  Enabled: true

The Long Version

• Manual: Basic Usage
• Manual: Configuration

Formatters

TL;DR

JSON

rubocop --format json --out results.json

Extension Review

rubocop -f extension_review -o report.html

The Long Version

• Manual: Formatters

The Cops

All cops are located under lib/rubocop/sketchup, and contain examples/documentation.

Manual: Cops

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

License

rubocop-sketchup is MIT licensed.