rubocop-lts 2.3.1 → 3.0.0

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 359ddf30210d69955f7435aa845c6fb7b3886387c4b6b10511370274513ab3ee
4
- data.tar.gz: 536b1f567f0078d1840542083afb5e35507593973b3ad028c08667704cb6025c
3
+ metadata.gz: 6267933ed70ced700270b5690d8d2042a0a5773ad9b014ad04d4661801af1365
4
+ data.tar.gz: b45171da57d07c4bc87f05d2e45e1ddc5e697b1ae2bd5134bb771ea26684edd1
5
5
  SHA512:
6
- metadata.gz: d5c846760e61b605b1ed33efbe184f71c5b30a3d5ec577fb35b11d857a9952a7ad65bb5372e8d28f7d5cb3c1c921da9fcf6c110e8f246c7ca3cf7495b992e983
7
- data.tar.gz: 1ef26441c000524f27f55645ac6763363867e075e5c044233ec63e9f18730175d35098de44513f534ae51242b3ccc9a047ae57d213edf170130f7756e0a97710
6
+ metadata.gz: '0285b68f9f647a682e8bd34e666bb31a15374ab1a5422db9c5a743d299c807b91732519df25b5a1eac3c2473458aa2db5e9d9c3a14330d62d3749a91f6bb902a'
7
+ data.tar.gz: cc2b087c81a5a7008e09c81614f65e1eac2facd095902687e536098c47ac8c1d12055f991b94e4188734922f220f6af84be7c97c6c150867ac2cd314a4be70bb
data/CHANGELOG.md CHANGED
@@ -1,151 +1,41 @@
1
1
  # Changelog
2
-
3
- [![SemVer 2.0.0][📌semver-img]][📌semver] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog]
4
-
5
2
  All notable changes to this project will be documented in this file.
6
3
 
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
4
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
18
6
 
19
7
  ## [Unreleased]
20
-
21
- ### Added
22
-
23
- ### Changed
24
-
25
- ### Deprecated
26
-
27
- ### Removed
28
-
29
- ### Fixed
30
-
31
- ### Security
32
-
33
- ## [2.3.1] - 2026-06-28
34
-
35
- - TAG: [v2.3.1][2.3.1t]
36
- - COVERAGE: 100.00% -- 15/15 lines in 2 files
37
- - BRANCH COVERAGE: 0.00% -- 0/0 branches in 2 files
38
- - 14.29% documented
39
-
40
- ### Added
41
-
42
- - Added support for JRuby 10.1 and TruffleRuby 34.0.
43
-
44
- ### Fixed
45
-
46
- - Restored the destination `spec.files` package declaration so the built gem
47
- includes its `config/*.yml` RuboCop configuration files.
48
-
49
- ## [2.3.0] - 2026-06-01
50
-
51
- ### Added
52
-
53
- ### Changed
54
-
55
- - Updated dependency floors to the latest RuboCop-LTS family releases.
56
- - Raised the minimum supported Ruby version to 3.2.
57
-
58
- ### Fixed
59
-
60
- - Added the missing previous release entry to the changelog.
61
-
62
- ### Removed
63
-
64
- - Removed support for running this gem on Ruby < 3.2.
65
-
66
- ## [2.2.0] - 2026-05-30
67
-
68
8
  ### Added
69
9
 
70
10
  ### Changed
71
11
 
72
- - Updated the `standard-rubocop-lts` dependency floor to `2.0.0`.
73
-
74
12
  ### Fixed
75
13
 
76
14
  ### Removed
77
15
 
