Skip to content

Commit 0cdc2a5

Browse files
committed
📝 README formatting
1 parent 51d9ed6 commit 0cdc2a5

32 files changed

+106
-67
lines changed

README.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -49,16 +49,16 @@ Bash::Merge is a standalone Ruby module that intelligently merges two versions o
4949

5050
### Supported Node Types
5151

52-
| Node Type | Signature Format | Matching Behavior |
53-
| --- | --- | --- |
54-
| Function Definition | `[:function, name]` | Functions match by name |
55-
| Variable Assignment | `[:assignment, name]` | Variables match by name |
56-
| Command | `[:command, name, args...]` | Commands match by name and arguments |
57-
| Comment | `[:comment, text]` | Comments preserved in context |
58-
| Pipeline | `[:pipeline, commands...]` | Pipelines match by command sequence |
59-
| If Statement | `[:if, condition_sig]` | Conditionals match by condition signature |
60-
| For Loop | `[:for, variable]` | For loops match by loop variable |
61-
| While Loop | `[:while, condition_sig]` | While loops match by condition signature |
52+
| Node Type | Signature Format | Matching Behavior |
53+
|---------------------|-----------------------------|-------------------------------------------|
54+
| Function Definition | `[:function, name]` | Functions match by name |
55+
| Variable Assignment | `[:assignment, name]` | Variables match by name |
56+
| Command | `[:command, name, args...]` | Commands match by name and arguments |
57+
| Comment | `[:comment, text]` | Comments preserved in context |
58+
| Pipeline | `[:pipeline, commands...]` | Pipelines match by command sequence |
59+
| If Statement | `[:if, condition_sig]` | Conditionals match by condition signature |
60+
| For Loop | `[:for, variable]` | For loops match by loop variable |
61+
| While Loop | `[:while, condition_sig]` | While loops match by condition signature |
6262

6363
### Example
6464

@@ -223,38 +223,38 @@ tree_haver supports multiple parsing backends, but not all backends work on all
223223

224224
## 💡 Info you can shake a stick at
225225

