rubocop-sketchup

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

rubocop-sketchup

★ 20 Open GitHub ↗

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

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# RuboCop SketchUp

[![Gem Version](https://badge.fury.io/rb/rubocop-sketchup.svg)](https://badge.fury.io/rb/rubocop-sketchup) ![Build status](https://github.com/sketchup/rubocop-sketchup/actions/workflows/tests.yaml/badge.svg?branch=main) [![Documentation Status](https://readthedocs.org/projects/rubocop-sketchup/badge/?version=latest)](https://rubocop-sketchup.readthedocs.io/en/latest/?badge=latest)

Code analysis for SketchUp extensions using the [SketchUp Ruby API](http://ruby.sketchup.com/).

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

![](https://raw.githubusercontent.com/SketchUp/rubocop-sketchup/main/manual/images/rubocop-example.png)

## Installation

### TL;DR (Global Installation)

```sh
gem install rubocop
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](https://rubocop-sketchup.readthedocs.io/en/latest/installation/)

## Usage

### TL;DR

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

```yaml
plugins:
  - 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](https://rubocop-sketchup.readthedocs.io/en/latest/basic_usage/)
* [Manual: Configuration](https://rubocop-sketchup.readthedocs.io/en/latest/configuration/)

### Formatters

### TL;DR

#### JSON

```bash
rubocop --format json --out results.json
```

#### Extension Review

```bash
rubocop -f extension_review -o report.html
```

### The Long Version

* [Manual: Formatters](https://rubocop-sketchup.readthedocs.io/en/latest/formatters/)

## The Cops

All cops are located under [`lib/rubocop/sketchup`](lib/rubocop/sketchup), and contain examples/documentation.

[Manual: Cops](https://rubocop-sketchup.readthedocs.io/en/latest/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.

rubocop-sketchup

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README