78
- - Removed remaining `rubocop-shopify` usage from the active development toolchain.
79
-
80
- ## [2.1.1] - 2023-05-30
81
-
82
- ### Added
83
-
84
- - `config/base.yml` for all shared configs
85
- - `Rubocop::Lts.install_tasks` to roll-up rake tasks from dependencies (e.g. rubocop_gradual)
86
-
87
- ## [2.1.0] - 2023-05-20
88
-
89
- ### Changed
90
-
91
- - Broadened scope of gem, updated `rubocop-ruby*_*` which configures many linting tools via `standard-rubocop-lts`
92
-
93
- ### Removed
94
-
95
- - Install support for Ruby < 2.7 (minimum is now 2.7, analysis of older Ruby still supported)
96
- - rubocop-lts1_8.yml - Use the new dedicated gem `rubocop-ruby1_8` instead
97
-
98
- ## [2.0.5] - 2022-06-08
99
-
16
+ ## [3.0.0] - 2022-05-22
100
17
  ### Added
101
-
102
- - Improve, and dry up documentation
103
-
104
- ## [2.0.4] - 2022-06-08
105
-
106
- ### Fixed
107
-
108
- - Allow install up to Ruby < 4, which allows running against current Ruby HEAD @ 3.2-dev
109
-
110
- ## [2.0.3] - 2022-05-23
111
-
112
- ### Fixed
113
-
114
- - Make rubocop config files load ruby specific config from relevant `rubocop-ruby*_*` gem
115
-
116
- ## [2.0.2] - 2022-05-23
117
-
118
- ### Fixed
119
-
120
- - Ship rubocop config files in gem
121
- - rubocop-lts.yml
122
- - rubocop-lts1_8.yml
18
+ - Initial odd release supporting Ruby ~> 2.0
123
19
 
124
20
  ## [2.0.1] - 2022-05-22
125
-
126
21
  ### Fixed
127
-
128
22
  - Documentation typos & gemspec URLs
129
23
 
130
24
  ## [2.0.0] - 2022-05-22
25
+ ### Added
26
+ - Initial even release supporting Ruby >= 1.9
131
27
 
132
- - TAG: [v2.0.0][2.0.0t]
28
+ ## [1.0.1] - 2022-05-22
29
+ ### Fixed
30
+ - Documentation typos & gemspec URLs
133
31
 
32
+ ## [1.0.0] - 2022-05-22
134
33
  ### Added
34
+ - Initial odd release supporting Ruby ~> 1.9
135
35
 
136
- - Initial even release supporting Ruby >= 1.9
137
-
138
- [Unreleased]: https://github.com/rubocop-lts/rubocop-lts/compare/v2.3.1...HEAD
139
- [2.3.1]: https://github.com/rubocop-lts/rubocop-lts/compare/v2.3.0...v2.3.1
140
- [2.3.1t]: https://github.com/rubocop-lts/rubocop-lts/releases/tag/v2.3.1
141
- [2.3.0]: https://gitlab.com/rubocop-lts/rubocop-lts/-/compare/v2.2.0...v2.3.0
142
- [2.2.0]: https://gitlab.com/rubocop-lts/rubocop-lts/-/compare/v2.1.1...v2.2.0
143
- [2.1.1]: https://github.com/rubocop-lts/rubocop-lts/compare/v2.1.0...v2.1.1
144
- [2.1.0]: https://github.com/rubocop-lts/rubocop-lts/compare/v2.0.5...v2.1.0
145
- [2.0.5]: https://github.com/rubocop-lts/rubocop-lts/compare/v2.0.4...v2.0.5
146
- [2.0.4]: https://github.com/rubocop-lts/rubocop-lts/compare/v2.0.3...v2.0.4
147
- [2.0.3]: https://github.com/rubocop-lts/rubocop-lts/compare/v2.0.2...v2.0.3
148
- [2.0.2]: https://github.com/rubocop-lts/rubocop-lts/compare/v2.0.1...v2.0.2
36
+ [Unreleased]: https://github.com/rubocop-lts/rubocop-lts/compare/v3.0.0...HEAD
37
+ [3.0.0]: https://github.com/rubocop-lts/rubocop-lts/compare/v2.0.1...v3.0.0
149
38
  [2.0.1]: https://github.com/rubocop-lts/rubocop-lts/compare/v2.0.0...v2.0.1