226-
| Tokens to Remember | [![Gem name][⛳️name-img]][bash-merge-gem] [![Gem namespace][⛳️namespace-img]][bash-merge] |
227-
| --- | --- |
228-
| Works with JRuby | [![JRuby 10.0 Compat][💎jruby-c-i]][bash-merge-ci] [![JRuby HEAD Compat][💎jruby-headi]][🚎3-hd-wf] |
229-
| Works with Truffle Ruby | [![Truffle Ruby 23.1 Compat][💎truby-23.1i]][🚎9-t-wf] [![Truffle Ruby 24.1 Compat][💎truby-c-i]][bash-merge-ci] |
230-
| 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]][bash-merge-ci] [![Ruby HEAD Compat][💎ruby-headi]][🚎3-hd-wf] |
231-
| Support & Community | [![Join Me on Daily.dev's RubyFriends][✉️ruby-friends-img]][✉️ruby-friends] [![Live Chat on Discord][✉️discord-invite-img-ftb]][🖼️galtzo-discord] [![Get help from me on Upwork][👨🏼‍🏫expsup-upwork-img]][👨🏼‍🏫expsup-upwork] [![Get help from me on Codementor][👨🏼‍🏫expsup-codementor-img]][👨🏼‍🏫expsup-codementor] |
232-
| 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]][bash-merge] [![The best SHA: dQw4w9WgXcQ\!](https://img.shields.io/badge/KLOC-4.308-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue)][🧮kloc] |
233-
| 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] |
234-
| 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-img]][📄ilo-declaration] [![Security Policy][🔐security-img]][🔐security] [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct] [![SemVer 2.0.0][📌semver-img]][📌semver] |
235-
| 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] |
236-
| 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] |
237-
| `...` 💖 | [![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] |
226+
| Tokens to Remember | [![Gem name][⛳️name-img]][bash-merge-gem] [![Gem namespace][⛳️namespace-img]][bash-merge] |
227+
|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
228+
| Works with JRuby | [![JRuby 10.0 Compat][💎jruby-c-i]][bash-merge-ci] [![JRuby HEAD Compat][💎jruby-headi]][🚎3-hd-wf] |
229+
| Works with Truffle Ruby | [![Truffle Ruby 23.1 Compat][💎truby-23.1i]][🚎9-t-wf] [![Truffle Ruby 24.1 Compat][💎truby-c-i]][bash-merge-ci] |
230+
| 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]][bash-merge-ci] [![Ruby HEAD Compat][💎ruby-headi]][🚎3-hd-wf] |
231+
| Support & Community | [![Join Me on Daily.dev's RubyFriends][✉️ruby-friends-img]][✉️ruby-friends] [![Live Chat on Discord][✉️discord-invite-img-ftb]][🖼️galtzo-discord] [![Get help from me on Upwork][👨🏼‍🏫expsup-upwork-img]][👨🏼‍🏫expsup-upwork] [![Get help from me on Codementor][👨🏼‍🏫expsup-codementor-img]][👨🏼‍🏫expsup-codementor] |
232+
| 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]][bash-merge] [![The best SHA: dQw4w9WgXcQ\!](https://img.shields.io/badge/KLOC-4.308-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue)][🧮kloc] |
233+
| 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] |
234+
| 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-img]][📄ilo-declaration] [![Security Policy][🔐security-img]][🔐security] [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct] [![SemVer 2.0.0][📌semver-img]][📌semver] |
235+
| 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] |
236+
| 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] |
237+
| `...` 💖 | [![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] |
238238

239239
### Compatibility
240240

241241
Compatible with MRI Ruby 3.2.0+, and concordant releases of JRuby, and TruffleRuby.
242242

243-
| 🚚 *Amazing* test matrix was brought to you by | 🔎 appraisal2 🔎 and the color 💚 green 💚 |
244-
| --- | --- |
245-
| 👟 Check it out\! |[github.com/appraisal-rb/appraisal2][💎appraisal2]|
243+
| 🚚 *Amazing* test matrix was brought to you by | 🔎 appraisal2 🔎 and the color 💚 green 💚 |
244+
|------------------------------------------------|--------------------------------------------------------|
245+
| 👟 Check it out\! |[github.com/appraisal-rb/appraisal2][💎appraisal2]|
246246

247247
### Federated DVCS
248248

249249
<details markdown="1">
250250
<summary>Find this repo on federated forges (Coming soon!)</summary>
251251

252-
| Federated [DVCS][💎d-in-dvcs] Repository | Status | Issues | PRs | Wiki | CI | Discussions |
253-
| --- | --- | --- | --- | --- | --- | --- |
254-
| 🧪 [kettle-rb/bash-merge on GitLab][📜src-gl] | The Truth | [💚][🤝gl-issues] | [💚][🤝gl-pulls] | [💚][📜gl-wiki] | 🐭 Tiny Matrix ||
255-
| 🧊 [kettle-rb/bash-merge on CodeBerg][📜src-cb] | An Ethical Mirror ([Donate][🤝cb-donate]) | [💚][🤝cb-issues] | [💚][🤝cb-pulls] || ⭕️ No Matrix ||
256-
| 🐙 [kettle-rb/bash-merge on GitHub][📜src-gh] | Another Mirror | [💚][🤝gh-issues] | [💚][🤝gh-pulls] | [💚][📜gh-wiki] | 💯 Full Matrix | [💚][gh-discussions] |
257-
| 🎮️ [Discord Server][🖼️galtzo-discord] | [![Live Chat on Discord][✉️discord-invite-img-ftb]][🖼️galtzo-discord] | [Let's][🖼️galtzo-discord] | [talk][🖼️galtzo-discord] | [about][🖼️galtzo-discord] | [this][🖼️galtzo-discord] | [library\!][🖼️galtzo-discord] |
252+
| Federated [DVCS][💎d-in-dvcs] Repository | Status | Issues | PRs | Wiki | CI | Discussions |
253+
|-------------------------------------------------|------------------------------------------------------------------------|----------------------------|---------------------------|----------------------------|---------------------------|--------------------------------|
254+
| 🧪 [kettle-rb/bash-merge on GitLab][📜src-gl] | The Truth | [💚][🤝gl-issues] | [💚][🤝gl-pulls] | [💚][📜gl-wiki] | 🐭 Tiny Matrix | |
255+
| 🧊 [kettle-rb/bash-merge on CodeBerg][📜src-cb] | An Ethical Mirror ([Donate][🤝cb-donate]) | [💚][🤝cb-issues] | [💚][🤝cb-pulls] | | ⭕️ No Matrix | |
256+
| 🐙 [kettle-rb/bash-merge on GitHub][📜src-gh] | Another Mirror | [💚][🤝gh-issues] | [💚][🤝gh-pulls] | [💚][📜gh-wiki] | 💯 Full Matrix | [💚][gh-discussions] |
257+
| 🎮️ [Discord Server][🖼️galtzo-discord] | [![Live Chat on Discord][✉️discord-invite-img-ftb]][🖼️galtzo-discord] | [Let's][🖼️galtzo-discord] | [talk][🖼️galtzo-discord] | [about][🖼️galtzo-discord] | [this][🖼️galtzo-discord] | [library\!][🖼️galtzo-discord] |
258258

259259
</details>
260260

@@ -438,11 +438,11 @@ If the gem can't find the parser, check for versioned files and either:
438438
In addition to the tree-sitter parser library, you need a Ruby gem that provides
439439
bindings to tree-sitter. Choose **one** of the following based on your Ruby implementation:
440440

441-
| Gem | Ruby Support | Description |
442-
| --- | --- | --- |
443-
| [ruby\_tree\_sitter][ruby_tree_sitter] | MRI only | C extension bindings (recommended for MRI) |
444-
| [tree\_stump][tree_stump] | MRI (maybe JRuby) | Rust-based bindings via Rutie |
445-
| [ffi][ffi] | MRI, JRuby, TruffleRuby | Generic FFI bindings (used by tree\_haver's FFI backend) |
441+
| Gem | Ruby Support | Description |
442+
|----------------------------------------|-------------------------|----------------------------------------------------------|
443+
| [ruby\_tree\_sitter][ruby_tree_sitter] | MRI only | C extension bindings (recommended for MRI) |
444+
| [tree\_stump][tree_stump] | MRI (maybe JRuby) | Rust-based bindings via Rutie |
445+
| [ffi][ffi] | MRI, JRuby, TruffleRuby | Generic FFI bindings (used by tree\_haver's FFI backend) |
446446

447447
[ruby_tree_sitter]: https://github.com/Faveod/ruby_tree_sitter
448448
[tree_stump]: https://github.com/joker1007/tree_stump

docs/Bash.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ <h5 class="example_title"><div class='inline'><p>With debug information</p>
142142
</div>
143143

144144
<div id="footer">
145-
Generated on Thu Feb 19 09:34:31 2026 by
145+
Generated on Sat Feb 21 01:14:50 2026 by
146146
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
147147
0.9.38 (ruby-4.0.1).
148148
</div>

docs/Bash/Merge.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ <h2>
158158
</div>
159159

160160
<div id="footer">
161-
Generated on Thu Feb 19 09:34:31 2026 by
161+
Generated on Sat Feb 21 01:14:50 2026 by
162162
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
163163
0.9.38 (ruby-4.0.1).
164164
</div>

docs/Bash/Merge/CommentTracker.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1194,7 +1194,7 @@ <h3 class="signature " id="shebang?-instance_method">
11941194
</div>
11951195

11961196
<div id="footer">
1197-
Generated on Thu Feb 19 09:34:31 2026 by
1197+
Generated on Sat Feb 21 01:14:50 2026 by
11981198
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
11991199
0.9.38 (ruby-4.0.1).
12001200
</div>

docs/Bash/Merge/ConflictResolver.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -524,7 +524,7 @@ <h3 class="signature first" id="resolve-instance_method">
524524
</div>
525525

526526
<div id="footer">
527-
Generated on Thu Feb 19 09:34:31 2026 by
527+
Generated on Sat Feb 21 01:14:50 2026 by
528528
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
529529
0.9.38 (ruby-4.0.1).
530530
</div>

docs/Bash/Merge/DebugLogger.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ <h3 class="signature first" id="log_node-class_method">
268268
</div>
269269

270270
<div id="footer">
271-
Generated on Thu Feb 19 09:34:31 2026 by
271+
Generated on Sat Feb 21 01:14:50 2026 by
272272
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
273273
0.9.38 (ruby-4.0.1).
274274
</div>

docs/Bash/Merge/DestinationParseError.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ <h2>Constructor Details</h2>
162162
</div>
163163

164164
<div id="footer">
165-
Generated on Thu Feb 19 09:34:31 2026 by
165+
Generated on Sat Feb 21 01:14:50 2026 by
166166
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
167167
0.9.38 (ruby-4.0.1).
168168
</div>

docs/Bash/Merge/Emitter.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1857,7 +1857,7 @@ <h3 class="signature " id="to_bash-instance_method">
18571857
</div>
18581858

18591859
<div id="footer">
1860-
Generated on Thu Feb 19 09:34:31 2026 by
1860+
Generated on Sat Feb 21 01:14:50 2026 by
18611861
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
18621862
0.9.38 (ruby-4.0.1).
18631863
</div>

docs/Bash/Merge/Error.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ <h2>Overview</h2><div class="docstring">
125125
</div>
126126

127127
<div id="footer">
128-
Generated on Thu Feb 19 09:34:31 2026 by
128+
Generated on Sat Feb 21 01:14:50 2026 by
129129
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
130130
0.9.38 (ruby-4.0.1).
131131
</div>

docs/Bash/Merge/FileAnalysis.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1393,7 +1393,7 @@ <h3 class="signature " id="valid?-instance_method">
13931393
</div>
13941394

13951395
<div id="footer">
1396-
Generated on Thu Feb 19 09:34:31 2026 by
1396+
Generated on Sat Feb 21 01:14:50 2026 by
13971397
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
13981398
0.9.38 (ruby-4.0.1).
13991399
</div>

0 commit comments

Comments
 (0)