General

Refer to the RuboCop documentation about general configuration of RuboCop itself.

`rubocop-sketchup` Configuration

Source Path

By default rubocop-sketchup expects to find the source for the SketchUp extension within a src directory relative to your .rubocop.yml config file.

This can be configured to match your own project structure by overwriting AllCops/SketchUp/SourcePath in your .rubocop.yml:

AllCops:
  SketchUp:
    SourcePath: src

If this isn't configured correctly then some cops, such as SketchupRequirements/FileStructure will fail as extension file structure is part of the Extension Warehouse technical requirements. Additionally, SketchUp expects this particular file structure to fully manage the extension.

Encrypted Extensions

When encrypting an extension there are additional technical requirements. Enable AllCops/SketchUp/EncryptedExtension to turn on these additional checks for your project. This is by default off.

AllCops:
  SketchUp:
    EncryptedExtension: true

Extension Binaries

Regardless of the extension is going to be encrypted, when loading binary Ruby C Extension libraries require must always be used. To make the cops aware of what require statements are binary libraries, add them to the AllCops/SketchUp/EncryptedExtension list.

AllCops:
  SketchUp:
    EncryptedExtension: true
    ExtensionBinaries:
      - 'example/libs/ruby2.0/my_lib'
      - 'example/libs/ruby2.2/my_lib'

Target SketchUp Version

The SketchupSuggestions/Compatibility cop checks for usage of the SketchUp API against a configured target version.

Currently the default is SketchUp 2016.

rubocop --only SketchupSuggestions/Compatibility
Inspecting 30 files
.....................C........

Offenses:

examples/snippets/deprecations/compatibility.rb:9:13: C: SketchupSuggestions/Compatibility: The class Sketchup::ImageRep was added in SketchUp 2018 which is incompatible with target SketchUp 2014.
    image = Sketchup::ImageRep.new
            ^^^^^^^^^^^^^^^^^^
examples/snippets/deprecations/compatibility.rb:23:13: C: SketchupSuggestions/Compatibility: The constant Geom::PolygonMesh::MESH_POINTS was added in SketchUp 2018 which is incompatible with target SketchUp 2014.
    flags = Geom::PolygonMesh::MESH_POINTS | Geom::PolygonMesh::MESH_NORMALS
            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
examples/snippets/deprecations/compatibility.rb:38:5: C: SketchupSuggestions/Compatibility: The method #onPidChanged was added in SketchUp 2017 which is incompatible with target SketchUp 2014.
    def onPidChanged(model, old_pid, new_pid) ...
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

30 files inspected, 3 offenses detected

This can be configured to match your own project structure by overwriting AllCops/SketchUp/SourcePath in your .rubocop.yml:

AllCops:
  SketchUp:
    TargetSketchUpVersion: 2016 M1

Available versions are:

SketchUp Cop Excludes

Current version of RuboCop doesn't support exclude filters for departments. To make it easier to exclude certain files for the SketchUp departments this can be configured in the SketchUp config section:

AllCops:
  SketchUp:
    Exclude:
    - src/example/foo.rb
    - src/example/bar.rb
    - test/**/*

Department Excludes

As an alternative to setting up exclude patterns for all SketchUp cops it is also possible to configure excludes per SketchUp department.

AllCops:
  SketchUp:
    SketchupPerformance:
      Exclude:
      - src/example/biz.rb
    SketchupSuggestions:
      Exclude:
      - src/example/foo.rb
      - src/example/bar.rb
      - test/**/*

Extra Details

Several cops have additional details to explain what they are checking. You can enable this by using the -D command line parameter or modifying your .rubocop.yml file by adding ExtraDetails: true under AllCops.

AllCops:
  ExtraDetails: true

Reference URLs

For even more details, enable DisplayStyleGuide to display an URL to a more detailed explanation for each cop. Add -S to the command line or modify your .rubocop.yml file to set it permanently.

AllCops:
  DisplayStyleGuide: true