150
- [2.0.0]: https://github.com/rubocop-lts/rubocop-lts/releases/tag/v2.0.0
151
- [2.0.0t]: https://github.com/rubocop-lts/rubocop-lts/releases/tag/v2.0.0
39
+ [2.0.0]: https://github.com/rubocop-lts/rubocop-lts/compare/v1.0.1...v2.0.0
40
+ [1.0.1]: https://github.com/rubocop-lts/rubocop-lts/compare/v1.0.0...v1.0.1
41
+ [1.0.0]: https://github.com/rubocop-lts/rubocop-lts/compare/f0fcf8e7dbb4d884a01c7191e7f26ef8bf3b22af...v1.0.0
data/CODE_OF_CONDUCT.md CHANGED
@@ -2,133 +2,83 @@
2
2
 
3
3
  ## Our Pledge
4
4
 
5
- We as members, contributors, and leaders pledge to make participation in our
6
- community a harassment-free experience for everyone, regardless of age, body
7
- size, visible or invisible disability, ethnicity, sex characteristics, gender
8
- identity and expression, level of experience, education, socio-economic status,
9
- nationality, personal appearance, race, caste, color, religion, or sexual
10
- identity and orientation.
5
+ We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
11
6
 
12
- We pledge to act and interact in ways that contribute to an open, welcoming,
13
- diverse, inclusive, and healthy community.
7
+ We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
14
8
 
15
9
  ## Our Standards
16
10
 
17
- Examples of behavior that contributes to a positive environment for our
18
- community include:
11
+ Examples of behavior that contributes to a positive environment for our community include:
19
12
 
20
13
  * Demonstrating empathy and kindness toward other people
21
14
  * Being respectful of differing opinions, viewpoints, and experiences
22
15
  * Giving and gracefully accepting constructive feedback
23
- * Accepting responsibility and apologizing to those affected by our mistakes,
24
- and learning from the experience
25
- * Focusing on what is best not just for us as individuals, but for the overall
26
- community
16
+ * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17
+ * Focusing on what is best not just for us as individuals, but for the overall community
27
18
 
28
19
  Examples of unacceptable behavior include:
29
20
 
30
- * The use of sexualized language or imagery, and sexual attention or advances of
31
- any kind
21
+ * The use of sexualized language or imagery, and sexual attention or
22
+ advances of any kind
32
23
  * Trolling, insulting or derogatory comments, and personal or political attacks
33
24
  * Public or private harassment
34
- * Publishing others' private information, such as a physical or email address,
35
- without their explicit permission
25
+ * Publishing others' private information, such as a physical or email
26
+ address, without their explicit permission
36
27
  * Other conduct which could reasonably be considered inappropriate in a
37
28
  professional setting
38
29
 
39
30
  ## Enforcement Responsibilities
40
31
 
41
- Community leaders are responsible for clarifying and enforcing our standards of
42
- acceptable behavior and will take appropriate and fair corrective action in
43
- response to any behavior that they deem inappropriate, threatening, offensive,
44
- or harmful.
32
+ Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
45
33
 
46
- Community leaders have the right and responsibility to remove, edit, or reject
47
- comments, commits, code, wiki edits, issues, and other contributions that are
48
- not aligned to this Code of Conduct, and will communicate reasons for moderation
49
- decisions when appropriate.
34
+ Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
50
35
 
51
36
  ## Scope
52
37
 
53
- This Code of Conduct applies within all community spaces, and also applies when
54
- an individual is officially representing the community in public spaces.
55
- Examples of representing our community include using an official email address,
56
- posting via an official social media account, or acting as an appointed
57
- representative at an online or offline event.
38
+ This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
58
39
 
59
40
  ## Enforcement
60
41
 
61
- Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
- reported to the community leaders responsible for enforcement at
63
- [![Contact Maintainer][🚂maint-contact-img]][🚂maint-contact].
64
- All complaints will be reviewed and investigated promptly and fairly.
42
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at peter.boling@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
65
43
 
