standard-rubocop-lts 2.0.4 → 2.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +0 -0
- data/CHANGELOG.md +134 -8
- data/CITATION.cff +20 -0
- data/CODE_OF_CONDUCT.md +3 -4
- data/CONTRIBUTING.md +202 -47
- data/FUNDING.md +70 -0
- data/LICENSE.md +10 -0
- data/README.md +351 -334
- data/RUBOCOP.md +71 -0
- data/SECURITY.md +3 -4
- data/certs/pboling.pem +27 -0
- data/config/base.yml +5 -0
- data/lib/standard/rubocop/lts/version.rb +2 -4
- data/sig/standard/rubocop/lts/version.rbs +10 -0
- data/sig/standard/rubocop/lts.rbs +0 -1
- data.tar.gz.sig +0 -0
- metadata +206 -66
- metadata.gz.sig +0 -0
- data/LICENSE.txt +0 -21
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 43c676d7b889fcc95098ab44b5e2adb76fe52586839a56d3dbb210a5992e89fd
|
|
4
|
+
data.tar.gz: 7254006413a04cda458c8bc820418c13ff3af130bfb52b25e0c38b8981bb3aca
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8a45af875c5da01a49b540058b05ae23f94f6c0207c91cb3378a6d247ce8f9e2ecb1b4a71ae7edd0fdf5458b968a847c3bd4ac3af3ec80736a9295bbbc19faaf
|
|
7
|
+
data.tar.gz: 268af36240344416a4de43ef76b774eee24f32d96539369002226b8635a0635e752ab71e14d3330b537f163b5d29031bb0135f40e0e95ac65774c67e3b1bd14f
|
checksums.yaml.gz.sig
CHANGED
|
Binary file
|
data/CHANGELOG.md
CHANGED
|
@@ -1,67 +1,151 @@
|
|
|
1
1
|
# Changelog
|
|
2
|
+
|
|
3
|
+
[![SemVer 2.0.0][📌semver-img]][📌semver] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog]
|
|
4
|
+
|
|
2
5
|
All notable changes to this project will be documented in this file.
|
|
3
6
|
|
|
4
|
-
The format is based on [Keep a Changelog]
|
|
5
|
-
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
|
|
7
|
+
The format is based on [Keep a Changelog][📗keep-changelog],
|
|
8
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
|
|
9
|
+
and [yes][📌major-versions-not-sacred], platform and engine support are part of the [public API][📌semver-breaking].
|
|
10
|
+
Please file a bug if you notice a violation of semantic versioning.
|
|
11
|
+
|
|
12
|
+
[📌semver]: https://semver.org/spec/v2.0.0.html
|
|
13
|
+
[📌semver-img]: https://img.shields.io/badge/semver-2.0.0-FFDD67.svg?style=flat
|
|
14
|
+
[📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
|
|
15
|
+
[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
|
|
16
|
+
[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
|
|
17
|
+
[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
|
|
6
18
|
|
|
7
19
|
## [Unreleased]
|
|
20
|
+
|
|
8
21
|
### Added
|
|
22
|
+
|
|
9
23
|
### Changed
|
|
10
|
-
|
|
24
|
+
|
|
25
|
+
### Deprecated
|
|
26
|
+
|
|
11
27
|
### Removed
|
|
12
28
|
|
|
29
|
+
### Fixed
|
|
30
|
+
|
|
31
|
+
### Security
|
|
32
|
+
|
|
33
|
+
## [2.0.7] - 2026-06-25
|
|
34
|
+
|
|
35
|
+
- TAG: [v2.0.7][2.0.7t]
|
|
36
|
+
- COVERAGE: 100.00% -- 19/19 lines in 4 files
|
|
37
|
+
- BRANCH COVERAGE: 0.00% -- 0/0 branches in 4 files
|
|
38
|
+
- 71.43% documented
|
|
39
|
+
|
|
40
|
+
### Added
|
|
41
|
+
|
|
42
|
+
- Added support for JRuby 10.1 and TruffleRuby 34.0.
|
|
43
|
+
|
|
44
|
+
### Changed
|
|
45
|
+
|
|
46
|
+
- Retemplated project metadata and CI/development automation with `kettle-jem` v7.0.0.
|
|
47
|
+
|
|
48
|
+
### Fixed
|
|
49
|
+
|
|
50
|
+
- Folded the Dogfood RuboCop rules into the primary RuboCop config so normal
|
|
51
|
+
autocorrect owns generated-file style, and fixed license-check CI drift after
|
|
52
|
+
dependency updates.
|
|
53
|
+
- Added the Appraisal RuboCop formatter plugin to the templating bundle.
|
|
54
|
+
- Restored `docs/CNAME` so the generated documentation site keeps its custom domain.
|
|
55
|
+
- Corrected misspelled contact metadata to use `galtzo.com`.
|
|
56
|
+
|
|
57
|
+
## [2.0.5] - 2026-06-07
|
|
58
|
+
|
|
59
|
+
- TAG: [v2.0.5][2.0.5t]
|
|
60
|
+
- COVERAGE: 100.00% -- 19/19 lines in 4 files
|
|
61
|
+
- BRANCH COVERAGE: 0.00% -- 0/0 branches in 4 files
|
|
62
|
+
- 71.43% documented
|
|
63
|
+
|
|
64
|
+
### Fixed
|
|
65
|
+
|
|
66
|
+
- Disabled autocorrection for `Style/RedundantParentheses`, preventing invalid Ruby from grouped `and` / `or` method arguments.
|
|
67
|
+
|
|
13
68
|
## [2.0.4] 2026-06-01
|
|
69
|
+
|
|
14
70
|
### Added
|
|
71
|
+
|
|
15
72
|
### Changed
|
|
73
|
+
|
|
16
74
|
- Updated dependency floors:
|
|
17
75
|
- `standard` to `~> 1.54`, `>= 1.54.0`.
|
|
18
76
|
- `standard-performance` to `~> 1.9`, `>= 1.9.0`.
|
|
19
77
|
- `version_gem` to `~> 1.1`, `>= 1.1.9`.
|
|
20
78
|
- Release, lint, and test dependencies to their latest compatible floors.
|
|
21
79
|
- Corrected gem metadata to declare the Ruby 3.2 runtime floor that has been implicit since the last major release.
|
|
80
|
+
|
|
22
81
|
### Fixed
|
|
82
|
+
|
|
23
83
|
### Removed
|
|
24
84
|
|
|
25
85
|
## [2.0.3] 2026-06-01
|
|
86
|
+
|
|
26
87
|
### Added
|
|
88
|
+
|
|
27
89
|
### Changed
|
|
90
|
+
|
|
28
91
|
- Required `kettle-soup-cover` v1.1.3 for release specs.
|
|
92
|
+
|
|
29
93
|
### Fixed
|
|
94
|
+
|
|
30
95
|
### Removed
|
|
31
96
|
|
|
32
97
|
## [2.0.2] 2026-05-30
|
|
98
|
+
|
|
33
99
|
### Added
|
|
100
|
+
|
|
34
101
|
### Changed
|
|
102
|
+
|
|
35
103
|
- Updated release and documentation dependencies.
|
|
104
|
+
|
|
36
105
|
### Fixed
|
|
106
|
+
|
|
37
107
|
### Removed
|
|
108
|
+
|
|
38
109
|
- rubocop-shopify as a transitive dependency (removed from all rubocop-rubyN_N gems)
|
|
39
110
|
|
|
40
111
|
## [2.0.0] 2025-04-17
|
|
112
|
+
|
|
41
113
|
- COVERAGE: 100.00% -- 18/18 lines in 4 files
|
|
42
114
|
- BRANCH COVERAGE: 100.00% -- 0/0 branches in 4 files
|
|
43
115
|
- 100.00% documented
|
|
116
|
+
|
|
44
117
|
### Added
|
|
118
|
+
|
|
45
119
|
- `stone_checksums` v1.0.0 for release checksums
|
|
46
120
|
- Rules to prevent churn in bin/bundle
|
|
47
121
|
- Ability to package gem without signing (e.g. for linux distros)
|
|
122
|
+
|
|
48
123
|
### Changed
|
|
124
|
+
|
|
49
125
|
- RuboCop 1.72+ (new plugin system)
|
|
50
126
|
- Contributor Covenant v2.1
|
|
51
127
|
- Upgrade to version_gem v1.1.7
|
|
128
|
+
|
|
52
129
|
### Fixed
|
|
130
|
+
|
|
53
131
|
- (Better) Linting Support for Ruby 1.8, 1.9, 2.0
|
|
132
|
+
|
|
54
133
|
### Removed
|
|
134
|
+
|
|
55
135
|
- Runtime Support for Ruby 2.7, 3.0, 3.1
|
|
56
136
|
- Minimum runtime is Ruby 3.2
|
|
57
137
|
|
|
58
138
|
## [1.0.10] 2024-03-23
|
|
139
|
+
|
|
59
140
|
### Added
|
|
141
|
+
|
|
60
142
|
- Moved development dependencies back to gemspec
|
|
61
143
|
- See: https://github.com/rubygems/rubygems/discussions/5065#discussioncomment-7031586
|
|
62
144
|
- kettle-soup-cover v1.0.2 for Code Coverage (dev dependency)
|
|
63
145
|
- rspec-stubbed_env v1.0.1 for testing ENV variable-based logic (dev dependency)
|
|
146
|
+
|
|
64
147
|
### Changed
|
|
148
|
+
|
|
65
149
|
- Disable `Rake/MethodDefinitionInTask` Cop
|
|
66
150
|
- Cop is 66% incorrect, and hasn't been fixed in 2+ years.
|
|
67
151
|
- See: https://github.com/rubocop/rubocop-rake/issues/42
|
|
@@ -84,26 +168,36 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
84
168
|
- rubocop-md v1.2.2 (dev dependency)
|
|
85
169
|
- rubocop-rspec 2.27.1 (dev dependency)
|
|
86
170
|
- rubocop-shopify 2.15.1 (dev dependency)
|
|
171
|
+
|
|
87
172
|
### Fixed
|
|
173
|
+
|
|
88
174
|
- AllCops/TargetRubyVersion is now set according to:
|
|
89
175
|
- `rubocop-lts` version, or
|
|
90
176
|
- `rubocop-ruby*_*` version
|
|
91
177
|
|
|
92
178
|
## [1.0.9] 2023-09-20
|
|
179
|
+
|
|
93
180
|
### Changed
|
|
181
|
+
|
|
94
182
|
- standard v1.31.1
|
|
95
183
|
- standard-performance v1.2
|
|
96
184
|
- simplecov-rcov dev dependency back to mainline release 0.3.3
|
|
185
|
+
|
|
97
186
|
### Fixed
|
|
187
|
+
|
|
98
188
|
- `Gemspec/DevelopmentDependencies` Cop changed to "gemspec"
|
|
99
189
|
- See: https://github.com/rubygems/rubygems/discussions/5065#discussioncomment-7031586
|
|
100
190
|
|
|
101
191
|
## [1.0.8] 2023-07-07
|
|
192
|
+
|
|
102
193
|
### Fixed
|
|
194
|
+
|
|
103
195
|
- compatibility with changes from standard v1.30.1
|
|
104
196
|
|
|
105
197
|
## [1.0.7] 2023-06-08
|
|
198
|
+
|
|
106
199
|
### Changed
|
|
200
|
+
|
|
107
201
|
- follow best practices for gemspec
|
|
108
202
|
- put all dev dependencies in Gemfile
|
|
109
203
|
- See: https://github.com/rubygems/rubygems/discussions/5065
|
|
@@ -111,60 +205,95 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
111
205
|
- improve documentation
|
|
112
206
|
|
|
113
207
|
## [1.0.6] 2023-06-03
|
|
208
|
+
|
|
114
209
|
### Fixed
|
|
210
|
+
|
|
115
211
|
- ship internal configs with gem
|
|
116
212
|
|
|
117
213
|
## [1.0.5] 2023-06-03
|
|
214
|
+
|
|
118
215
|
### Fixed
|
|
216
|
+
|
|
119
217
|
- require deps for configs 1.9 - 3.3
|
|
120
218
|
|
|
121
219
|
## [1.0.4] 2023-06-03
|
|
220
|
+
|
|
122
221
|
### Fixed
|
|
222
|
+
|
|
123
223
|
- rubocop-shopify > standard gem family of rules
|
|
124
224
|
- v1.0.0 intended for rubocop-shopify to override standard's rules, now it actually does
|
|
125
225
|
- override mechanism in rubocop.yml config is counter-intuitive :(
|
|
126
226
|
- Stop doubly loading style libs and configs with more careful config structure
|
|
227
|
+
|
|
127
228
|
### Changed
|
|
229
|
+
|
|
128
230
|
- disable several rubocop-performance cops that are bad cops
|
|
129
231
|
|
|
130
232
|
## [1.0.3] 2023-05-29
|
|
233
|
+
|
|
131
234
|
### Added
|
|
235
|
+
|
|
132
236
|
- Gem releases are now signed!
|
|
237
|
+
|
|
133
238
|
### Fixed
|
|
239
|
+
|
|
134
240
|
- URIs in gemspec (now point to GitLab)
|
|
135
241
|
|
|
136
242
|
## [1.0.2] 2023-05-29
|
|
243
|
+
|
|
137
244
|
### Added
|
|
245
|
+
|
|
138
246
|
- `version_gem` for library version introspection
|
|
247
|
+
|
|
139
248
|
### Changed
|
|
249
|
+
|
|
140
250
|
- Set Style/SymbolArray to brackets for Ruby < 2.0 compat
|
|
141
251
|
- Previously only set for Ruby 1.8
|
|
142
252
|
- Set Style/WordArray to brackets for Ruby < 2.0 compat
|
|
143
253
|
- Previously only set for Ruby 1.8
|
|
144
254
|
- Disable Style/PercentLiteralDelimiters for Ruby < 2.0 compat
|
|
145
255
|
- `Standard::Rubocop::Lts::VERSION` refactored to `Standard::Rubocop::Lts::Version::VERSION`
|
|
256
|
+
|
|
146
257
|
### Fixed
|
|
258
|
+
|
|
147
259
|
- Removed obsolete loading of `standard-custom`'s now defunct `config/ruby-2.2.yml`
|
|
148
260
|
- See: https://github.com/standardrb/standard-custom/issues/2
|
|
261
|
+
|
|
149
262
|
### Removed
|
|
263
|
+
|
|
150
264
|
- Duplicated lines from `README.md`
|
|
151
265
|
- Circular dependency in gemspec (on `standard-rubocop-lts`, which is this gem)
|
|
152
266
|
|
|
153
267
|
## [1.0.2] 2023-05-29
|
|
268
|
+
|
|
154
269
|
### Changed
|
|
270
|
+
|
|
155
271
|
- Update to standard 1.28.4
|
|
156
272
|
|
|
157
273
|
## [1.0.1] 2023-04-16
|
|
274
|
+
|
|
158
275
|
### Fixed
|
|
276
|
+
|
|
159
277
|
- config/*.yml rubocop configs were not shipped with v1.0.0
|
|
278
|
+
|
|
160
279
|
### Changed
|
|
280
|
+
|
|
161
281
|
- Minimum Ruby Version is 2.7
|
|
162
282
|
|
|
163
283
|
## [1.0.0] 2023-04-16 [YANKED]
|
|
284
|
+
|
|
164
285
|
### Added
|
|
286
|
+
|
|
165
287
|
- Initial release
|
|
166
288
|
|
|
167
|
-
[Unreleased]: https://
|
|
289
|
+
[Unreleased]: https://github.com/rubocop-lts/standard-rubocop-lts/compare/v2.0.7...HEAD
|
|
290
|
+
[2.0.7]: https://github.com/rubocop-lts/standard-rubocop-lts/compare/v2.0.5...v2.0.7
|
|
291
|
+
[2.0.7t]: https://github.com/rubocop-lts/standard-rubocop-lts/releases/tag/v2.0.7
|
|
292
|
+
[2.0.5]: https://github.com/rubocop-lts/standard-rubocop-lts/compare/v2.0.4...v2.0.5
|
|
293
|
+
[2.0.5t]: https://github.com/rubocop-lts/standard-rubocop-lts/releases/tag/v2.0.5
|
|
294
|
+
[2.0.4]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/v2.0.3...v2.0.4
|
|
295
|
+
[2.0.3]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/v2.0.2...v2.0.3
|
|
296
|
+
[2.0.2]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/v2.0.0...v2.0.2
|
|
168
297
|
[1.0.11]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/v1.0.10...v1.0.11
|
|
169
298
|
[1.0.10]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/v1.0.9...v1.0.10
|
|
170
299
|
[1.0.9]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/v1.0.8...v1.0.9
|
|
@@ -176,7 +305,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
176
305
|
[1.0.3]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/v1.0.2...v1.0.3
|
|
177
306
|
[1.0.2]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/v1.0.1...v1.0.2
|
|
178
307
|
[1.0.1]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/v1.0.0...v1.0.1
|
|
179
|
-
[1.0.0]: https://
|
|
180
|
-
[2.0.3]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/v2.0.2...v2.0.3
|
|
181
|
-
[2.0.2]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/v2.0.0...v2.0.2
|
|
182
|
-
[2.0.4]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/v2.0.3...v2.0.4
|
|
308
|
+
[1.0.0]: https://github.com/rubocop-lts/standard-rubocop-lts/compare/0c0f82c0eeda184afb5c2c7a3d6b43c10f2d4c1c...v1.0.0
|
data/CITATION.cff
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
cff-version: 1.2.0
|
|
2
|
+
title: "standard-rubocop-lts"
|
|
3
|
+
message: >-
|
|
4
|
+
If you use this work and you want to cite it,
|
|
5
|
+
then you can use the metadata from this file.
|
|
6
|
+
type: software
|
|
7
|
+
authors:
|
|
8
|
+
- given-names: "Peter H."
|
|
9
|
+
family-names: "Boling"
|
|
10
|
+
email: "floss@galtzo.com"
|
|
11
|
+
affiliation: "galtzo.com"
|
|
12
|
+
orcid: 'https://orcid.org/0009-0008-8519-441X'
|
|
13
|
+
identifiers:
|
|
14
|
+
- type: url
|
|
15
|
+
value: 'https://github.com/rubocop-lts/standard-rubocop-lts'
|
|
16
|
+
description: "standard-rubocop-lts"
|
|
17
|
+
repository-code: 'https://github.com/rubocop-lts/standard-rubocop-lts'
|
|
18
|
+
abstract: >-
|
|
19
|
+
standard-rubocop-lts
|
|
20
|
+
license: See license file
|
data/CODE_OF_CONDUCT.md
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
|
|
2
1
|
# Contributor Covenant Code of Conduct
|
|
3
2
|
|
|
4
3
|
## Our Pledge
|
|
@@ -61,7 +60,7 @@ representative at an online or offline event.
|
|
|
61
60
|
|
|
62
61
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
63
62
|
reported to the community leaders responsible for enforcement at
|
|
64
|
-
[![Contact
|
|
63
|
+
[![Contact Maintainer][🚂maint-contact-img]][🚂maint-contact].
|
|
65
64
|
All complaints will be reviewed and investigated promptly and fairly.
|
|
66
65
|
|
|
67
66
|
All community leaders are obligated to respect the privacy and security of the
|
|
@@ -131,5 +130,5 @@ For answers to common questions about this code of conduct, see the FAQ at
|
|
|
131
130
|
[Mozilla CoC]: https://github.com/mozilla/diversity
|
|
132
131
|
[FAQ]: https://www.contributor-covenant.org/faq
|
|
133
132
|
[translations]: https://www.contributor-covenant.org/translations
|
|
134
|
-
[🚂
|
|
135
|
-
[🚂
|
|
133
|
+
[🚂maint-contact]: http://www.railsbling.com/contact
|
|
134
|
+
[🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
|
data/CONTRIBUTING.md
CHANGED
|
@@ -1,60 +1,195 @@
|
|
|
1
1
|
# Contributing
|
|
2
2
|
|
|
3
|
-
Bug reports and pull requests are welcome on GitLab
|
|
4
|
-
|
|
3
|
+
Bug reports and pull requests are welcome on [CodeBerg][📜src-cb], [GitLab][📜src-gl], or [GitHub][📜src-gh].
|
|
4
|
+
This project should be a safe, welcoming space for collaboration, so contributors agree to adhere to
|
|
5
5
|
the [code of conduct][🤝conduct].
|
|
6
6
|
|
|
7
|
-
To submit a patch, please fork the project
|
|
8
|
-
Once you're happy with it send a pull request.
|
|
7
|
+
To submit a patch, please fork the project, create a patch with tests, and send a pull request.
|
|
9
8
|
|
|
10
|
-
|
|
9
|
+
Remember to [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] if you make changes.
|
|
11
10
|
|
|
12
|
-
##
|
|
11
|
+
## Developer Certificate of Origin
|
|
13
12
|
|
|
14
|
-
|
|
13
|
+
In order to protect users of this project, we require all contributors to comply with the
|
|
14
|
+
[Developer Certificate of Origin](https://developercertificate.org/).
|
|
15
|
+
This ensures that all contributions are properly licensed and attributed.
|
|
15
16
|
|
|
16
|
-
|
|
17
|
+
## Help out!
|
|
17
18
|
|
|
18
|
-
|
|
19
|
-
2. Create your feature branch (`git checkout -b my-new-feature`)
|
|
20
|
-
3. Make some fixes.
|
|
21
|
-
4. Commit your changes (`git commit -am 'Added some feature'`)
|
|
22
|
-
5. Push to the branch (`git push origin my-new-feature`)
|
|
23
|
-
6. Make sure to add tests for it. This is important, so it doesn't break in a future release.
|
|
24
|
-
7. Create new Pull Request.
|
|
19
|
+
Take a look at the open issues and pull requests, or use the gem and find something to improve.
|
|
25
20
|
|
|
26
|
-
|
|
21
|
+
Follow these instructions:
|
|
27
22
|
|
|
28
|
-
|
|
23
|
+
1. Join the Discord: [![Live Chat on Discord][✉️discord-invite-img]][✉️discord-invite]
|
|
24
|
+
2. Fork the repository
|
|
25
|
+
3. Create your feature branch (`git checkout -b my-new-feature`)
|
|
26
|
+
4. Make some fixes.
|
|
27
|
+
5. Commit your changes (`git commit -am 'Added some feature'`)
|
|
28
|
+
6. Push to the branch (`git push origin my-new-feature`)
|
|
29
|
+
7. Make sure to add tests for it. This is important, so it doesn't break in a future release.
|
|
30
|
+
8. Create new Pull Request.
|
|
31
|
+
9. Announce it in the channel for this org in the [Discord][✉️discord-invite]!
|
|
29
32
|
|
|
30
|
-
|
|
33
|
+
## Executables vs Rake tasks
|
|
31
34
|
|
|
32
|
-
|
|
33
|
-
|
|
35
|
+
Executables shipped by dependencies, such as kettle-dev, and stone_checksums, are available
|
|
36
|
+
after running `bin/setup`. These include:
|
|
37
|
+
|
|
38
|
+
- gem_checksums
|
|
39
|
+
- kettle-changelog
|
|
40
|
+
- kettle-commit-msg
|
|
41
|
+
- kettle-dev-setup
|
|
42
|
+
- kettle-dvcs
|
|
43
|
+
- kettle-pre-release
|
|
44
|
+
- kettle-readme-backers
|
|
45
|
+
- kettle-release
|
|
46
|
+
|
|
47
|
+
There are many Rake tasks available as well. You can see them by running:
|
|
48
|
+
|
|
49
|
+
```shell
|
|
50
|
+
bin/rake -T
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## Code quality checks
|
|
54
|
+
|
|
55
|
+
Run the Reek task when you want a smell check that fails on current findings:
|
|
56
|
+
|
|
57
|
+
```shell
|
|
58
|
+
bin/rake reek
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Refresh the checked-in `REEK` backlog through the rake task, not by redirecting
|
|
62
|
+
the raw `reek` executable output. The rake task uses the project bundle and
|
|
63
|
+
avoids stale generated binstubs shadowing the Reek gem executable:
|
|
64
|
+
|
|
65
|
+
```shell
|
|
66
|
+
bin/rake reek:update
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## Environment Variables for Local Development
|
|
70
|
+
|
|
71
|
+
Below are the primary environment variables recognized by stone_checksums (and its integrated tools). Unless otherwise noted, set boolean values to the string "true" to enable.
|
|
72
|
+
|
|
73
|
+
General/runtime
|
|
74
|
+
- DEBUG: Enable extra internal logging for this library (default: false)
|
|
75
|
+
- REQUIRE_BENCH: Enable `require_bench` to profile requires (default: false)
|
|
76
|
+
- CI: When set to true, adjusts default rake tasks toward CI behavior
|
|
77
|
+
|
|
78
|
+
Coverage (kettle-soup-cover / SimpleCov)
|
|
79
|
+
- K_SOUP_COV_DO: Enable coverage collection (default: true in `mise.toml`)
|
|
80
|
+
- K_SOUP_COV_FORMATTERS: Comma-separated list of formatters (html, xml, rcov, lcov, json, tty)
|
|
81
|
+
- K_SOUP_COV_MIN_LINE: Minimum line coverage threshold (integer, e.g., 100)
|
|
82
|
+
- K_SOUP_COV_MIN_BRANCH: Minimum branch coverage threshold (integer, e.g., 100)
|
|
83
|
+
- K_SOUP_COV_MIN_HARD: Fail the run if thresholds are not met (true/false)
|
|
84
|
+
- K_SOUP_COV_MULTI_FORMATTERS: Enable multiple formatters at once (true/false)
|
|
85
|
+
- K_SOUP_COV_OPEN_BIN: Path to browser opener for HTML (empty disables auto-open)
|
|
86
|
+
- MAX_ROWS: Limit console output rows for simplecov-console (e.g., 1)
|
|
87
|
+
Tip: When running a single spec file locally, you may want `K_SOUP_COV_MIN_HARD=false` to avoid failing thresholds for a partial run.
|
|
88
|
+
|
|
89
|
+
GitHub API and CI helpers
|
|
90
|
+
- GITHUB_TOKEN or GH_TOKEN: Token used by `ci:act` and release workflow checks to query GitHub Actions status at higher rate limits
|
|
91
|
+
|
|
92
|
+
Releasing and signing
|
|
93
|
+
- SKIP_GEM_SIGNING: If set, skip gem signing during build/release
|
|
94
|
+
- GEM_CERT_USER: Username for selecting your public cert in `certs/<USER>.pem` (defaults to $USER)
|
|
95
|
+
- SOURCE_DATE_EPOCH: Reproducible build timestamp.
|
|
96
|
+
- `kettle-release` will set this automatically for the session.
|
|
97
|
+
- Not needed on bundler >= 2.7.0, as reproducible builds have become the default.
|
|
98
|
+
|
|
99
|
+
Git hooks and commit message helpers (exe/kettle-commit-msg)
|
|
100
|
+
- GIT_HOOK_BRANCH_VALIDATE: Branch name validation mode (e.g., `jira`) or `false` to disable
|
|
101
|
+
- GIT_HOOK_FOOTER_APPEND: Append a footer to commit messages when goalie allows (true/false)
|
|
102
|
+
- GIT_HOOK_FOOTER_SENTINEL: Required when footer append is enabled — a unique first-line sentinel to prevent duplicates
|
|
103
|
+
- GIT_HOOK_FOOTER_APPEND_DEBUG: Extra debug output in the footer template (true/false)
|
|
104
|
+
|
|
105
|
+
Git diff driver setup
|
|
106
|
+
- Local setup writes repository `.gitattributes` entries and local Git `diff.smorg-*` command config so this checkout uses StructuredMerge semantic diffs.
|
|
107
|
+
- Global setup registers `diff.smorg-*` commands once in the user Git config; use it when you work across several StructuredMerge-enabled repositories.
|
|
108
|
+
- Include-file setup writes `.git/smorg/config` and includes it from local Git config, keeping command registrations out of the repository files.
|
|
109
|
+
- Git hosting forges generally ignore external diff drivers, so pull request views may still show raw textual diffs even when local `git diff` uses semantic drivers.
|
|
110
|
+
|
|
111
|
+
```console
|
|
112
|
+
K_JEM_TEMPLATING=true kettle-jem install
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
Troubleshooting Git diffs
|
|
116
|
+
- Use `git diff --no-ext-diff` to compare against Git's built-in diff output.
|
|
117
|
+
- Use `git diff --no-textconv` when a textconv projection obscures the raw file bytes you need to inspect.
|
|
118
|
+
- If Git reports a missing `smorg-*` executable, rerun `bundle install` and the setup command above, then check `git config --local --get-regexp '^diff\.smorg-'`.
|
|
119
|
+
- To remove managed local entries, run `K_JEM_TEMPLATING=true kettle-jem install --undo`; remove global command registrations with `git config --global --unset-all diff.smorg-ruby.command`.
|
|
120
|
+
|
|
121
|
+
For a quick starting point, this repository’s `mise.toml` defines the shared defaults, and `.env.local` can override them locally. Copy `.env.local.example` to `.env.local`, use `KEY=value` lines, and either activate `mise` in your shell or run commands through `mise exec -C /path/to/project -- ...`.
|
|
122
|
+
|
|
123
|
+
## Appraisals
|
|
124
|
+
|
|
125
|
+
From time to time the [appraisal2][🚎appraisal2] gemfiles in `gemfiles/` will need to be updated.
|
|
126
|
+
Generated appraisal and CI workflow floors are controlled by `ruby.test_minimum`
|
|
127
|
+
in `.structuredmerge/kettle-jem.yml`; this project was templated with `ruby.test_minimum: 3.2.0`.
|
|
128
|
+
That value describes the lowest Ruby version expected to run the test/development
|
|
129
|
+
toolchain, and it may be higher than the gemspec runtime floor.
|
|
130
|
+
|
|
131
|
+
They are created and updated with the commands:
|
|
132
|
+
|
|
133
|
+
```console
|
|
134
|
+
bin/rake appraisal:update
|
|
34
135
|
```
|
|
35
136
|
|
|
137
|
+
If you need to reset all gemfiles/*.gemfile.lock files:
|
|
138
|
+
|
|
139
|
+
```console
|
|
140
|
+
bin/rake appraisal:reset
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
When adding an appraisal to CI, check the [runner tool cache][🏃♂️runner-tool-cache] to see which runner to use.
|
|
144
|
+
|
|
36
145
|
## Run Tests
|
|
37
146
|
|
|
38
|
-
|
|
147
|
+
Run tests via `kettle-test` (provided by `kettle-test`). It runs RSpec, writes the full log to
|
|
148
|
+
`tmp/kettle-test/rspec-TIMESTAMP.log`, and prints a compact highlight block with timing, seed,
|
|
149
|
+
pass/fail count, failing example list, and SimpleCov coverage percentages.
|
|
150
|
+
|
|
151
|
+
```console
|
|
152
|
+
bundle exec kettle-test
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
For targeted runs, disable the hard coverage threshold to avoid false failures:
|
|
39
156
|
|
|
40
|
-
```
|
|
41
|
-
bundle exec
|
|
157
|
+
```console
|
|
158
|
+
K_SOUP_COV_MIN_HARD=false bundle exec kettle-test spec/path/to/spec.rb
|
|
42
159
|
```
|
|
43
160
|
|
|
161
|
+
### Spec organization (required)
|
|
162
|
+
|
|
163
|
+
- One spec file per class/module. For each class or module under `lib/`, keep all of its unit tests in a single spec file under `spec/` that mirrors the path and file name exactly: `lib/standard/rubocop/lts/my_class.rb` -> `spec/standard/rubocop/lts/my_class_spec.rb`.
|
|
164
|
+
- Exception: Integration specs that intentionally span multiple classes. Place these under `spec/integration/` (or a clearly named integration folder), and do not directly mirror a single class. Name them after the scenario, not a class.
|
|
165
|
+
|
|
44
166
|
## Lint It
|
|
45
167
|
|
|
46
168
|
Run all the default tasks, which includes running the gradually autocorrecting linter, `rubocop-gradual`.
|
|
47
169
|
|
|
48
|
-
```
|
|
170
|
+
```console
|
|
49
171
|
bundle exec rake
|
|
50
172
|
```
|
|
51
173
|
|
|
52
174
|
Or just run the linter.
|
|
53
175
|
|
|
54
|
-
```
|
|
176
|
+
```console
|
|
55
177
|
bundle exec rake rubocop_gradual:autocorrect
|
|
56
178
|
```
|
|
57
179
|
|
|
180
|
+
For more detailed information about using RuboCop in this project, please see the [RUBOCOP.md](RUBOCOP.md) guide. This project uses `rubocop_gradual` instead of vanilla RuboCop, which requires specific commands for checking violations.
|
|
181
|
+
|
|
182
|
+
### Important: Do not add inline RuboCop disables
|
|
183
|
+
|
|
184
|
+
Never add `# rubocop:disable ...` / `# rubocop:enable ...` comments to code or specs (except when following the few existing `rubocop:disable` patterns for a rule already being disabled elsewhere in the code). Instead:
|
|
185
|
+
|
|
186
|
+
- Prefer configuration-based exclusions when a rule should not apply to certain paths or files (e.g., via `.rubocop.yml`).
|
|
187
|
+
- When a violation is temporary, and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
|
|
188
|
+
- `bundle exec rake rubocop_gradual:autocorrect` (preferred)
|
|
189
|
+
- `bundle exec rake rubocop_gradual:force_update` (only when you cannot fix the violations immediately)
|
|
190
|
+
|
|
191
|
+
As a general rule, fix style issues rather than ignoring them. For example, our specs should follow RSpec conventions like using `described_class` for the class under test.
|
|
192
|
+
|
|
58
193
|
## Contributors
|
|
59
194
|
|
|
60
195
|
Your picture could be here!
|
|
@@ -69,49 +204,69 @@ Also see GitLab Contributors: [https://gitlab.com/rubocop-lts/standard-rubocop-l
|
|
|
69
204
|
|
|
70
205
|
### One-time, Per-maintainer, Setup
|
|
71
206
|
|
|
72
|
-
**IMPORTANT**:
|
|
73
|
-
|
|
207
|
+
**IMPORTANT**: To sign a build,
|
|
208
|
+
a public key for signing gems will need to be picked up by the line in the
|
|
74
209
|
`gemspec` defining the `spec.cert_chain` (check the relevant ENV variables there).
|
|
75
|
-
All releases
|
|
210
|
+
All releases are signed releases.
|
|
76
211
|
See: [RubyGems Security Guide][🔒️rubygems-security-guide]
|
|
77
212
|
|
|
78
|
-
NOTE: To build without signing the gem
|
|
213
|
+
NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in the environment.
|
|
79
214
|
|
|
80
215
|
### To release a new version:
|
|
81
216
|
|
|
82
|
-
|
|
217
|
+
#### Automated process
|
|
218
|
+
|
|
219
|
+
1. Update version.rb to contain the correct version-to-be-released.
|
|
220
|
+
2. Run `bundle exec kettle-changelog`.
|
|
221
|
+
3. Run `bundle exec kettle-release`.
|
|
222
|
+
4. Stay awake and monitor the release process for any errors, and answer any prompts.
|
|
223
|
+
|
|
224
|
+
#### Manual process
|
|
225
|
+
|
|
226
|
+
1. Run `bin/setup && bin/rake` as a "test, coverage, & linting" sanity check
|
|
83
227
|
2. Update the version number in `version.rb`, and ensure `CHANGELOG.md` reflects changes
|
|
84
228
|
3. Run `bin/setup && bin/rake` again as a secondary check, and to update `Gemfile.lock`
|
|
85
|
-
4. Run `
|
|
86
|
-
5. Run `git
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
7. Run `git
|
|
90
|
-
8. Run `git
|
|
91
|
-
9.
|
|
229
|
+
4. Run `bin/rake yard` to regenerate the docs site using the canonical docs task
|
|
230
|
+
5. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
|
|
231
|
+
6. Run `git push` to trigger the final CI pipeline before release, and merge PRs
|
|
232
|
+
- NOTE: Remember to [check the build][🧪build].
|
|
233
|
+
7. Run `export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME`
|
|
234
|
+
8. Run `git checkout $GIT_TRUNK_BRANCH_NAME`
|
|
235
|
+
9. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure latest trunk code
|
|
236
|
+
10. Optional for older Bundler (< 2.7.0): Set `SOURCE_DATE_EPOCH` so `rake build` and `rake release` use the same timestamp and generate the same checksums
|
|
237
|
+
- If your Bundler is >= 2.7.0, you can skip this; builds are reproducible by default.
|
|
92
238
|
- Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH`
|
|
93
239
|
- If the echo above has no output, then it didn't work.
|
|
94
|
-
- Note
|
|
240
|
+
- Note: `zsh/datetime` module is needed, if running `zsh`.
|
|
95
241
|
- In older versions of `bash` you can use `date +%s` instead, i.e. `export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH`
|
|
96
|
-
|
|
97
|
-
|
|
242
|
+
11. Run `bundle exec rake build`
|
|
243
|
+
12. Run `bin/gem_checksums` (more context [1][🔒️rubygems-checksums-pr], [2][🔒️rubygems-guides-pr])
|
|
98
244
|
to create SHA-256 and SHA-512 checksums. This functionality is provided by the `stone_checksums`
|
|
99
245
|
[gem][💎stone_checksums].
|
|
100
|
-
-
|
|
101
|
-
|
|
102
|
-
|
|
246
|
+
- The script automatically commits but does not push the checksums
|
|
247
|
+
13. Sanity check the SHA256, comparing with the output from the `bin/gem_checksums` command:
|
|
248
|
+
- `sha256sum pkg/<gem name>-<version>.gem`
|
|
249
|
+
14. Run `bundle exec rake release` which will create a git tag for the version,
|
|
250
|
+
push git commits and tags, and push the `.gem` file to the gem host configured in the gemspec.
|
|
103
251
|
|
|
104
|
-
[
|
|
252
|
+
[📜src-gl]: https://gitlab.com/rubocop-lts/standard-rubocop-lts
|
|
253
|
+
[📜src-cb]: https://codeberg.org/rubocop-lts/standard-rubocop-lts
|
|
254
|
+
[📜src-gh]: https://github.com/rubocop-lts/standard-rubocop-lts
|
|
105
255
|
[🧪build]: https://github.com/rubocop-lts/standard-rubocop-lts/actions
|
|
106
|
-
[🤝conduct]: https://
|
|
256
|
+
[🤝conduct]: https://github.com/rubocop-lts/standard-rubocop-lts/blob/main/CODE_OF_CONDUCT.md
|
|
107
257
|
[🖐contrib-rocks]: https://contrib.rocks
|
|
108
258
|
[🖐contributors]: https://github.com/rubocop-lts/standard-rubocop-lts/graphs/contributors
|
|
109
259
|
[🚎contributors-gl]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/graphs/main
|
|
110
260
|
[🖐contributors-img]: https://contrib.rocks/image?repo=rubocop-lts/standard-rubocop-lts
|
|
111
|
-
[💎
|
|
261
|
+
[💎gem-coop]: https://gem.coop
|
|
112
262
|
[🔒️rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
|
|
113
263
|
[🔒️rubygems-checksums-pr]: https://github.com/rubygems/rubygems/pull/6022
|
|
114
264
|
[🔒️rubygems-guides-pr]: https://github.com/rubygems/guides/pull/325
|
|
115
|
-
[💎stone_checksums]: https://github.com/
|
|
265
|
+
[💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
|
|
116
266
|
[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
|
|
117
267
|
[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
|
|
268
|
+
[📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
|
|
269
|
+
[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
|
|
270
|
+
[🚎appraisal2]: https://github.com/appraisal-rb/appraisal2
|
|
271
|
+
[🏃♂️runner-tool-cache]: https://github.com/ruby/ruby-builder/releases/tag/toolcache
|
|
272
|
+
[✉️discord-invite]: https://discord.gg/3qme4XHNKN
|