1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
# RuboCop::Packaging
`RuboCop::Packaging` is an extension of [RuboCop](https://rubocop.org/),
which is a Ruby static code analyzer (a.k.a. linter) and code formatter.
It helps enforcing some of the guidelines that are expected of upstream
maintainers so that the downstream can build their packages in a clean
environment without any problems.
## Documentation
A detailed documentation, explaining what this extension is doing and the
reasoning behind it, can be found here: https://docs.rubocop.org/rubocop-packaging/
We also have a [packaging-style-guide](https://packaging.rubystyle.guide/),
listing some good and bad examples and the rationale behind these cops.
In case anything is not clear, please feel free to raise an issue, asking
for more explanation!
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'rubocop-packaging'
```
And then execute:
```bash
$ bundle install
```
Or install it yourself as:
```bash
$ gem install rubocop-packaging
```
## Usage
You need to tell RuboCop to load the Packaging extension. There are three
ways to do this:
### RuboCop configuration file
Put this into your `.rubocop.yml` file:
```yaml
require: rubocop-packaging
```
Alternatively, use the following array notation when specifying multiple
extensions:
```yaml
require:
- rubocop-other-extension
- rubocop-packaging
```
Now you can run `rubocop` and it will automatically load the RuboCop Packaging
cops together with the standard cops.
### Command line
```bash
rubocop --require rubocop-packaging
```
### Rake task
```ruby
RuboCop::RakeTask.new do |task|
task.requires << 'rubocop-packaging'
end
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then,
run `rake spec` to run the tests. You can also run `bin/console` for an
interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`.
## Contributing
As always, bug reports and pull requests are heartily welcomed! 💖
This project is intended to be a safe and welcoming space for collaboration.
## License
`rubocop-packaging` is available as open-source under the
[MIT License](https://github.com/utkarsh2102/rubocop-packaging/blob/master/LICENSE).
|