66
- All community leaders are obligated to respect the privacy and security of the
67
- reporter of any incident.
44
+ All community leaders are obligated to respect the privacy and security of the reporter of any incident.
68
45
 
69
46
  ## Enforcement Guidelines
70
47
 
71
- Community leaders will follow these Community Impact Guidelines in determining
72
- the consequences for any action they deem in violation of this Code of Conduct:
48
+ Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
73
49
 
74
50
  ### 1. Correction
75
51
 
76
- **Community Impact**: Use of inappropriate language or other behavior deemed
77
- unprofessional or unwelcome in the community.
52
+ **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
78
53
 
79
- **Consequence**: A private, written warning from community leaders, providing
80
- clarity around the nature of the violation and an explanation of why the
81
- behavior was inappropriate. A public apology may be requested.
54
+ **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
82
55
 
83
56
  ### 2. Warning
84
57
 
85
- **Community Impact**: A violation through a single incident or series of
86
- actions.
58
+ **Community Impact**: A violation through a single incident or series of actions.
87
59
 
88
- **Consequence**: A warning with consequences for continued behavior. No
89
- interaction with the people involved, including unsolicited interaction with
90
- those enforcing the Code of Conduct, for a specified period of time. This
91
- includes avoiding interactions in community spaces as well as external channels
92
- like social media. Violating these terms may lead to a temporary or permanent
93
- ban.
60
+ **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
94
61
 
95
62
  ### 3. Temporary Ban
96
63
 
97
- **Community Impact**: A serious violation of community standards, including
98
- sustained inappropriate behavior.
64
+ **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
99
65
 
100
- **Consequence**: A temporary ban from any sort of interaction or public
101
- communication with the community for a specified period of time. No public or
102
- private interaction with the people involved, including unsolicited interaction
103
- with those enforcing the Code of Conduct, is allowed during this period.
104
- Violating these terms may lead to a permanent ban.
66
+ **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
105
67
 
106
68
  ### 4. Permanent Ban
107
69
 
108
- **Community Impact**: Demonstrating a pattern of violation of community
109
- standards, including sustained inappropriate behavior, harassment of an
110
- individual, or aggression toward or disparagement of classes of individuals.
70
+ **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
111
71
 
112
- **Consequence**: A permanent ban from any sort of public interaction within the
113
- community.
72
+ **Consequence**: A permanent ban from any sort of public interaction within the community.
114
73
 
115
74
  ## Attribution
116
75
 
