yard-fence 0.1.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.
Files changed (21) hide show
  1. checksums.yaml +7 -0
  2. checksums.yaml.gz.sig +1 -0
  3. data/CHANGELOG.md +35 -0
  4. data/CITATION.cff +20 -0
  5. data/CODE_OF_CONDUCT.md +134 -0
  6. data/CONTRIBUTING.md +218 -0
  7. data/FUNDING.md +77 -0
  8. data/LICENSE.txt +21 -0
  9. data/README.md +579 -0
  10. data/REEK +0 -0
  11. data/RUBOCOP.md +71 -0
  12. data/SECURITY.md +21 -0
  13. data/lib/yard/fence/kramdown_gfm_document.rb +25 -0
  14. data/lib/yard/fence/version.rb +10 -0
  15. data/lib/yard/fence.rb +169 -0
  16. data/lib/yard-fence.rb +6 -0
  17. data/sig/kramdown.rbs +6 -0
  18. data/sig/yard/fence.rbs +37 -0
  19. data.tar.gz.sig +0 -0
  20. metadata +353 -0
  21. metadata.gz.sig +0 -0
data/README.md ADDED
@@ -0,0 +1,579 @@
1
+ | 📍 NOTE |
2
+ |-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
3
+ | RubyGems (the [GitHub org][rubygems-org], not the website) [suffered][draper-security] a [hostile takeover][ellen-takeover] in September 2025. |
4
+ | Ultimately [4 maintainers][simi-removed] were [hard removed][martin-removed] and a reason has been given for only 1 of those, while 2 others resigned in protest. |
5
+ | It is a [complicated story][draper-takeover] which is difficult to [parse quickly][draper-lies]. |
6
+ | I'm adding notes like this to gems because I [don't condone theft][draper-theft] of repositories or gems from their rightful owners. |
7
+ | If a similar theft happened with my repos/gems, I'd hope some would stand up for me. |
8
+ | Disenfranchised former-maintainers have started [gem.coop][gem-coop]. |
9
+ | Once available I will publish there exclusively; unless RubyCentral makes amends with the community. |
10
+ | The ["Technology for Humans: Joel Draper"][reinteractive-podcast] podcast episode by [reinteractive][reinteractive] is the most cogent summary I'm aware of. |
11
+ | See [here][gem-naming], [here][gem-coop] and [here][martin-ann] for more info on what comes next. |
12
+ | What I'm doing: A (WIP) proposal for [bundler/gem scopes][gem-scopes], and a (WIP) proposal for a federated [gem server][gem-server]. |
13
+
14
+ [rubygems-org]: https://github.com/rubygems/
15
+ [draper-security]: https://joel.drapper.me/p/ruby-central-security-measures/
16
+ [draper-takeover]: https://joel.drapper.me/p/ruby-central-takeover/
17
+ [ellen-takeover]: https://pup-e.com/blog/goodbye-rubygems/
18
+ [simi-removed]: https://www.reddit.com/r/ruby/s/gOk42POCaV
19
+ [martin-removed]: https://bsky.app/profile/martinemde.com/post/3m3occezxxs2q
20
+ [draper-lies]: https://joel.drapper.me/p/ruby-central-fact-check/
21
+ [draper-theft]: https://joel.drapper.me/p/ruby-central/
22
+ [reinteractive]: https://reinteractive.com/ruby-on-rails
23
+ [gem-coop]: https://gem.coop
24
+ [gem-naming]: https://github.com/gem-coop/gem.coop/issues/12
25
+ [martin-ann]: https://martinemde.com/2025/10/05/announcing-gem-coop.html
26
+ [gem-scopes]: https://github.com/galtzo-floss/bundle-namespace
27
+ [gem-server]: https://github.com/galtzo-floss/gem-server
28
+ [reinteractive-podcast]: https://youtu.be/_H4qbtC5qzU?si=BvuBU90R2wAqD2E6
29
+
30
+ [![Galtzo FLOSS Logo by Aboling0, CC BY-SA 4.0][🖼️galtzo-i]][🖼️galtzo-discord] [![ruby-lang Logo, Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5][🖼️ruby-lang-i]][🖼️ruby-lang]
31
+
32
+ [🖼️galtzo-i]: https://logos.galtzo.com/assets/images/galtzo-floss/avatar-192px.svg
33
+ [🖼️galtzo-discord]: https://discord.gg/3qme4XHNKN
34
+ [🖼️ruby-lang-i]: https://logos.galtzo.com/assets/images/ruby-lang/avatar-192px.svg
35
+ [🖼️ruby-lang]: https://www.ruby-lang.org/
36
+
37
+ # 🤺 Yard::Fence
38
+
39
+ [![Version][👽versioni]][👽version] [![GitHub tag (latest SemVer)][⛳️tag-img]][⛳️tag] [![License: MIT][📄license-img]][📄license-ref] [![Downloads Rank][👽dl-ranki]][👽dl-rank] [![Open Source Helpers][👽oss-helpi]][👽oss-help] [![CodeCov Test Coverage][🏀codecovi]][🏀codecov] [![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls] [![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov] [![QLTY Maintainability][🏀qlty-mnti]][🏀qlty-mnt] [![CI Heads][🚎3-hd-wfi]][🚎3-hd-wf] [![CI Runtime Dependencies @ HEAD][🚎12-crh-wfi]][🚎12-crh-wf] [![CI Current][🚎11-c-wfi]][🚎11-c-wf] [![CI Truffle Ruby][🚎9-t-wfi]][🚎9-t-wf] [![Deps Locked][🚎13-🔒️-wfi]][🚎13-🔒️-wf] [![Deps Unlocked][🚎14-🔓️-wfi]][🚎14-🔓️-wf] [![CI Supported][🚎6-s-wfi]][🚎6-s-wf] [![CI Test Coverage][🚎2-cov-wfi]][🚎2-cov-wf] [![CI Style][🚎5-st-wfi]][🚎5-st-wf] [![CodeQL][🖐codeQL-img]][🖐codeQL] [![Apache SkyWalking Eyes License Compatibility Check][🚎15-🪪-wfi]][🚎15-🪪-wf]
40
+
41
+ `if ci_badges.map(&:color).detect { it != "green"}` ☝️ [let me know][🖼️galtzo-discord], as I may have missed the [discord notification][🖼️galtzo-discord].
42
+
43
+ ---
44
+
45
+ `if ci_badges.map(&:color).all? { it == "green"}` 👇️ send money so I can do more of this. FLOSS maintenance is now my full-time job.
46
+
47
+ [![OpenCollective Backers][🖇osc-backers-i]][🖇osc-backers] [![OpenCollective Sponsors][🖇osc-sponsors-i]][🖇osc-sponsors] [![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Donate on PayPal][🖇paypal-img]][🖇paypal] [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate on Polar][🖇polar-img]][🖇polar] [![Donate at ko-fi.com][🖇kofi-img]][🖇kofi]
48
+
49
+ ## 🌻 Synopsis
50
+
51
+ A brace converter for the markdown fences in your YARD docs.
52
+
53
+ Just the important bits:
54
+ - Preprocesses top-level README and other `.md`/`.txt` files into `tmp/` replacing ASCII braces inside fenced code blocks, inline code spans, and simple placeholders like `{issuer}` or `{{TOKEN}}` with visually identical fullwidth braces.
55
+ - This prevents YARD from emitting `InvalidLink` warnings.
56
+ - Prioritizes Kramdown's GFM parser so tables and fenced code blocks render correctly.
57
+ - After YARD finishes generating HTML, restores fullwidth braces back to normal ASCII braces so code examples are copy‑pastable.
58
+
59
+ ## 💡 Info you can shake a stick at
60
+
61
+ | Tokens to Remember | [![Gem name][⛳️name-img]][⛳️gem-name] [![Gem namespace][⛳️namespace-img]][⛳️gem-namespace] |
62
+ |-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
63
+ | Works with JRuby | [![JRuby 10.0 Compat][💎jruby-c-i]][🚎11-c-wf] [![JRuby HEAD Compat][💎jruby-headi]][🚎3-hd-wf] |
64
+ | Works with Truffle Ruby | [![Truffle Ruby 23.1 Compat][💎truby-23.1i]][🚎9-t-wf] [![Truffle Ruby 24.1 Compat][💎truby-c-i]][🚎11-c-wf] |
65
+ | Works with MRI Ruby 3 | [![Ruby 3.2 Compat][💎ruby-3.2i]][🚎6-s-wf] [![Ruby 3.3 Compat][💎ruby-3.3i]][🚎6-s-wf] [![Ruby 3.4 Compat][💎ruby-c-i]][🚎11-c-wf] [![Ruby HEAD Compat][💎ruby-headi]][🚎3-hd-wf] |
66
+ | Support & Community | [![Join Me on Daily.dev's RubyFriends][✉️ruby-friends-img]][✉️ruby-friends] [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite] [![Get help from me on Upwork][👨🏼‍🏫expsup-upwork-img]][👨🏼‍🏫expsup-upwork] [![Get help from me on Codementor][👨🏼‍🏫expsup-codementor-img]][👨🏼‍🏫expsup-codementor] |
67
+ | Source | [![Source on GitLab.com][📜src-gl-img]][📜src-gl] [![Source on CodeBerg.org][📜src-cb-img]][📜src-cb] [![Source on Github.com][📜src-gh-img]][📜src-gh] [![The best SHA: dQw4w9WgXcQ!][🧮kloc-img]][🧮kloc] |
68
+ | Documentation | [![Current release on RubyDoc.info][📜docs-cr-rd-img]][🚎yard-current] [![YARD on Galtzo.com][📜docs-head-rd-img]][🚎yard-head] [![Maintainer Blog][🚂maint-blog-img]][🚂maint-blog] [![GitLab Wiki][📜gl-wiki-img]][📜gl-wiki] [![GitHub Wiki][📜gh-wiki-img]][📜gh-wiki] |
69
+ | Compliance | [![License: MIT][📄license-img]][📄license-ref] [![Compatible with Apache Software Projects: Verified by SkyWalking Eyes][📄license-compat-img]][📄license-compat] [![📄ilo-declaration-img]][📄ilo-declaration] [![Security Policy][🔐security-img]][🔐security] [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct] [![SemVer 2.0.0][📌semver-img]][📌semver] |
70
+ | Style | [![Enforced Code Style Linter][💎rlts-img]][💎rlts] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog] [![Gitmoji Commits][📌gitmoji-img]][📌gitmoji] [![Compatibility appraised by: appraisal2][💎appraisal2-img]][💎appraisal2] |
71
+ | Maintainer 🎖️ | [![Follow Me on LinkedIn][💖🖇linkedin-img]][💖🖇linkedin] [![Follow Me on Ruby.Social][💖🐘ruby-mast-img]][💖🐘ruby-mast] [![Follow Me on Bluesky][💖🦋bluesky-img]][💖🦋bluesky] [![Contact Maintainer][🚂maint-contact-img]][🚂maint-contact] [![My technical writing][💖💁🏼‍♂️devto-img]][💖💁🏼‍♂️devto] |
72
+ | `...` 💖 | [![Find Me on WellFound:][💖✌️wellfound-img]][💖✌️wellfound] [![Find Me on CrunchBase][💖💲crunchbase-img]][💖💲crunchbase] [![My LinkTree][💖🌳linktree-img]][💖🌳linktree] [![More About Me][💖💁🏼‍♂️aboutme-img]][💖💁🏼‍♂️aboutme] [🧊][💖🧊berg] [🐙][💖🐙hub] [🛖][💖🛖hut] [🧪][💖🧪lab] |
73
+
74
+ ### Compatibility
75
+
76
+ Compatible with MRI Ruby 3.2.0+, and concordant releases of JRuby, and TruffleRuby.
77
+
78
+ | 🚚 _Amazing_ test matrix was brought to you by | 🔎 appraisal2 🔎 and the color 💚 green 💚 |
79
+ |------------------------------------------------|--------------------------------------------------------|
80
+ | 👟 Check it out! | ✨ [github.com/appraisal-rb/appraisal2][💎appraisal2] ✨ |
81
+
82
+ ### Federated DVCS
83
+
84
+ <details>
85
+ <summary>Find this repo on federated forges (Coming soon!)</summary>
86
+
87
+ | Federated [DVCS][💎d-in-dvcs] Repository | Status | Issues | PRs | Wiki | CI | Discussions |
88
+ |----------------------------------------------------|-----------------------------------------------------------------------|---------------------------|--------------------------|---------------------------|--------------------------|------------------------------|
89
+ | 🧪 [galtzo-floss/yard-fence on GitLab][📜src-gl] | The Truth | [💚][🤝gl-issues] | [💚][🤝gl-pulls] | [💚][📜gl-wiki] | 🐭 Tiny Matrix | ➖ |
90
+ | 🧊 [galtzo-floss/yard-fence on CodeBerg][📜src-cb] | An Ethical Mirror ([Donate][🤝cb-donate]) | [💚][🤝cb-issues] | [💚][🤝cb-pulls] | ➖ | ⭕️ No Matrix | ➖ |
91
+ | 🐙 [galtzo-floss/yard-fence on GitHub][📜src-gh] | Another Mirror | [💚][🤝gh-issues] | [💚][🤝gh-pulls] | [💚][📜gh-wiki] | 💯 Full Matrix | [💚][gh-discussions] |
92
+ | 🎮️ [Discord Server][✉️discord-invite] | [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite] | [Let's][✉️discord-invite] | [talk][✉️discord-invite] | [about][✉️discord-invite] | [this][✉️discord-invite] | [library!][✉️discord-invite] |
93
+
94
+ </details>
95
+
96
+ [gh-discussions]: https://github.com/galtzo-floss/yard-fence/discussions
97
+
98
+ ### Enterprise Support [![Tidelift](https://tidelift.com/badges/package/rubygems/yard-fence)](https://tidelift.com/subscription/pkg/rubygems-yard-fence?utm_source=rubygems-yard-fence&utm_medium=referral&utm_campaign=readme)
99
+
100
+ Available as part of the Tidelift Subscription.
101
+
102
+ <details>
103
+ <summary>Need enterprise-level guarantees?</summary>
104
+
105
+ The maintainers of this and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use.
106
+
107
+ [![Get help from me on Tidelift][🏙️entsup-tidelift-img]][🏙️entsup-tidelift]
108
+
109
+ - 💡Subscribe for support guarantees covering _all_ your FLOSS dependencies
110
+ - 💡Tidelift is part of [Sonar][🏙️entsup-tidelift-sonar]
111
+ - 💡Tidelift pays maintainers to maintain the software you depend on!<br/>📊`@`Pointy Haired Boss: An [enterprise support][🏙️entsup-tidelift] subscription is "[never gonna let you down][🧮kloc]", and *supports* open source maintainers
112
+
113
+ Alternatively:
114
+
115
+ - [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
116
+ - [![Get help from me on Upwork][👨🏼‍🏫expsup-upwork-img]][👨🏼‍🏫expsup-upwork]
117
+ - [![Get help from me on Codementor][👨🏼‍🏫expsup-codementor-img]][👨🏼‍🏫expsup-codementor]
118
+
119
+ </details>
120
+
121
+ ## ✨ Installation
122
+
123
+ Install the gem and add to the application's Gemfile by executing:
124
+
125
+ ```console
126
+ bundle add yard-fence
127
+ ```
128
+
129
+ If bundler is not being used to manage dependencies, install the gem by executing:
130
+
131
+ ```console
132
+ gem install yard-fence
133
+ ```
134
+
135
+ ### 🔒 Secure Installation
136
+
137
+ <details>
138
+ <summary>For Medium or High Security Installations</summary>
139
+
140
+ This gem is cryptographically signed, and has verifiable [SHA-256 and SHA-512][💎SHA_checksums] checksums by
141
+ [stone_checksums][💎stone_checksums]. Be sure the gem you install hasn’t been tampered with
142
+ by following the instructions below.
143
+
144
+ Add my public key (if you haven’t already, expires 2045-04-29) as a trusted certificate:
145
+
146
+ ```console
147
+ gem cert --add <(curl -Ls https://raw.github.com/galtzo-floss/certs/main/pboling.pem)
148
+ ```
149
+
150
+ You only need to do that once. Then proceed to install with:
151
+
152
+ ```console
153
+ gem install yard-fence -P HighSecurity
154
+ ```
155
+
156
+ The `HighSecurity` trust profile will verify signed gems, and not allow the installation of unsigned dependencies.
157
+
158
+ If you want to up your security game full-time:
159
+
160
+ ```console
161
+ bundle config set --global trust-policy MediumSecurity
162
+ ```
163
+
164
+ `MediumSecurity` instead of `HighSecurity` is necessary if not all the gems you use are signed.
165
+
166
+ NOTE: Be prepared to track down certs for signed gems and add them the same way you added mine.
167
+
168
+ </details>
169
+
170
+ ## ⚙️ Configuration
171
+
172
+ Yard::Fence writes sanitized copies of top‑level Markdown/TXT into tmp/ at load time. To avoid YARD parsing the unsanitized originals, point YARD at the tmp/ copies.
173
+
174
+ Recommended .yardopts (noise‑free):
175
+
176
+ ```text
177
+ --plugin fence
178
+ -e 'Yard::Fence.use_kramdown_gfm!'
179
+ --readme tmp/README.md
180
+ --markup markdown
181
+ --output docs
182
+ 'lib/**/*.rb'
183
+ -
184
+ 'tmp/*.md'
185
+ 'tmp/*.txt'
186
+ ```
187
+
188
+ Why tmp/?
189
+ - The plugin converts ASCII `{ }` to fullwidth `｛ ｝` only in `tmp/` so YARD won’t treat brace content as reference tags and emit InvalidLink warnings. After docs are generated, the HTML is restored back to normal ASCII braces for easy copy/paste.
190
+
191
+ ## 🔧 Basic Usage
192
+
193
+ CLI example that would be similar to what is accomplished by the `.yardopts` from the section above:
194
+
195
+ ```bash
196
+ yard doc \
197
+ --plugin fence \
198
+ -e 'Yard::Fence.use_kramdown_gfm!' \
199
+ --readme tmp/README.md \
200
+ lib/**/*.rb - tmp/*.md tmp/*.txt
201
+ ```
202
+
203
+ ## 🦷 FLOSS Funding
204
+
205
+ While galtzo-floss tools are free software and will always be, the project would benefit immensely from some funding.
206
+ Raising a monthly budget of... "dollars" would make the project more sustainable.
207
+
208
+ We welcome both individual and corporate sponsors! We also offer a
209
+ wide array of funding channels to account for your preferences
210
+ (although currently [Open Collective][🖇osc] is our preferred funding platform).
211
+
212
+ **If you're working in a company that's making significant use of galtzo-floss tools we'd
213
+ appreciate it if you suggest to your company to become a galtzo-floss sponsor.**
214
+
215
+ You can support the development of galtzo-floss tools via
216
+ [GitHub Sponsors][🖇sponsor],
217
+ [Liberapay][⛳liberapay],
218
+ [PayPal][🖇paypal],
219
+ [Open Collective][🖇osc]
220
+ and [Tidelift][🏙️entsup-tidelift].
221
+
222
+ | 📍 NOTE |
223
+ |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
224
+ | If doing a sponsorship in the form of donation is problematic for your company <br/> from an accounting standpoint, we'd recommend the use of Tidelift, <br/> where you can get a support-like subscription instead. |
225
+
226
+ ### Open Collective for Individuals
227
+
228
+ Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/galtzo-floss#backer)]
229
+
230
+ NOTE: [kettle-readme-backers][kettle-readme-backers] updates this list every day, automatically.
231
+
232
+ <!-- OPENCOLLECTIVE-INDIVIDUALS:START -->
233
+ No backers yet. Be the first!
234
+ <!-- OPENCOLLECTIVE-INDIVIDUALS:END -->
235
+
236
+ ### Open Collective for Organizations
237
+
238
+ Become a sponsor and get your logo on our README on GitHub with a link to your site. [[Become a sponsor](https://opencollective.com/galtzo-floss#sponsor)]
239
+
240
+ NOTE: [kettle-readme-backers][kettle-readme-backers] updates this list every day, automatically.
241
+
242
+ <!-- OPENCOLLECTIVE-ORGANIZATIONS:START -->
243
+ No sponsors yet. Be the first!
244
+ <!-- OPENCOLLECTIVE-ORGANIZATIONS:END -->
245
+
246
+ [kettle-readme-backers]: https://github.com/galtzo-floss/yard-fence/blob/main/exe/kettle-readme-backers
247
+
248
+ ### Another way to support open-source
249
+
250
+ I’m driven by a passion to foster a thriving open-source community – a space where people can tackle complex problems, no matter how small. Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions. I was recently affected by layoffs, and the tech jobs market is unwelcoming. I’m reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 🐔 chickens, 2 🐶 dogs, 3 🐰 rabbits, 8 🐈‍ cats).
251
+
252
+ If you work at a company that uses my work, please encourage them to support me as a corporate sponsor. My work on gems you use might show up in `bundle fund`.
253
+
254
+ I’m developing a new library, [floss_funding][🖇floss-funding-gem], designed to empower open-source developers like myself to get paid for the work we do, in a sustainable way. Please give it a look.
255
+
256
+ **[Floss-Funding.dev][🖇floss-funding.dev]: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags**
257
+
258
+ [![OpenCollective Backers][🖇osc-backers-i]][🖇osc-backers] [![OpenCollective Sponsors][🖇osc-sponsors-i]][🖇osc-sponsors] [![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Donate on PayPal][🖇paypal-img]][🖇paypal] [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate on Polar][🖇polar-img]][🖇polar] [![Donate to my FLOSS efforts at ko-fi.com][🖇kofi-img]][🖇kofi] [![Donate to my FLOSS efforts using Patreon][🖇patreon-img]][🖇patreon]
259
+
260
+ ## 🔐 Security
261
+
262
+ See [SECURITY.md][🔐security].
263
+
264
+ ## 🤝 Contributing
265
+
266
+ If you need some ideas of where to help, you could work on adding more code coverage,
267
+ or if it is already 💯 (see [below](#code-coverage)) check [reek](REEK), [issues][🤝gh-issues], or [PRs][🤝gh-pulls],
268
+ or use the gem and think about how it could be better.
269
+
270
+ We [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] so if you make changes, remember to update it.
271
+
272
+ See [CONTRIBUTING.md][🤝contributing] for more detailed instructions.
273
+
274
+ ### 🚀 Release Instructions
275
+
276
+ See [CONTRIBUTING.md][🤝contributing].
277
+
278
+ ### Code Coverage
279
+
280
+ [![Coverage Graph][🏀codecov-g]][🏀codecov]
281
+
282
+ [![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls]
283
+
284
+ [![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov]
285
+
286
+ ### 🪇 Code of Conduct
287
+
288
+ Everyone interacting with this project's codebases, issue trackers,
289
+ chat rooms and mailing lists agrees to follow the [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct].
290
+
291
+ ## 🌈 Contributors
292
+
293
+ [![Contributors][🖐contributors-img]][🖐contributors]
294
+
295
+ Made with [contributors-img][🖐contrib-rocks].
296
+
297
+ Also see GitLab Contributors: [https://gitlab.com/galtzo-floss/yard-fence/-/graphs/main][🚎contributors-gl]
298
+
299
+ <details>
300
+ <summary>⭐️ Star History</summary>
301
+
302
+ <a href="https://star-history.com/#galtzo-floss/yard-fence&Date">
303
+ <picture>
304
+ <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=galtzo-floss/yard-fence&type=Date&theme=dark" />
305
+ <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=galtzo-floss/yard-fence&type=Date" />
306
+ <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=galtzo-floss/yard-fence&type=Date" />
307
+ </picture>
308
+ </a>
309
+
310
+ </details>
311
+
312
+ ## 📌 Versioning
313
+
314
+ This Library adheres to [![Semantic Versioning 2.0.0][📌semver-img]][📌semver].
315
+ Violations of this scheme should be reported as bugs.
316
+ Specifically, if a minor or patch version is released that breaks backward compatibility,
317
+ a new version should be immediately released that restores compatibility.
318
+ Breaking changes to the public API will only be introduced with new major versions.
319
+
320
+ > dropping support for a platform is both obviously and objectively a breaking change <br/>
321
+ >—Jordan Harband ([@ljharb](https://github.com/ljharb), maintainer of SemVer) [in SemVer issue 716][📌semver-breaking]
322
+
323
+ I understand that policy doesn't work universally ("exceptions to every rule!"),
324
+ but it is the policy here.
325
+ As such, in many cases it is good to specify a dependency on this library using
326
+ the [Pessimistic Version Constraint][📌pvc] with two digits of precision.
327
+
328
+ For example:
329
+
330
+ ```ruby
331
+ spec.add_dependency("yard-fence", "~> 1.0")
332
+ ```
333
+
334
+ <details>
335
+ <summary>📌 Is "Platform Support" part of the public API? More details inside.</summary>
336
+
337
+ SemVer should, IMO, but doesn't explicitly, say that dropping support for specific Platforms
338
+ is a *breaking change* to an API.
339
+ It is obvious to many, but not all, and since the spec is silent, the bike shedding is endless.
340
+
341
+ To get a better understanding of how SemVer is intended to work over a project's lifetime,
342
+ read this article from the creator of SemVer:
343
+
344
+ - ["Major Version Numbers are Not Sacred"][📌major-versions-not-sacred]
345
+
346
+ </details>
347
+
348
+ See [CHANGELOG.md][📌changelog] for a list of releases.
349
+
350
+ ## 📄 License
351
+
352
+ The gem is available as open source under the terms of
353
+ the [MIT License][📄license] [![License: MIT][📄license-img]][📄license-ref].
354
+ See [LICENSE.txt][📄license] for the official [Copyright Notice][📄copyright-notice-explainer].
355
+
356
+ ### © Copyright
357
+
358
+ <ul>
359
+ <li>
360
+ Copyright (c) 2025 Peter H. Boling, of
361
+ <a href="https://discord.gg/3qme4XHNKN">
362
+ Galtzo.com
363
+ <picture>
364
+ <img src="https://logos.galtzo.com/assets/images/galtzo-floss/avatar-128px-blank.svg" alt="Galtzo.com Logo (Wordless) by Aboling0, CC BY-SA 4.0" width="24">
365
+ </picture>
366
+ </a>, and yard-fence contributors.
367
+ </li>
368
+ </ul>
369
+
370
+ ## 🤑 A request for help
371
+
372
+ Maintainers have teeth and need to pay their dentists.
373
+ After getting laid off in an RIF in March, and encountering difficulty finding a new one,
374
+ I began spending most of my time building open source tools.
375
+ I'm hoping to be able to pay for my kids' health insurance this month,
376
+ so if you value the work I am doing, I need your support.
377
+ Please consider sponsoring me or the project.
378
+
379
+ To join the community or get help 👇️ Join the Discord.
380
+
381
+ [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
382
+
383
+ To say "thanks!" ☝️ Join the Discord or 👇️ send money.
384
+
385
+ [![Sponsor galtzo-floss/yard-fence on Open Source Collective][🖇osc-all-bottom-img]][🖇osc] 💌 [![Sponsor me on GitHub Sponsors][🖇sponsor-bottom-img]][🖇sponsor] 💌 [![Sponsor me on Liberapay][⛳liberapay-bottom-img]][⛳liberapay] 💌 [![Donate on PayPal][🖇paypal-bottom-img]][🖇paypal]
386
+
387
+ ### Please give the project a star ⭐ ♥.
388
+
389
+ Thanks for RTFM. ☺️
390
+
391
+ [⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay&color=a51611&style=flat
392
+ [⛳liberapay-bottom-img]: https://img.shields.io/liberapay/goal/pboling.svg?style=for-the-badge&logo=liberapay&color=a51611
393
+ [⛳liberapay]: https://liberapay.com/pboling/donate
394
+ [🖇osc-all-img]: https://img.shields.io/opencollective/all/galtzo-floss
395
+ [🖇osc-sponsors-img]: https://img.shields.io/opencollective/sponsors/galtzo-floss
396
+ [🖇osc-backers-img]: https://img.shields.io/opencollective/backers/galtzo-floss
397
+ [🖇osc-backers]: https://opencollective.com/galtzo-floss#backer
398
+ [🖇osc-backers-i]: https://opencollective.com/galtzo-floss/backers/badge.svg?style=flat
399
+ [🖇osc-sponsors]: https://opencollective.com/galtzo-floss#sponsor
400
+ [🖇osc-sponsors-i]: https://opencollective.com/galtzo-floss/sponsors/badge.svg?style=flat
401
+ [🖇osc-all-bottom-img]: https://img.shields.io/opencollective/all/galtzo-floss?style=for-the-badge
402
+ [🖇osc-sponsors-bottom-img]: https://img.shields.io/opencollective/sponsors/galtzo-floss?style=for-the-badge
403
+ [🖇osc-backers-bottom-img]: https://img.shields.io/opencollective/backers/galtzo-floss?style=for-the-badge
404
+ [🖇osc]: https://opencollective.com/galtzo-floss
405
+ [🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
406
+ [🖇sponsor-bottom-img]: https://img.shields.io/badge/Sponsor_Me!-pboling-blue?style=for-the-badge&logo=github
407
+ [🖇sponsor]: https://github.com/sponsors/pboling
408
+ [🖇polar-img]: https://img.shields.io/badge/polar-donate-a51611.svg?style=flat
409
+ [🖇polar]: https://polar.sh/pboling
410
+ [🖇kofi-img]: https://img.shields.io/badge/ko--fi-%E2%9C%93-a51611.svg?style=flat
411
+ [🖇kofi]: https://ko-fi.com/O5O86SNP4
412
+ [🖇patreon-img]: https://img.shields.io/badge/patreon-donate-a51611.svg?style=flat
413
+ [🖇patreon]: https://patreon.com/galtzo
414
+ [🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-%E2%9C%93-a51611.svg?style=flat
415
+ [🖇buyme-img]: https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20latte&emoji=&slug=pboling&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff
416
+ [🖇buyme]: https://www.buymeacoffee.com/pboling
417
+ [🖇paypal-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=flat&logo=paypal
418
+ [🖇paypal-bottom-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=for-the-badge&logo=paypal&color=0A0A0A
419
+ [🖇paypal]: https://www.paypal.com/paypalme/peterboling
420
+ [🖇floss-funding.dev]: https://floss-funding.dev
421
+ [🖇floss-funding-gem]: https://github.com/galtzo-floss/floss_funding
422
+ [✉️discord-invite]: https://discord.gg/3qme4XHNKN
423
+ [✉️discord-invite-img-ftb]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge&logo=discord
424
+ [✉️ruby-friends-img]: https://img.shields.io/badge/daily.dev-%F0%9F%92%8E_Ruby_Friends-0A0A0A?style=for-the-badge&logo=dailydotdev&logoColor=white
425
+ [✉️ruby-friends]: https://app.daily.dev/squads/rubyfriends
426
+
427
+ [✇bundle-group-pattern]: https://gist.github.com/pboling/4564780
428
+ [⛳️gem-namespace]: https://github.com/galtzo-floss/yard-fence
429
+ [⛳️namespace-img]: https://img.shields.io/badge/namespace-Yard::Fence-3C2D2D.svg?style=square&logo=ruby&logoColor=white
430
+ [⛳️gem-name]: https://bestgems.org/gems/yard-fence
431
+ [⛳️name-img]: https://img.shields.io/badge/name-yard--fence-3C2D2D.svg?style=square&logo=rubygems&logoColor=red
432
+ [⛳️tag-img]: https://img.shields.io/github/tag/galtzo-floss/yard-fence.svg
433
+ [⛳️tag]: http://github.com/galtzo-floss/yard-fence/releases
434
+ [🚂maint-blog]: http://www.railsbling.com/tags/yard-fence
435
+ [🚂maint-blog-img]: https://img.shields.io/badge/blog-railsbling-0093D0.svg?style=for-the-badge&logo=rubyonrails&logoColor=orange
436
+ [🚂maint-contact]: http://www.railsbling.com/contact
437
+ [🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
438
+ [💖🖇linkedin]: http://www.linkedin.com/in/peterboling
439
+ [💖🖇linkedin-img]: https://img.shields.io/badge/PeterBoling-LinkedIn-0B66C2?style=flat&logo=newjapanprowrestling
440
+ [💖✌️wellfound]: https://wellfound.com/u/peter-boling
441
+ [💖✌️wellfound-img]: https://img.shields.io/badge/peter--boling-orange?style=flat&logo=wellfound
442
+ [💖💲crunchbase]: https://www.crunchbase.com/person/peter-boling
443
+ [💖💲crunchbase-img]: https://img.shields.io/badge/peter--boling-purple?style=flat&logo=crunchbase
444
+ [💖🐘ruby-mast]: https://ruby.social/@galtzo
445
+ [💖🐘ruby-mast-img]: https://img.shields.io/mastodon/follow/109447111526622197?domain=https://ruby.social&style=flat&logo=mastodon&label=Ruby%20@galtzo
446
+ [💖🦋bluesky]: https://bsky.app/profile/galtzo.com
447
+ [💖🦋bluesky-img]: https://img.shields.io/badge/@galtzo.com-0285FF?style=flat&logo=bluesky&logoColor=white
448
+ [💖🌳linktree]: https://linktr.ee/galtzo
449
+ [💖🌳linktree-img]: https://img.shields.io/badge/galtzo-purple?style=flat&logo=linktree
450
+ [💖💁🏼‍♂️devto]: https://dev.to/galtzo
451
+ [💖💁🏼‍♂️devto-img]: https://img.shields.io/badge/dev.to-0A0A0A?style=flat&logo=devdotto&logoColor=white
452
+ [💖💁🏼‍♂️aboutme]: https://about.me/peter.boling
453
+ [💖💁🏼‍♂️aboutme-img]: https://img.shields.io/badge/about.me-0A0A0A?style=flat&logo=aboutme&logoColor=white
454
+ [💖🧊berg]: https://codeberg.org/pboling
455
+ [💖🐙hub]: https://github.org/pboling
456
+ [💖🛖hut]: https://sr.ht/~galtzo/
457
+ [💖🧪lab]: https://gitlab.com/pboling
458
+ [👨🏼‍🏫expsup-upwork]: https://www.upwork.com/freelancers/~014942e9b056abdf86?mp_source=share
459
+ [👨🏼‍🏫expsup-upwork-img]: https://img.shields.io/badge/UpWork-13544E?style=for-the-badge&logo=Upwork&logoColor=white
460
+ [👨🏼‍🏫expsup-codementor]: https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github
461
+ [👨🏼‍🏫expsup-codementor-img]: https://img.shields.io/badge/CodeMentor-Get_Help-1abc9c?style=for-the-badge&logo=CodeMentor&logoColor=white
462
+ [🏙️entsup-tidelift]: https://tidelift.com/subscription/pkg/rubygems-yard-fence?utm_source=rubygems-yard-fence&utm_medium=referral&utm_campaign=readme
463
+ [🏙️entsup-tidelift-img]: https://img.shields.io/badge/Tidelift_and_Sonar-Enterprise_Support-FD3456?style=for-the-badge&logo=sonar&logoColor=white
464
+ [🏙️entsup-tidelift-sonar]: https://blog.tidelift.com/tidelift-joins-sonar
465
+ [💁🏼‍♂️peterboling]: http://www.peterboling.com
466
+ [🚂railsbling]: http://www.railsbling.com
467
+ [📜src-gl-img]: https://img.shields.io/badge/GitLab-FBA326?style=for-the-badge&logo=Gitlab&logoColor=orange
468
+ [📜src-gl]: https://gitlab.com/galtzo-floss/yard-fence/
469
+ [📜src-cb-img]: https://img.shields.io/badge/CodeBerg-4893CC?style=for-the-badge&logo=CodeBerg&logoColor=blue
470
+ [📜src-cb]: https://codeberg.org/galtzo-floss/yard-fence
471
+ [📜src-gh-img]: https://img.shields.io/badge/GitHub-238636?style=for-the-badge&logo=Github&logoColor=green
472
+ [📜src-gh]: https://github.com/galtzo-floss/yard-fence
473
+ [📜docs-cr-rd-img]: https://img.shields.io/badge/RubyDoc-Current_Release-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
474
+ [📜docs-head-rd-img]: https://img.shields.io/badge/YARD_on_Galtzo.com-HEAD-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
475
+ [📜gl-wiki]: https://gitlab.com/galtzo-floss/yard-fence/-/wikis/home
476
+ [📜gh-wiki]: https://github.com/galtzo-floss/yard-fence/wiki
477
+ [📜gl-wiki-img]: https://img.shields.io/badge/wiki-examples-943CD2.svg?style=for-the-badge&logo=gitlab&logoColor=white
478
+ [📜gh-wiki-img]: https://img.shields.io/badge/wiki-examples-943CD2.svg?style=for-the-badge&logo=github&logoColor=white
479
+ [👽dl-rank]: https://bestgems.org/gems/yard-fence
480
+ [👽dl-ranki]: https://img.shields.io/gem/rd/yard-fence.svg
481
+ [👽oss-help]: https://www.codetriage.com/galtzo-floss/yard-fence
482
+ [👽oss-helpi]: https://www.codetriage.com/galtzo-floss/yard-fence/badges/users.svg
483
+ [👽version]: https://bestgems.org/gems/yard-fence
484
+ [👽versioni]: https://img.shields.io/gem/v/yard-fence.svg
485
+ [🏀qlty-mnt]: https://qlty.sh/gh/galtzo-floss/projects/yard-fence
486
+ [🏀qlty-mnti]: https://qlty.sh/gh/galtzo-floss/projects/yard-fence/maintainability.svg
487
+ [🏀qlty-cov]: https://qlty.sh/gh/galtzo-floss/projects/yard-fence/metrics/code?sort=coverageRating
488
+ [🏀qlty-covi]: https://qlty.sh/gh/galtzo-floss/projects/yard-fence/coverage.svg
489
+ [🏀codecov]: https://codecov.io/gh/galtzo-floss/yard-fence
490
+ [🏀codecovi]: https://codecov.io/gh/galtzo-floss/yard-fence/graph/badge.svg
491
+ [🏀coveralls]: https://coveralls.io/github/galtzo-floss/yard-fence?branch=main
492
+ [🏀coveralls-img]: https://coveralls.io/repos/github/galtzo-floss/yard-fence/badge.svg?branch=main
493
+ [🖐codeQL]: https://github.com/galtzo-floss/yard-fence/security/code-scanning
494
+ [🖐codeQL-img]: https://github.com/galtzo-floss/yard-fence/actions/workflows/codeql-analysis.yml/badge.svg
495
+ [🚎2-cov-wf]: https://github.com/galtzo-floss/yard-fence/actions/workflows/coverage.yml
496
+ [🚎2-cov-wfi]: https://github.com/galtzo-floss/yard-fence/actions/workflows/coverage.yml/badge.svg
497
+ [🚎3-hd-wf]: https://github.com/galtzo-floss/yard-fence/actions/workflows/heads.yml
498
+ [🚎3-hd-wfi]: https://github.com/galtzo-floss/yard-fence/actions/workflows/heads.yml/badge.svg
499
+ [🚎5-st-wf]: https://github.com/galtzo-floss/yard-fence/actions/workflows/style.yml
500
+ [🚎5-st-wfi]: https://github.com/galtzo-floss/yard-fence/actions/workflows/style.yml/badge.svg
501
+ [🚎6-s-wf]: https://github.com/galtzo-floss/yard-fence/actions/workflows/supported.yml
502
+ [🚎6-s-wfi]: https://github.com/galtzo-floss/yard-fence/actions/workflows/supported.yml/badge.svg
503
+ [🚎8-ho-wf]: https://github.com/galtzo-floss/yard-fence/actions/workflows/hoary.yml
504
+ [🚎8-ho-wfi]: https://github.com/galtzo-floss/yard-fence/actions/workflows/hoary.yml/badge.svg
505
+ [🚎9-t-wf]: https://github.com/galtzo-floss/yard-fence/actions/workflows/truffle.yml
506
+ [🚎9-t-wfi]: https://github.com/galtzo-floss/yard-fence/actions/workflows/truffle.yml/badge.svg
507
+ [🚎10-j-wf]: https://github.com/galtzo-floss/yard-fence/actions/workflows/jruby.yml
508
+ [🚎10-j-wfi]: https://github.com/galtzo-floss/yard-fence/actions/workflows/jruby.yml/badge.svg
509
+ [🚎11-c-wf]: https://github.com/galtzo-floss/yard-fence/actions/workflows/current.yml
510
+ [🚎11-c-wfi]: https://github.com/galtzo-floss/yard-fence/actions/workflows/current.yml/badge.svg
511
+ [🚎12-crh-wf]: https://github.com/galtzo-floss/yard-fence/actions/workflows/dep-heads.yml
512
+ [🚎12-crh-wfi]: https://github.com/galtzo-floss/yard-fence/actions/workflows/dep-heads.yml/badge.svg
513
+ [🚎13-🔒️-wf]: https://github.com/galtzo-floss/yard-fence/actions/workflows/locked_deps.yml
514
+ [🚎13-🔒️-wfi]: https://github.com/galtzo-floss/yard-fence/actions/workflows/locked_deps.yml/badge.svg
515
+ [🚎14-🔓️-wf]: https://github.com/galtzo-floss/yard-fence/actions/workflows/unlocked_deps.yml
516
+ [🚎14-🔓️-wfi]: https://github.com/galtzo-floss/yard-fence/actions/workflows/unlocked_deps.yml/badge.svg
517
+ [🚎15-🪪-wf]: https://github.com/galtzo-floss/yard-fence/actions/workflows/license-eye.yml
518
+ [🚎15-🪪-wfi]: https://github.com/galtzo-floss/yard-fence/actions/workflows/license-eye.yml/badge.svg
519
+ [💎ruby-3.2i]: https://img.shields.io/badge/Ruby-3.2-CC342D?style=for-the-badge&logo=ruby&logoColor=white
520
+ [💎ruby-3.3i]: https://img.shields.io/badge/Ruby-3.3-CC342D?style=for-the-badge&logo=ruby&logoColor=white
521
+ [💎ruby-c-i]: https://img.shields.io/badge/Ruby-current-CC342D?style=for-the-badge&logo=ruby&logoColor=green
522
+ [💎ruby-headi]: https://img.shields.io/badge/Ruby-HEAD-CC342D?style=for-the-badge&logo=ruby&logoColor=blue
523
+ [💎truby-22.3i]: https://img.shields.io/badge/Truffle_Ruby-22.3_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=pink
524
+ [💎truby-23.0i]: https://img.shields.io/badge/Truffle_Ruby-23.0_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=pink
525
+ [💎truby-23.1i]: https://img.shields.io/badge/Truffle_Ruby-23.1-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
526
+ [💎truby-c-i]: https://img.shields.io/badge/Truffle_Ruby-current-34BCB1?style=for-the-badge&logo=ruby&logoColor=green
527
+ [💎truby-headi]: https://img.shields.io/badge/Truffle_Ruby-HEAD-34BCB1?style=for-the-badge&logo=ruby&logoColor=blue
528
+ [💎jruby-9.1i]: https://img.shields.io/badge/JRuby-9.1_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=red
529
+ [💎jruby-9.2i]: https://img.shields.io/badge/JRuby-9.2_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=red
530
+ [💎jruby-9.3i]: https://img.shields.io/badge/JRuby-9.3_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=red
531
+ [💎jruby-9.4i]: https://img.shields.io/badge/JRuby-9.4-FBE742?style=for-the-badge&logo=ruby&logoColor=red
532
+ [💎jruby-c-i]: https://img.shields.io/badge/JRuby-current-FBE742?style=for-the-badge&logo=ruby&logoColor=green
533
+ [💎jruby-headi]: https://img.shields.io/badge/JRuby-HEAD-FBE742?style=for-the-badge&logo=ruby&logoColor=blue
534
+ [🤝gh-issues]: https://github.com/galtzo-floss/yard-fence/issues
535
+ [🤝gh-pulls]: https://github.com/galtzo-floss/yard-fence/pulls
536
+ [🤝gl-issues]: https://gitlab.com/galtzo-floss/yard-fence/-/issues
537
+ [🤝gl-pulls]: https://gitlab.com/galtzo-floss/yard-fence/-/merge_requests
538
+ [🤝cb-issues]: https://codeberg.org/galtzo-floss/yard-fence/issues
539
+ [🤝cb-pulls]: https://codeberg.org/galtzo-floss/yard-fence/pulls
540
+ [🤝cb-donate]: https://donate.codeberg.org/
541
+ [🤝contributing]: CONTRIBUTING.md
542
+ [🏀codecov-g]: https://codecov.io/gh/galtzo-floss/yard-fence/graphs/tree.svg
543
+ [🖐contrib-rocks]: https://contrib.rocks
544
+ [🖐contributors]: https://github.com/galtzo-floss/yard-fence/graphs/contributors
545
+ [🖐contributors-img]: https://contrib.rocks/image?repo=galtzo-floss/yard-fence
546
+ [🚎contributors-gl]: https://gitlab.com/galtzo-floss/yard-fence/-/graphs/main
547
+ [🪇conduct]: CODE_OF_CONDUCT.md
548
+ [🪇conduct-img]: https://img.shields.io/badge/Contributor_Covenant-2.1-259D6C.svg
549
+ [📌pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
550
+ [📌semver]: https://semver.org/spec/v2.0.0.html
551
+ [📌semver-img]: https://img.shields.io/badge/semver-2.0.0-259D6C.svg?style=flat
552
+ [📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
553
+ [📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
554
+ [📌changelog]: CHANGELOG.md
555
+ [📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
556
+ [📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-34495e.svg?style=flat
557
+ [📌gitmoji]: https://gitmoji.dev
558
+ [📌gitmoji-img]: https://img.shields.io/badge/gitmoji_commits-%20%F0%9F%98%9C%20%F0%9F%98%8D-34495e.svg?style=flat-square
559
+ [🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
560
+ [🧮kloc-img]: https://img.shields.io/badge/KLOC-4.278-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
561
+ [🔐security]: SECURITY.md
562
+ [🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
563
+ [📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
564
+ [📄license]: LICENSE.txt
565
+ [📄license-ref]: https://opensource.org/licenses/MIT
566
+ [📄license-img]: https://img.shields.io/badge/License-MIT-259D6C.svg
567
+ [📄license-compat]: https://dev.to/galtzo/how-to-check-license-compatibility-41h0
568
+ [📄license-compat-img]: https://img.shields.io/badge/Apache_Compatible:_Category_A-%E2%9C%93-259D6C.svg?style=flat&logo=Apache
569
+ [📄ilo-declaration]: https://www.ilo.org/declaration/lang--en/index.htm
570
+ [📄ilo-declaration-img]: https://img.shields.io/badge/ILO_Fundamental_Principles-✓-259D6C.svg?style=flat
571
+ [🚎yard-current]: http://rubydoc.info/gems/yard-fence
572
+ [🚎yard-head]: https://yard-fence.galtzo.com
573
+ [💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
574
+ [💎SHA_checksums]: https://gitlab.com/galtzo-floss/yard-fence/-/tree/main/checksums
575
+ [💎rlts]: https://github.com/rubocop-lts/rubocop-lts
576
+ [💎rlts-img]: https://img.shields.io/badge/code_style_&_linting-rubocop--lts-34495e.svg?plastic&logo=ruby&logoColor=white
577
+ [💎appraisal2]: https://github.com/appraisal-rb/appraisal2
578
+ [💎appraisal2-img]: https://img.shields.io/badge/appraised_by-appraisal2-34495e.svg?plastic&logo=ruby&logoColor=white
579
+ [💎d-in-dvcs]: https://railsbling.com/posts/dvcs/put_the_d_in_dvcs/
data/REEK ADDED
File without changes