117
- This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118
- version 2.1, available at
119
- [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
76
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
77
+ available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120
78
 
121
- Community Impact Guidelines were inspired by
122
- [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123
-
124
- For answers to common questions about this code of conduct, see the FAQ at
125
- [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126
- [https://www.contributor-covenant.org/translations][translations].
79
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
127
80
 
128
81
  [homepage]: https://www.contributor-covenant.org
129
- [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130
- [Mozilla CoC]: https://github.com/mozilla/diversity
131
- [FAQ]: https://www.contributor-covenant.org/faq
132
- [translations]: https://www.contributor-covenant.org/translations
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
82
+
83
+ For answers to common questions about this code of conduct, see the FAQ at
84
+ https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
data/CONTRIBUTING.md CHANGED
@@ -1,275 +1,25 @@
1
- # Contributing
1
+ ## Contributing
2
2
 
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
- the [code of conduct][🤝conduct].
3
+ Bug reports and pull requests are welcome on GitHub at [https://github.com/rubocop-lts/rubocop-lts][source]
4
+ . This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
5
+ the [code of conduct][conduct].
6
6
 
7
- To submit a patch, please fork the project, create a patch with tests, and send a pull request.
8
-
9
- Remember to [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] if you make changes.
10
-
11
- ## Developer Certificate of Origin
12
-
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.
16
-
17
- ## Help out!
18
-
19
- Take a look at the open issues and pull requests, or use the gem and find something to improve.
20
-
21
- Follow these instructions:
22
-
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]!
32
-
33
- ## Executables vs Rake tasks
34
-
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`.
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:generate
135
- ```
136
-
137
- Use `bin/rake appraisal:update` when you intentionally need to resolve fresh
138
- appraisal locks.
139
-
140
- If you need to reset all gemfiles/*.gemfile.lock files:
141
-
142
- ```console
143
- bin/rake appraisal:reset
144
- ```
145
-
146
- When adding an appraisal to CI, check the [runner tool cache][🏃‍♂️runner-tool-cache] to see which runner to use.
147
-
148
- ## Run Tests
149
-
150
- Run tests via `kettle-test` (provided by `kettle-test`). It runs RSpec, writes the full log to
151
- `tmp/kettle-test/rspec-TIMESTAMP.log`, and prints a compact highlight block with timing, seed,
152
- pass/fail count, failing example list, and SimpleCov coverage percentages.
153
-
154
- ```console
155
- bundle exec kettle-test
156
- ```
157
-
158
- For targeted runs, disable the hard coverage threshold to avoid false failures:
159
-
160
- ```console
161
- K_SOUP_COV_MIN_HARD=false bundle exec kettle-test spec/path/to/spec.rb
162
- ```
163
-
164
- ### Spec organization (required)
165
-
166
- - 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/rubocop/lts/my_class.rb` -> `spec/rubocop/lts/my_class_spec.rb`.
167
- - 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.
168
-
169
- ## Lint It
170
-
171
- Run all the default tasks, which includes running the gradually autocorrecting linter, `rubocop-gradual`.
172
-
173
- ```console
174
- bundle exec rake
175
- ```
176
-
177
- Or just run the linter.
178
-
179
- ```console
180
- bundle exec rake rubocop_gradual:autocorrect
181
- ```
182
-
183
- 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.
184
-
185
- ### Important: Do not add inline RuboCop disables
186
-
187
- 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:
188
-
189
- - Prefer configuration-based exclusions when a rule should not apply to certain paths or files (e.g., via `.rubocop.yml`).
190
- - When a violation is temporary, and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
191
- - `bundle exec rake rubocop_gradual:autocorrect` (preferred)
192
- - `bundle exec rake rubocop_gradual:force_update` (only when you cannot fix the violations immediately)
193
-
194
- 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.
7
+ To submit a patch, please fork the project and create a patch with tests. Once you're happy with it send a pull request!
195
8
 
196
9
  ## Contributors
197
10
 
198
- Your picture could be here!
199
-
200
- [![Contributors][🖐contributors-img]][🖐contributors]
201
-
202
- Made with [contributors-img][🖐contrib-rocks].
203
-
204
- Also see GitLab Contributors: [https://gitlab.com/rubocop-lts/rubocop-lts/-/graphs/main][🚎contributors-gl]
205
-
206
- ## For Maintainers
207
-
208
- ### One-time, Per-maintainer, Setup
209
-
210
- **IMPORTANT**: To sign a build,
211
- a public key for signing gems will need to be picked up by the line in the
212
- `gemspec` defining the `spec.cert_chain` (check the relevant ENV variables there).
213
- All releases are signed releases.
214
- See: [RubyGems Security Guide][🔒️rubygems-security-guide]
11
+ [![Contributors](https://contrib.rocks/image?repo=rubocop-lts/rubocop-lts)][contributors]
215
12
 
216
- NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in the environment.
13
+ Made with [contributors-img][contrib-rocks].
217
14
 
218
- ### To release a new version:
15
+ [comment]: <> (Following links are used by README, CONTRIBUTING)
219
16
 
220
- #### Automated process
17
+ [conduct]: https://github.com/rubocop-lts/rubocop-lts/blob/main/CODE_OF_CONDUCT.md
221
18
 
222
- 1. Update version.rb to contain the correct version-to-be-released.
223
- 2. Run `bundle exec kettle-changelog`.
224
- 3. Run `bundle exec kettle-release`.
225
- 4. Stay awake and monitor the release process for any errors, and answer any prompts.
19
+ [contrib-rocks]: https://contrib.rocks
226
20
 
227
- #### Manual process
21
+ [contributors]: https://github.com/rubocop-lts/rubocop-lts/graphs/contributors
228
22
 
229
- 1. Run `bin/setup && bin/rake` as a "test, coverage, & linting" sanity check
230
- 2. Update the version number in `version.rb`, and ensure `CHANGELOG.md` reflects changes
231
- 3. Run `bin/setup && bin/rake` again as a secondary check, and to update `Gemfile.lock`
232
- 4. Run `bin/rake yard` to regenerate the docs site using the canonical docs task
233
- 5. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
234
- 6. Run `git push` to trigger the final CI pipeline before release, and merge PRs
235
- - NOTE: Remember to [check the build][🧪build].
236
- 7. Run `export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME`
237
- 8. Run `git checkout $GIT_TRUNK_BRANCH_NAME`
238
- 9. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure latest trunk code
239
- 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
240
- - If your Bundler is >= 2.7.0, you can skip this; builds are reproducible by default.
241
- - Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH`
242
- - If the echo above has no output, then it didn't work.
243
- - Note: `zsh/datetime` module is needed, if running `zsh`.
244
- - In older versions of `bash` you can use `date +%s` instead, i.e. `export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH`
245
- 11. Run `bundle exec rake build`
246
- 12. Run `bin/gem_checksums` (more context [1][🔒️rubygems-checksums-pr], [2][🔒️rubygems-guides-pr])
247
- to create SHA-256 and SHA-512 checksums. This functionality is provided by the `stone_checksums`
248
- [gem][💎stone_checksums].
249
- - The script automatically commits but does not push the checksums
250
- 13. Sanity check the SHA256, comparing with the output from the `bin/gem_checksums` command:
251
- - `sha256sum pkg/<gem name>-<version>.gem`
252
- 14. Run `bundle exec rake release` which will create a git tag for the version,
253
- push git commits and tags, and push the `.gem` file to the gem host configured in the gemspec.
23
+ [comment]: <> (Following links are used by README, CONTRIBUTING, Homepage)
254
24
 
255
- [📜src-gl]: https://gitlab.com/rubocop-lts/rubocop-lts
256
- [📜src-cb]: https://codeberg.org/rubocop-lts/rubocop-lts
257
- [📜src-gh]: https://github.com/rubocop-lts/rubocop-lts
258
- [🧪build]: https://github.com/rubocop-lts/rubocop-lts/actions
259
- [🤝conduct]: https://github.com/rubocop-lts/rubocop-lts/blob/main/CODE_OF_CONDUCT.md
260
- [🖐contrib-rocks]: https://contrib.rocks
261
- [🖐contributors]: https://github.com/rubocop-lts/rubocop-lts/graphs/contributors
262
- [🚎contributors-gl]: https://gitlab.com/rubocop-lts/rubocop-lts/-/graphs/main
263
- [🖐contributors-img]: https://contrib.rocks/image?repo=rubocop-lts/rubocop-lts
264
- [💎gem-coop]: https://gem.coop
265
- [🔒️rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
266
- [🔒️rubygems-checksums-pr]: https://github.com/rubygems/rubygems/pull/6022
267
- [🔒️rubygems-guides-pr]: https://github.com/rubygems/guides/pull/325
268
- [💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
269
- [📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
270
- [📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
271
- [📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
272
- [📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
273
- [🚎appraisal2]: https://github.com/appraisal-rb/appraisal2
274
- [🏃‍♂️runner-tool-cache]: https://github.com/ruby/ruby-builder/releases/tag/toolcache
275
- [✉️discord-invite]: https://discord.gg/3qme4XHNKN
25
+ [source]: https://github.com/rubocop-lts/rubocop-lts/
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2022 Peter Boling
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.