markdown-merge 1.0.3 → 7.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +0 -0
- data/LICENSE.md +13 -0
- data/README.md +99 -482
- data/lib/markdown/merge/backend_support.rb +200 -0
- data/lib/markdown/merge/cleanse/block_spacing.rb +18 -23
- data/lib/markdown/merge/cleanse/code_fence_spacing.rb +16 -16
- data/lib/markdown/merge/cleanse/condensed_link_refs.rb +36 -30
- data/lib/markdown/merge/cleanse/list_marker_duplication.rb +66 -0
- data/lib/markdown/merge/cleanse/templating_corruption.rb +86 -0
- data/lib/markdown/merge/cleanse.rb +5 -3
- data/lib/markdown/merge/code_block_match_refiner.rb +111 -0
- data/lib/markdown/merge/code_block_merger.rb +489 -47
- data/lib/markdown/merge/comment_tracker.rb +42 -0
- data/lib/markdown/merge/conflict_resolver.rb +77 -6
- data/lib/markdown/merge/debug_logger.rb +2 -2
- data/lib/markdown/merge/document_problems.rb +3 -3
- data/lib/markdown/merge/file_aligner.rb +433 -133
- data/lib/markdown/merge/file_analysis.rb +387 -51
- data/lib/markdown/merge/file_analysis_base.rb +188 -51
- data/lib/markdown/merge/gap_line_node.rb +14 -8
- data/lib/markdown/merge/link_definition_node.rb +5 -5
- data/lib/markdown/merge/link_parser.rb +60 -60
- data/lib/markdown/merge/link_reference_rehydrator.rb +14 -14
- data/lib/markdown/merge/list_match_refiner.rb +98 -0
- data/lib/markdown/merge/list_merger.rb +322 -0
- data/lib/markdown/merge/markdown_structure.rb +3 -3
- data/lib/markdown/merge/merge_result.rb +321 -4
- data/lib/markdown/merge/node_type_normalizer.rb +6 -6
- data/lib/markdown/merge/output_builder.rb +101 -19
- data/lib/markdown/merge/partial_template_merger.rb +248 -27
- data/lib/markdown/merge/preservation_support.rb +291 -0
- data/lib/markdown/merge/smart_merger.rb +62 -14
- data/lib/markdown/merge/smart_merger_base.rb +929 -60
- data/lib/markdown/merge/table_match_algorithm.rb +22 -27
- data/lib/markdown/merge/table_match_refiner.rb +6 -10
- data/lib/markdown/merge/version.rb +5 -4
- data/lib/markdown/merge/whitespace_normalizer.rb +25 -33
- data/lib/markdown/merge/wrapper_support.rb +194 -0
- data/lib/markdown/merge.rb +669 -122
- data/lib/markdown-merge.rb +9 -4
- data/sig/markdown/merge.rbs +3 -336
- data.tar.gz.sig +0 -0
- metadata +104 -93
- metadata.gz.sig +0 -0
- data/CHANGELOG.md +0 -308
- data/CITATION.cff +0 -20
- data/CODE_OF_CONDUCT.md +0 -134
- data/CONTRIBUTING.md +0 -227
- data/FUNDING.md +0 -74
- data/LICENSE.txt +0 -21
- data/REEK +0 -0
- data/RUBOCOP.md +0 -71
- data/SECURITY.md +0 -21
data/README.md
CHANGED
|
@@ -1,32 +1,25 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
[🖼️galtzo-i]: https://logos.galtzo.com/assets/images/galtzo-floss/avatar-192px.svg
|
|
4
|
-
[🖼️galtzo-discord]: https://discord.gg/3qme4XHNKN
|
|
5
|
-
[🖼️ruby-lang-i]: https://logos.galtzo.com/assets/images/ruby-lang/avatar-192px.svg
|
|
6
|
-
[🖼️ruby-lang]: https://www.ruby-lang.org/
|
|
7
|
-
[🖼️kettle-rb-i]: https://logos.galtzo.com/assets/images/kettle-rb/avatar-192px.svg
|
|
8
|
-
[🖼️kettle-rb]: https://github.com/kettle-rb
|
|
1
|
+
<a href="https://github.com/structuredmerge"><img alt="structuredmerge Logo by GitHub" src="https://github.com/structuredmerge.png?size=192" width="14%" align="right"/></a>
|
|
9
2
|
|
|
10
3
|
# ☯️ Markdown::Merge
|
|
11
4
|
|
|
12
|
-
[![Version][👽versioni]][👽
|
|
5
|
+
[![Version][👽versioni]][👽version] [![Ruby Users Forum][✉️ruby-forum-top-img]][✉️ruby-forum] [![GitHub tag (latest SemVer)][⛳️tag-img]][⛳️tag] [![License: AGPL-3.0-only OR PolyForm-Small-Business-1.0.0][📄license-img]][📄license] [![Total downloads][👽dl-ranki]][👽dl-rank] [![CI Current][🚎11-c-wfi]][🚎11-c-wf]
|
|
13
6
|
|
|
14
|
-
`if ci_badges.map(&:color).detect { it != "green"}` ☝️ [let me know][
|
|
7
|
+
`if ci_badges.map(&:color).detect { it != "green"}` ☝️ [let me know on Discord][✉️discord-invite] or [RubyForum][✉️ruby-forum], as I may have missed the notification.
|
|
15
8
|
|
|
16
|
-
|
|
9
|
+
---
|
|
17
10
|
|
|
18
11
|
`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.
|
|
19
12
|
|
|
20
|
-
[![
|
|
13
|
+
[![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 at ko-fi.com][🖇kofi-img]][🖇kofi]
|
|
21
14
|
|
|
22
|
-
<details>
|
|
23
|
-
|
|
15
|
+
<details markdown="1">
|
|
16
|
+
<summary>👣 How will this project approach the September 2025 hostile takeover of RubyGems? 🚑️</summary>
|
|
24
17
|
|
|
25
18
|
I've summarized my thoughts in [this blog post](https://dev.to/galtzo/hostile-takeover-of-rubygems-my-thoughts-5hlo).
|
|
26
19
|
|
|
27
20
|
</details>
|
|
28
21
|
|
|
29
|
-
## 🌻 Synopsis
|
|
22
|
+
## 🌻 Synopsis <a href="https://discord.gg/3qme4XHNKN"><img alt="Galtzo FLOSS Logo by Aboling0, CC BY-SA 4.0" src="https://logos.galtzo.com/assets/images/galtzo-floss/avatar-128px.svg" width="8%" align="right"/></a> <a href="https://ruby-toolbox.com"><img alt="ruby-lang Logo, Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5" src="https://logos.galtzo.com/assets/images/ruby-lang/avatar-128px.svg" width="8%" align="right"/></a>
|
|
30
23
|
|
|
31
24
|
Markdown::Merge provides **intelligent Markdown file merging** using tree\_haver backends. It can be used standalone or through parser-specific wrappers.
|
|
32
25
|
|
|
@@ -83,210 +76,47 @@ Signatures computed by default for common Markdown block elements:
|
|
|
83
76
|
| Thematic Break | `[:hrule]` | Horizontal rules always match |
|
|
84
77
|
| Footnote Definition | `[:footnote_definition, label]` | Footnotes match by label/name |
|
|
85
78
|
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
The `*-merge` gem family provides intelligent, AST-based merging for various file formats. At the foundation is [tree_haver][tree_haver], which provides a unified cross-Ruby parsing API that works seamlessly across MRI, JRuby, and TruffleRuby.
|
|
89
|
-
|
|
90
|
-
| Gem | Version / CI | Language<br>/ Format | Parser Backend(s) | Description |
|
|
91
|
-
|------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------:|----------------------|-------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|
|
|
92
|
-
| [tree_haver][tree_haver] | [![Version][tree_haver-gem-i]][tree_haver-gem] <br/> [![CI][tree_haver-ci-i]][tree_haver-ci] | Multi | Supported Backends: MRI C, Rust, FFI, Java, Prism, Psych, Commonmarker, Markly, Citrus, Parslet | **Foundation**: Cross-Ruby adapter for parsing libraries (like Faraday for HTTP) |
|
|
93
|
-
| [ast-merge][ast-merge] | [![Version][ast-merge-gem-i]][ast-merge-gem] <br/> [![CI][ast-merge-ci-i]][ast-merge-ci] | Text | internal | **Infrastructure**: Shared base classes and merge logic for all `*-merge` gems |
|
|
94
|
-
| [bash-merge][bash-merge] | [![Version][bash-merge-gem-i]][bash-merge-gem] <br/> [![CI][bash-merge-ci-i]][bash-merge-ci] | Bash | [tree-sitter-bash][ts-bash] (via tree_haver) | Smart merge for Bash scripts |
|
|
95
|
-
| [commonmarker-merge][commonmarker-merge] | [![Version][commonmarker-merge-gem-i]][commonmarker-merge-gem] <br/> [![CI][commonmarker-merge-ci-i]][commonmarker-merge-ci] | Markdown | [Commonmarker][commonmarker] (via tree_haver) | Smart merge for Markdown (CommonMark via comrak Rust) |
|
|
96
|
-
| [dotenv-merge][dotenv-merge] | [![Version][dotenv-merge-gem-i]][dotenv-merge-gem] <br/> [![CI][dotenv-merge-ci-i]][dotenv-merge-ci] | Dotenv | internal | Smart merge for `.env` files |
|
|
97
|
-
| [json-merge][json-merge] | [![Version][json-merge-gem-i]][json-merge-gem] <br/> [![CI][json-merge-ci-i]][json-merge-ci] | JSON | [tree-sitter-json][ts-json] (via tree_haver) | Smart merge for JSON files |
|
|
98
|
-
| [jsonc-merge][jsonc-merge] | [![Version][jsonc-merge-gem-i]][jsonc-merge-gem] <br/> [![CI][jsonc-merge-ci-i]][jsonc-merge-ci] | JSONC | [tree-sitter-jsonc][ts-jsonc] (via tree_haver) | ⚠️ Proof of concept; Smart merge for JSON with Comments |
|
|
99
|
-
| [markdown-merge][markdown-merge] | [![Version][markdown-merge-gem-i]][markdown-merge-gem] <br/> [![CI][markdown-merge-ci-i]][markdown-merge-ci] | Markdown | [Commonmarker][commonmarker] / [Markly][markly] (via tree_haver), [Parslet][parslet] | **Foundation**: Shared base for Markdown mergers with inner code block merging |
|
|
100
|
-
| [markly-merge][markly-merge] | [![Version][markly-merge-gem-i]][markly-merge-gem] <br/> [![CI][markly-merge-ci-i]][markly-merge-ci] | Markdown | [Markly][markly] (via tree_haver) | Smart merge for Markdown (CommonMark via cmark-gfm C) |
|
|
101
|
-
| [prism-merge][prism-merge] | [![Version][prism-merge-gem-i]][prism-merge-gem] <br/> [![CI][prism-merge-ci-i]][prism-merge-ci] | Ruby | [Prism][prism] (`prism` std lib gem) | Smart merge for Ruby source files |
|
|
102
|
-
| [psych-merge][psych-merge] | [![Version][psych-merge-gem-i]][psych-merge-gem] <br/> [![CI][psych-merge-ci-i]][psych-merge-ci] | YAML | [Psych][psych] (`psych` std lib gem) | Smart merge for YAML files |
|
|
103
|
-
| [rbs-merge][rbs-merge] | [![Version][rbs-merge-gem-i]][rbs-merge-gem] <br/> [![CI][rbs-merge-ci-i]][rbs-merge-ci] | RBS | [tree-sitter-bash][ts-rbs] (via tree_haver), [RBS][rbs] (`rbs` std lib gem) | Smart merge for Ruby type signatures |
|
|
104
|
-
| [toml-merge][toml-merge] | [![Version][toml-merge-gem-i]][toml-merge-gem] <br/> [![CI][toml-merge-ci-i]][toml-merge-ci] | TOML | [Parslet + toml][toml], [Citrus + toml-rb][toml-rb], [tree-sitter-toml][ts-toml] (all via tree_haver) | Smart merge for TOML files |
|
|
105
|
-
|
|
106
|
-
#### Backend Platform Compatibility
|
|
107
|
-
|
|
108
|
-
tree_haver supports multiple parsing backends, but not all backends work on all Ruby platforms:
|
|
109
|
-
|
|
110
|
-
| Platform 👉️<br> TreeHaver Backend 👇️ | MRI | JRuby | TruffleRuby | Notes |
|
|
111
|
-
|-------------------------------------------------|:---:|:-----:|:-----------:|----------------------------------------------------------------------------|
|
|
112
|
-
| **MRI** ([ruby_tree_sitter][ruby_tree_sitter]) | ✅ | ❌ | ❌ | C extension, MRI only |
|
|
113
|
-
| **Rust** ([tree_stump][tree_stump]) | ✅ | ❌ | ❌ | Rust extension via magnus/rb-sys, MRI only |
|
|
114
|
-
| **FFI** ([ffi][ffi]) | ✅ | ✅ | ❌ | TruffleRuby's FFI doesn't support `STRUCT_BY_VALUE` |
|
|
115
|
-
| **Java** ([jtreesitter][jtreesitter]) | ❌ | ✅ | ❌ | JRuby only, requires grammar JARs |
|
|
116
|
-
| **Prism** ([prism][prism]) | ✅ | ✅ | ✅ | Ruby parsing, stdlib in Ruby 3.4+ |
|
|
117
|
-
| **Psych** ([psych][psych]) | ✅ | ✅ | ✅ | YAML parsing, stdlib |
|
|
118
|
-
| **Citrus** ([citrus][citrus]) | ✅ | ✅ | ✅ | Pure Ruby PEG parser, no native dependencies |
|
|
119
|
-
| **Parslet** ([parslet][parslet]) | ✅ | ✅ | ✅ | Pure Ruby PEG parser, no native dependencies |
|
|
120
|
-
| **Commonmarker** ([commonmarker][commonmarker]) | ✅ | ❌ | ❓ | Rust extension for Markdown (via [commonmarker-merge][commonmarker-merge]) |
|
|
121
|
-
| **Markly** ([markly][markly]) | ✅ | ❌ | ❓ | C extension for Markdown (via [markly-merge][markly-merge]) |
|
|
122
|
-
|
|
123
|
-
**Legend**: ✅ = Works, ❌ = Does not work, ❓ = Untested
|
|
124
|
-
|
|
125
|
-
**Why some backends don't work on certain platforms**:
|
|
126
|
-
|
|
127
|
-
- **JRuby**: Runs on the JVM; cannot load native C/Rust extensions (`.so` files)
|
|
128
|
-
- **TruffleRuby**: Has C API emulation via Sulong/LLVM, but it doesn't expose all MRI internals that native extensions require (e.g., `RBasic.flags`, `rb_gc_writebarrier`)
|
|
129
|
-
- **FFI on TruffleRuby**: TruffleRuby's FFI implementation doesn't support returning structs by value, which tree-sitter's C API requires
|
|
130
|
-
|
|
131
|
-
**Example implementations** for the gem templating use case:
|
|
132
|
-
|
|
133
|
-
| Gem | Purpose | Description |
|
|
134
|
-
|--------------------------|-----------------|-----------------------------------------------|
|
|
135
|
-
| [kettle-dev][kettle-dev] | Gem Development | Gem templating tool using `*-merge` gems |
|
|
136
|
-
| [kettle-jem][kettle-jem] | Gem Templating | Gem template library with smart merge support |
|
|
137
|
-
|
|
138
|
-
[tree_haver]: https://github.com/kettle-rb/tree_haver
|
|
139
|
-
[ast-merge]: https://github.com/kettle-rb/ast-merge
|
|
140
|
-
[prism-merge]: https://github.com/kettle-rb/prism-merge
|
|
141
|
-
[psych-merge]: https://github.com/kettle-rb/psych-merge
|
|
142
|
-
[json-merge]: https://github.com/kettle-rb/json-merge
|
|
143
|
-
[jsonc-merge]: https://github.com/kettle-rb/jsonc-merge
|
|
144
|
-
[bash-merge]: https://github.com/kettle-rb/bash-merge
|
|
145
|
-
[rbs-merge]: https://github.com/kettle-rb/rbs-merge
|
|
146
|
-
[dotenv-merge]: https://github.com/kettle-rb/dotenv-merge
|
|
147
|
-
[toml-merge]: https://github.com/kettle-rb/toml-merge
|
|
148
|
-
[markdown-merge]: https://github.com/kettle-rb/markdown-merge
|
|
149
|
-
[markly-merge]: https://github.com/kettle-rb/markly-merge
|
|
150
|
-
[commonmarker-merge]: https://github.com/kettle-rb/commonmarker-merge
|
|
151
|
-
[kettle-dev]: https://github.com/kettle-rb/kettle-dev
|
|
152
|
-
[kettle-jem]: https://github.com/kettle-rb/kettle-jem
|
|
153
|
-
[tree_haver-gem]: https://bestgems.org/gems/tree_haver
|
|
154
|
-
[ast-merge-gem]: https://bestgems.org/gems/ast-merge
|
|
155
|
-
[prism-merge-gem]: https://bestgems.org/gems/prism-merge
|
|
156
|
-
[psych-merge-gem]: https://bestgems.org/gems/psych-merge
|
|
157
|
-
[json-merge-gem]: https://bestgems.org/gems/json-merge
|
|
158
|
-
[jsonc-merge-gem]: https://bestgems.org/gems/jsonc-merge
|
|
159
|
-
[bash-merge-gem]: https://bestgems.org/gems/bash-merge
|
|
160
|
-
[rbs-merge-gem]: https://bestgems.org/gems/rbs-merge
|
|
161
|
-
[dotenv-merge-gem]: https://bestgems.org/gems/dotenv-merge
|
|
162
|
-
[toml-merge-gem]: https://bestgems.org/gems/toml-merge
|
|
163
|
-
[markdown-merge-gem]: https://bestgems.org/gems/markdown-merge
|
|
164
|
-
[markly-merge-gem]: https://bestgems.org/gems/markly-merge
|
|
165
|
-
[commonmarker-merge-gem]: https://bestgems.org/gems/commonmarker-merge
|
|
166
|
-
[kettle-dev-gem]: https://bestgems.org/gems/kettle-dev
|
|
167
|
-
[kettle-jem-gem]: https://bestgems.org/gems/kettle-jem
|
|
168
|
-
[tree_haver-gem-i]: https://img.shields.io/gem/v/tree_haver.svg
|
|
169
|
-
[ast-merge-gem-i]: https://img.shields.io/gem/v/ast-merge.svg
|
|
170
|
-
[prism-merge-gem-i]: https://img.shields.io/gem/v/prism-merge.svg
|
|
171
|
-
[psych-merge-gem-i]: https://img.shields.io/gem/v/psych-merge.svg
|
|
172
|
-
[json-merge-gem-i]: https://img.shields.io/gem/v/json-merge.svg
|
|
173
|
-
[jsonc-merge-gem-i]: https://img.shields.io/gem/v/jsonc-merge.svg
|
|
174
|
-
[bash-merge-gem-i]: https://img.shields.io/gem/v/bash-merge.svg
|
|
175
|
-
[rbs-merge-gem-i]: https://img.shields.io/gem/v/rbs-merge.svg
|
|
176
|
-
[dotenv-merge-gem-i]: https://img.shields.io/gem/v/dotenv-merge.svg
|
|
177
|
-
[toml-merge-gem-i]: https://img.shields.io/gem/v/toml-merge.svg
|
|
178
|
-
[markdown-merge-gem-i]: https://img.shields.io/gem/v/markdown-merge.svg
|
|
179
|
-
[markly-merge-gem-i]: https://img.shields.io/gem/v/markly-merge.svg
|
|
180
|
-
[commonmarker-merge-gem-i]: https://img.shields.io/gem/v/commonmarker-merge.svg
|
|
181
|
-
[kettle-dev-gem-i]: https://img.shields.io/gem/v/kettle-dev.svg
|
|
182
|
-
[kettle-jem-gem-i]: https://img.shields.io/gem/v/kettle-jem.svg
|
|
183
|
-
[tree_haver-ci-i]: https://github.com/kettle-rb/tree_haver/actions/workflows/current.yml/badge.svg
|
|
184
|
-
[ast-merge-ci-i]: https://github.com/kettle-rb/ast-merge/actions/workflows/current.yml/badge.svg
|
|
185
|
-
[prism-merge-ci-i]: https://github.com/kettle-rb/prism-merge/actions/workflows/current.yml/badge.svg
|
|
186
|
-
[psych-merge-ci-i]: https://github.com/kettle-rb/psych-merge/actions/workflows/current.yml/badge.svg
|
|
187
|
-
[json-merge-ci-i]: https://github.com/kettle-rb/json-merge/actions/workflows/current.yml/badge.svg
|
|
188
|
-
[jsonc-merge-ci-i]: https://github.com/kettle-rb/jsonc-merge/actions/workflows/current.yml/badge.svg
|
|
189
|
-
[bash-merge-ci-i]: https://github.com/kettle-rb/bash-merge/actions/workflows/current.yml/badge.svg
|
|
190
|
-
[rbs-merge-ci-i]: https://github.com/kettle-rb/rbs-merge/actions/workflows/current.yml/badge.svg
|
|
191
|
-
[dotenv-merge-ci-i]: https://github.com/kettle-rb/dotenv-merge/actions/workflows/current.yml/badge.svg
|
|
192
|
-
[toml-merge-ci-i]: https://github.com/kettle-rb/toml-merge/actions/workflows/current.yml/badge.svg
|
|
193
|
-
[markdown-merge-ci-i]: https://github.com/kettle-rb/markdown-merge/actions/workflows/current.yml/badge.svg
|
|
194
|
-
[markly-merge-ci-i]: https://github.com/kettle-rb/markly-merge/actions/workflows/current.yml/badge.svg
|
|
195
|
-
[commonmarker-merge-ci-i]: https://github.com/kettle-rb/commonmarker-merge/actions/workflows/current.yml/badge.svg
|
|
196
|
-
[kettle-dev-ci-i]: https://github.com/kettle-rb/kettle-dev/actions/workflows/current.yml/badge.svg
|
|
197
|
-
[kettle-jem-ci-i]: https://github.com/kettle-rb/kettle-jem/actions/workflows/current.yml/badge.svg
|
|
198
|
-
[tree_haver-ci]: https://github.com/kettle-rb/tree_haver/actions/workflows/current.yml
|
|
199
|
-
[ast-merge-ci]: https://github.com/kettle-rb/ast-merge/actions/workflows/current.yml
|
|
200
|
-
[prism-merge-ci]: https://github.com/kettle-rb/prism-merge/actions/workflows/current.yml
|
|
201
|
-
[psych-merge-ci]: https://github.com/kettle-rb/psych-merge/actions/workflows/current.yml
|
|
202
|
-
[json-merge-ci]: https://github.com/kettle-rb/json-merge/actions/workflows/current.yml
|
|
203
|
-
[jsonc-merge-ci]: https://github.com/kettle-rb/jsonc-merge/actions/workflows/current.yml
|
|
204
|
-
[bash-merge-ci]: https://github.com/kettle-rb/bash-merge/actions/workflows/current.yml
|
|
205
|
-
[rbs-merge-ci]: https://github.com/kettle-rb/rbs-merge/actions/workflows/current.yml
|
|
206
|
-
[dotenv-merge-ci]: https://github.com/kettle-rb/dotenv-merge/actions/workflows/current.yml
|
|
207
|
-
[toml-merge-ci]: https://github.com/kettle-rb/toml-merge/actions/workflows/current.yml
|
|
208
|
-
[markdown-merge-ci]: https://github.com/kettle-rb/markdown-merge/actions/workflows/current.yml
|
|
209
|
-
[markly-merge-ci]: https://github.com/kettle-rb/markly-merge/actions/workflows/current.yml
|
|
210
|
-
[commonmarker-merge-ci]: https://github.com/kettle-rb/commonmarker-merge/actions/workflows/current.yml
|
|
211
|
-
[kettle-dev-ci]: https://github.com/kettle-rb/kettle-dev/actions/workflows/current.yml
|
|
212
|
-
[kettle-jem-ci]: https://github.com/kettle-rb/kettle-jem/actions/workflows/current.yml
|
|
213
|
-
[prism]: https://github.com/ruby/prism
|
|
214
|
-
[psych]: https://github.com/ruby/psych
|
|
215
|
-
[ffi]: https://github.com/ffi/ffi
|
|
216
|
-
[ts-json]: https://github.com/tree-sitter/tree-sitter-json
|
|
217
|
-
[ts-jsonc]: https://gitlab.com/WhyNotHugo/tree-sitter-jsonc
|
|
218
|
-
[ts-bash]: https://github.com/tree-sitter/tree-sitter-bash
|
|
219
|
-
[ts-rbs]: https://github.com/joker1007/tree-sitter-rbs
|
|
220
|
-
[ts-toml]: https://github.com/tree-sitter-grammars/tree-sitter-toml
|
|
221
|
-
[dotenv]: https://github.com/bkeepers/dotenv
|
|
222
|
-
[rbs]: https://github.com/ruby/rbs
|
|
223
|
-
[toml-rb]: https://github.com/emancu/toml-rb
|
|
224
|
-
[toml]: https://github.com/jm/toml
|
|
225
|
-
[markly]: https://github.com/ioquatix/markly
|
|
226
|
-
[commonmarker]: https://github.com/gjtorikian/commonmarker
|
|
227
|
-
[ruby_tree_sitter]: https://github.com/Faveod/ruby-tree-sitter
|
|
228
|
-
[tree_stump]: https://github.com/joker1007/tree_stump
|
|
229
|
-
[jtreesitter]: https://central.sonatype.com/artifact/io.github.tree-sitter/jtreesitter
|
|
230
|
-
[citrus]: https://github.com/mjackson/citrus
|
|
231
|
-
[parslet]: https://github.com/kschiess/parslet
|
|
79
|
+
[commonmarker-merge]: https://github.com/structuredmerge/structuredmerge-ruby/tree/main/gems/commonmarker-merge
|
|
80
|
+
[markly-merge]: https://github.com/structuredmerge/structuredmerge-ruby/tree/main/gems/markly-merge
|
|
232
81
|
|
|
233
82
|
## 💡 Info you can shake a stick at
|
|
234
83
|
|
|
235
|
-
| Tokens to Remember | [![Gem name][⛳️name-img]][
|
|
236
|
-
|
|
237
|
-
| Works with
|
|
238
|
-
|
|
|
239
|
-
|
|
|
240
|
-
| 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] |
|
|
241
|
-
| 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] |
|
|
84
|
+
| Tokens to Remember | [![Gem name][⛳️name-img]][⛳️gem-name] [![Gem namespace][⛳️namespace-img]][⛳️gem-namespace] |
|
|
85
|
+
|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
86
|
+
| Works with MRI Ruby 4 | [![Ruby current Compat][💎ruby-c-i]][🚎11-c-wf]|
|
|
87
|
+
| Support & Community | [![Join Me on Daily.dev's RubyFriends][✉️ruby-friends-img]][✉️ruby-friends] [![Get help from RubyForum][✉️ruby-forum-img]][✉️ruby-forum] [![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] |
|
|
88
|
+
| 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] |
|
|
242
89
|
| 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] |
|
|
243
|
-
| Compliance | [![License:
|
|
90
|
+
| Compliance | [![License: AGPL-3.0-only OR PolyForm-Small-Business-1.0.0][📄license-img]][📄license] [![Apache license compatibility: Category X][📄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] |
|
|
244
91
|
| 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] |
|
|
245
92
|
| 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] |
|
|
246
|
-
| `...` 💖 | [![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]
|
|
93
|
+
| `...` 💖 | [![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] |
|
|
247
94
|
|
|
248
95
|
### Compatibility
|
|
249
96
|
|
|
250
|
-
Compatible with MRI Ruby
|
|
97
|
+
Compatible with MRI Ruby 4.0.0+, and concordant releases of JRuby, and TruffleRuby.
|
|
98
|
+
CI workflows and Appraisals are generated for MRI Ruby 4.0.0+.
|
|
99
|
+
This test floor is configured by `ruby.test_minimum` in `.kettle-jem.yml` and
|
|
100
|
+
may be higher than the gem's runtime compatibility floor when legacy Rubies are
|
|
101
|
+
not practical for the current toolchain.
|
|
251
102
|
|
|
252
|
-
|
|
253
|
-
| --- | --- |
|
|
254
|
-
| 👟 Check it out\! | ✨ [github.com/appraisal-rb/appraisal2][💎appraisal2] ✨ |
|
|
103
|
+
<a href="https://github.com/kettle-dev"><img alt="kettle-dev Logo by Aboling0, CC BY-SA 4.0" src="https://logos.galtzo.com/assets/images/kettle-dev/avatar-128px.svg" width="14%" align="right"/></a>
|
|
255
104
|
|
|
256
|
-
|
|
105
|
+
The _amazing_ test matrix is powered by the kettle-dev stack.
|
|
257
106
|
|
|
258
107
|
<details markdown="1">
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
|
262
|
-
|
|
263
|
-
|
|
|
264
|
-
|
|
|
265
|
-
|
|
|
266
|
-
|
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
[
|
|
271
|
-
|
|
272
|
-
### Enterprise Support [][🏙️entsup-tidelift]
|
|
273
|
-
|
|
274
|
-
Available as part of the Tidelift Subscription.
|
|
275
|
-
|
|
276
|
-
<details markdown="1">
|
|
277
|
-
<summary>Need enterprise-level guarantees?</summary>
|
|
278
|
-
|
|
279
|
-
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.
|
|
280
|
-
|
|
281
|
-
[![Get help from me on Tidelift][🏙️entsup-tidelift-img]][🏙️entsup-tidelift]
|
|
282
|
-
|
|
283
|
-
- 💡Subscribe for support guarantees covering *all* your FLOSS dependencies
|
|
284
|
-
- 💡Tidelift is part of [Sonar][🏙️entsup-tidelift-sonar]
|
|
285
|
-
- 💡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
|
|
286
|
-
Alternatively:
|
|
287
|
-
- [![Live Chat on Discord][✉️discord-invite-img-ftb]][🖼️galtzo-discord]
|
|
288
|
-
- [![Get help from me on Upwork][👨🏼🏫expsup-upwork-img]][👨🏼🏫expsup-upwork]
|
|
289
|
-
- [![Get help from me on Codementor][👨🏼🏫expsup-codementor-img]][👨🏼🏫expsup-codementor]
|
|
108
|
+
<summary>How kettle-dev manages complexity in tests</summary>
|
|
109
|
+
|
|
110
|
+
| Gem | Source | Role | Total downloads |
|
|
111
|
+
|-----|--------|------|---------------------|
|
|
112
|
+
| [appraisal2](https://clickgems.clickhouse.com/dashboard/appraisal2) | [GitHub](https://github.com/appraisal-rb/appraisal2) | multi-dependency Appraisal matrix generation | [](https://clickgems.clickhouse.com/dashboard/appraisal2) |
|
|
113
|
+
| [appraisal2-rubocop](https://clickgems.clickhouse.com/dashboard/appraisal2-rubocop) | [GitHub](https://github.com/appraisal-rb/appraisal2-rubocop) | RuboCop Appraisal generator integration | [](https://clickgems.clickhouse.com/dashboard/appraisal2-rubocop) |
|
|
114
|
+
| [kettle-dev](https://clickgems.clickhouse.com/dashboard/kettle-dev) | [GitHub](https://github.com/kettle-dev/kettle-dev) | development, release, and CI workflow tooling | [](https://clickgems.clickhouse.com/dashboard/kettle-dev) |
|
|
115
|
+
| [kettle-jem](https://clickgems.clickhouse.com/dashboard/kettle-jem) | [GitHub](https://github.com/kettle-dev/kettle-jem) | Appraisals & CI workflow templates | [](https://clickgems.clickhouse.com/dashboard/kettle-jem) |
|
|
116
|
+
| [kettle-soup-cover](https://clickgems.clickhouse.com/dashboard/kettle-soup-cover) | [GitHub](https://github.com/kettle-dev/kettle-soup-cover) | SimpleCov coverage policy and reporting | [](https://clickgems.clickhouse.com/dashboard/kettle-soup-cover) |
|
|
117
|
+
| [kettle-test](https://clickgems.clickhouse.com/dashboard/kettle-test) | [GitHub](https://github.com/kettle-dev/kettle-test) | standard test runner and coverage harness | [](https://clickgems.clickhouse.com/dashboard/kettle-test) |
|
|
118
|
+
| [rubocop-lts](https://clickgems.clickhouse.com/dashboard/rubocop-lts) | [GitHub](https://github.com/rubocop-lts/rubocop-lts) | Ruby-version-aware linting | [](https://clickgems.clickhouse.com/dashboard/rubocop-lts) |
|
|
119
|
+
| [turbo_tests2](https://clickgems.clickhouse.com/dashboard/turbo_tests2) | [GitHub](https://github.com/galtzo-floss/turbo_tests2) | parallel test execution | [](https://clickgems.clickhouse.com/dashboard/turbo_tests2) |
|
|
290
120
|
|
|
291
121
|
</details>
|
|
292
122
|
|
|
@@ -304,41 +134,6 @@ If bundler is not being used to manage dependencies, install the gem by executin
|
|
|
304
134
|
gem install markdown-merge
|
|
305
135
|
```
|
|
306
136
|
|
|
307
|
-
### 🔒 Secure Installation
|
|
308
|
-
|
|
309
|
-
<details markdown="1">
|
|
310
|
-
<summary>For Medium or High Security Installations</summary>
|
|
311
|
-
|
|
312
|
-
This gem is cryptographically signed, and has verifiable [SHA-256 and SHA-512][💎SHA_checksums] checksums by
|
|
313
|
-
[stone\_checksums][💎stone_checksums]. Be sure the gem you install hasn’t been tampered with
|
|
314
|
-
by following the instructions below.
|
|
315
|
-
|
|
316
|
-
Add my public key (if you haven’t already, expires 2045-04-29) as a trusted certificate:
|
|
317
|
-
|
|
318
|
-
```console
|
|
319
|
-
gem cert --add <(curl -Ls https://raw.github.com/galtzo-floss/certs/main/pboling.pem)
|
|
320
|
-
```
|
|
321
|
-
|
|
322
|
-
You only need to do that once. Then proceed to install with:
|
|
323
|
-
|
|
324
|
-
```console
|
|
325
|
-
gem install markdown-merge -P HighSecurity
|
|
326
|
-
```
|
|
327
|
-
|
|
328
|
-
The `HighSecurity` trust profile will verify signed gems, and not allow the installation of unsigned dependencies.
|
|
329
|
-
|
|
330
|
-
If you want to up your security game full-time:
|
|
331
|
-
|
|
332
|
-
```console
|
|
333
|
-
bundle config set --global trust-policy MediumSecurity
|
|
334
|
-
```
|
|
335
|
-
|
|
336
|
-
`MediumSecurity` instead of `HighSecurity` is necessary if not all the gems you use are signed.
|
|
337
|
-
|
|
338
|
-
NOTE: Be prepared to track down certs for signed gems and add them the same way you added mine.
|
|
339
|
-
|
|
340
|
-
</details>
|
|
341
|
-
|
|
342
137
|
## ⚙️ Configuration
|
|
343
138
|
|
|
344
139
|
### SmartMerger Configuration
|
|
@@ -470,7 +265,6 @@ require "markly/merge"
|
|
|
470
265
|
merger = Markly::Merge::SmartMerger.new(template, dest, flags: Markly::DEFAULT, extensions: [:table])
|
|
471
266
|
```
|
|
472
267
|
|
|
473
|
-
````
|
|
474
268
|
### Freeze Blocks
|
|
475
269
|
|
|
476
270
|
Freeze blocks protect sections from being modified during merges. They are marked
|
|
@@ -478,13 +272,14 @@ with HTML comments that are invisible when the Markdown is rendered:
|
|
|
478
272
|
|
|
479
273
|
```markdown
|
|
480
274
|
<!-- markdown-merge:freeze -->
|
|
275
|
+
|
|
481
276
|
## This Section Is Protected
|
|
482
277
|
|
|
483
278
|
Any content here will be preserved exactly as-is during merges.
|
|
484
279
|
The merge tool will not modify, replace, or remove this content.
|
|
485
280
|
|
|
486
281
|
<!-- markdown-merge:unfreeze -->
|
|
487
|
-
|
|
282
|
+
```
|
|
488
283
|
|
|
489
284
|
Add an optional frozen reason to document why:
|
|
490
285
|
|
|
@@ -521,7 +316,9 @@ Example with a Ruby code block:
|
|
|
521
316
|
|
|
522
317
|
````markdown
|
|
523
318
|
```ruby
|
|
319
|
+
|
|
524
320
|
# Template
|
|
321
|
+
|
|
525
322
|
class MyClass
|
|
526
323
|
def new_method
|
|
527
324
|
puts "from template"
|
|
@@ -534,7 +331,9 @@ When merged(with:
|
|
|
534
331
|
|
|
535
332
|
````markdown
|
|
536
333
|
```ruby
|
|
334
|
+
|
|
537
335
|
# Destination
|
|
336
|
+
|
|
538
337
|
class MyClass
|
|
539
338
|
def existing_method
|
|
540
339
|
puts "custom"
|
|
@@ -603,8 +402,9 @@ export MARKDOWN_MERGE_DEBUG=1
|
|
|
603
402
|
|
|
604
403
|
Use a parser-specific implementation:
|
|
605
404
|
|
|
405
|
+
#### Option 1: Using commonmarker-merge (Comrak/Rust)
|
|
406
|
+
|
|
606
407
|
```ruby
|
|
607
|
-
# Option 1: Using commonmarker-merge (Comrak/Rust)
|
|
608
408
|
require "commonmarker/merge"
|
|
609
409
|
|
|
610
410
|
template = File.read("template.md")
|
|
@@ -616,8 +416,9 @@ result = merger.merge
|
|
|
616
416
|
File.write("merged.md", result.content)
|
|
617
417
|
```
|
|
618
418
|
|
|
419
|
+
#### Option 2: Using markly-merge (libcmark-gfm/C)
|
|
420
|
+
|
|
619
421
|
```ruby
|
|
620
|
-
# Option 2: Using markly-merge (libcmark-gfm/C)
|
|
621
422
|
require "markly/merge"
|
|
622
423
|
|
|
623
424
|
template = File.read("template.md")
|
|
@@ -680,6 +481,7 @@ end
|
|
|
680
481
|
Both implementations support freeze blocks for protecting customized sections:
|
|
681
482
|
|
|
682
483
|
```markdown
|
|
484
|
+
|
|
683
485
|
# My Project
|
|
684
486
|
|
|
685
487
|
## Installation
|
|
@@ -697,63 +499,6 @@ Standard usage section - can be updated from template.
|
|
|
697
499
|
Content between freeze markers is always preserved from the destination file,
|
|
698
500
|
even when the template has different content for that section.
|
|
699
501
|
|
|
700
|
-
## 🦷 FLOSS Funding
|
|
701
|
-
|
|
702
|
-
While kettle-rb tools are free software and will always be, the project would benefit immensely from some funding.
|
|
703
|
-
Raising a monthly budget of... "dollars" would make the project more sustainable.
|
|
704
|
-
|
|
705
|
-
We welcome both individual and corporate sponsors\! We also offer a
|
|
706
|
-
wide array of funding channels to account for your preferences
|
|
707
|
-
(although currently [Open Collective][🖇osc] is our preferred funding platform).
|
|
708
|
-
|
|
709
|
-
**If you're working in a company that's making significant use of kettle-rb tools we'd
|
|
710
|
-
appreciate it if you suggest to your company to become a kettle-rb sponsor.**
|
|
711
|
-
|
|
712
|
-
You can support the development of kettle-rb tools via
|
|
713
|
-
[GitHub Sponsors][🖇sponsor],
|
|
714
|
-
[Liberapay][⛳liberapay],
|
|
715
|
-
[PayPal][🖇paypal],
|
|
716
|
-
[Open Collective][🖇osc]
|
|
717
|
-
and [Tidelift][🏙️entsup-tidelift].
|
|
718
|
-
|
|
719
|
-
| 📍 NOTE |
|
|
720
|
-
| --- |
|
|
721
|
-
| 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. |
|
|
722
|
-
|
|
723
|
-
### Open Collective for Individuals
|
|
724
|
-
|
|
725
|
-
Support us with a monthly donation and help us continue our activities. \[[Become a backer][🖇osc-backers]\]
|
|
726
|
-
|
|
727
|
-
NOTE: [kettle-readme-backers][kettle-readme-backers] updates this list every day, automatically.
|
|
728
|
-
|
|
729
|
-
<!-- OPENCOLLECTIVE-INDIVIDUALS:START -->
|
|
730
|
-
No backers yet. Be the first!
|
|
731
|
-
<!-- OPENCOLLECTIVE-INDIVIDUALS:END -->
|
|
732
|
-
|
|
733
|
-
### Open Collective for Organizations
|
|
734
|
-
|
|
735
|
-
Become a sponsor and get your logo on our README on GitHub with a link to your site. \[[Become a sponsor][🖇osc-sponsors]\]
|
|
736
|
-
|
|
737
|
-
NOTE: [kettle-readme-backers][kettle-readme-backers] updates this list every day, automatically.
|
|
738
|
-
|
|
739
|
-
<!-- OPENCOLLECTIVE-ORGANIZATIONS:START -->
|
|
740
|
-
No sponsors yet. Be the first!
|
|
741
|
-
<!-- OPENCOLLECTIVE-ORGANIZATIONS:END -->
|
|
742
|
-
|
|
743
|
-
[kettle-readme-backers]: https://github.com/kettle-rb/markdown-merge/blob/main/exe/kettle-readme-backers
|
|
744
|
-
|
|
745
|
-
### Another way to support open-source
|
|
746
|
-
|
|
747
|
-
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).
|
|
748
|
-
|
|
749
|
-
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`.
|
|
750
|
-
|
|
751
|
-
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.
|
|
752
|
-
|
|
753
|
-
**[Floss-Funding.dev][🖇floss-funding.dev]: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags**
|
|
754
|
-
|
|
755
|
-
[![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]
|
|
756
|
-
|
|
757
502
|
## 🔐 Security
|
|
758
503
|
|
|
759
504
|
See [SECURITY.md][🔐security].
|
|
@@ -761,78 +506,36 @@ See [SECURITY.md][🔐security].
|
|
|
761
506
|
## 🤝 Contributing
|
|
762
507
|
|
|
763
508
|
If you need some ideas of where to help, you could work on adding more code coverage,
|
|
764
|
-
or if it is already 💯 (see [below](#code-coverage)) check [
|
|
509
|
+
or if it is already 💯 (see [below](#code-coverage)) check [issues][🤝gh-issues] or [PRs][🤝gh-pulls],
|
|
765
510
|
or use the gem and think about how it could be better.
|
|
766
511
|
|
|
767
512
|
We [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] so if you make changes, remember to update it.
|
|
768
513
|
|
|
769
514
|
See [CONTRIBUTING.md][🤝contributing] for more detailed instructions.
|
|
770
515
|
|
|
771
|
-
### 🚀 Release Instructions
|
|
772
|
-
|
|
773
|
-
See [CONTRIBUTING.md][🤝contributing].
|
|
774
|
-
|
|
775
516
|
### Code Coverage
|
|
776
517
|
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
[![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls]
|
|
780
|
-
|
|
781
|
-
[![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov]
|
|
782
|
-
|
|
783
|
-
### 🪇 Code of Conduct
|
|
784
|
-
|
|
785
|
-
Everyone interacting with this project's codebases, issue trackers,
|
|
786
|
-
chat rooms and mailing lists agrees to follow the [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct].
|
|
787
|
-
|
|
788
|
-
## 🌈 Contributors
|
|
789
|
-
|
|
790
|
-
[![Contributors][🖐contributors-img]][🖐contributors]
|
|
791
|
-
|
|
792
|
-
Made with [contributors-img][🖐contrib-rocks].
|
|
793
|
-
|
|
794
|
-
Also see GitLab Contributors: <https://gitlab.com/kettle-rb/markdown-merge/-/graphs/main>
|
|
795
|
-
|
|
796
|
-
<details>
|
|
797
|
-
<summary>⭐️ Star History</summary>
|
|
798
|
-
|
|
799
|
-
<a href="https://star-history.com/#kettle-rb/markdown-merge&Date">
|
|
800
|
-
<picture>
|
|
801
|
-
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=kettle-rb/markdown-merge&type=Date&theme=dark" />
|
|
802
|
-
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=kettle-rb/markdown-merge&type=Date" />
|
|
803
|
-
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=kettle-rb/markdown-merge&type=Date" />
|
|
804
|
-
</picture>
|
|
805
|
-
</a>
|
|
518
|
+
<details markdown="1">
|
|
519
|
+
<summary>Coverage service badges</summary>
|
|
806
520
|
|
|
807
521
|
</details>
|
|
808
522
|
|
|
809
523
|
## 📌 Versioning
|
|
810
524
|
|
|
811
|
-
This
|
|
812
|
-
|
|
813
|
-
Specifically, if a minor or patch version is released that breaks backward compatibility,
|
|
814
|
-
a new version should be immediately released that restores compatibility.
|
|
815
|
-
Breaking changes to the public API will only be introduced with new major versions.
|
|
816
|
-
|
|
817
|
-
> dropping support for a platform is both obviously and objectively a breaking change <br/>
|
|
818
|
-
> —Jordan Harband ([@ljharb](https://github.com/ljharb), maintainer of SemVer) [in SemVer issue 716][📌semver-breaking]
|
|
819
|
-
|
|
820
|
-
I understand that policy doesn't work universally ("exceptions to every rule\!"),
|
|
821
|
-
but it is the policy here.
|
|
822
|
-
As such, in many cases it is good to specify a dependency on this library using
|
|
823
|
-
the [Pessimistic Version Constraint][📌pvc] with two digits of precision.
|
|
525
|
+
This library follows [![Semantic Versioning 2.0.0][📌semver-img]][📌semver] for its public API where practical.
|
|
526
|
+
For most applications, prefer the [Pessimistic Version Constraint][📌pvc] with two digits of precision.
|
|
824
527
|
|
|
825
528
|
For example:
|
|
826
529
|
|
|
827
530
|
```ruby
|
|
828
|
-
spec.add_dependency("markdown-merge", "~>
|
|
531
|
+
spec.add_dependency("markdown-merge", "~> 7.0")
|
|
829
532
|
```
|
|
830
533
|
|
|
831
534
|
<details markdown="1">
|
|
832
535
|
<summary>📌 Is "Platform Support" part of the public API? More details inside.</summary>
|
|
833
536
|
|
|
834
|
-
|
|
835
|
-
|
|
537
|
+
Dropping support for a platform can be a breaking change for affected users.
|
|
538
|
+
If a release changes supported platforms, it should be called out clearly in the changelog and versioned with that impact in mind.
|
|
836
539
|
|
|
837
540
|
To get a better understanding of how SemVer is intended to work over a project's lifetime,
|
|
838
541
|
read this article from the creator of SemVer:
|
|
@@ -845,68 +548,19 @@ See [CHANGELOG.md][📌changelog] for a list of releases.
|
|
|
845
548
|
|
|
846
549
|
## 📄 License
|
|
847
550
|
|
|
848
|
-
The gem is available
|
|
849
|
-
|
|
850
|
-
See [LICENSE.txt][📄license] for the official [Copyright Notice][📄copyright-notice-explainer].
|
|
851
|
-
|
|
852
|
-
### © Copyright
|
|
853
|
-
|
|
854
|
-
<ul>
|
|
855
|
-
<li>
|
|
856
|
-
Copyright (c) 2025 Peter H. Boling, of
|
|
857
|
-
<a href="https://discord.gg/3qme4XHNKN">
|
|
858
|
-
Galtzo.com
|
|
859
|
-
<picture>
|
|
860
|
-
<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">
|
|
861
|
-
</picture>
|
|
862
|
-
</a>, and markdown-merge contributors.
|
|
863
|
-
</li>
|
|
864
|
-
</ul>
|
|
865
|
-
|
|
866
|
-
## 🤑 A request for help
|
|
867
|
-
|
|
868
|
-
Maintainers have teeth and need to pay their dentists.
|
|
869
|
-
After getting laid off in an RIF in March, and encountering difficulty finding a new one,
|
|
870
|
-
I began spending most of my time building open source tools.
|
|
871
|
-
I'm hoping to be able to pay for my kids' health insurance this month,
|
|
872
|
-
so if you value the work I am doing, I need your support.
|
|
873
|
-
Please consider sponsoring me or the project.
|
|
874
|
-
|
|
875
|
-
To join the community or get help 👇️ Join the Discord.
|
|
876
|
-
|
|
877
|
-
[![Live Chat on Discord][✉️discord-invite-img-ftb]][🖼️galtzo-discord]
|
|
878
|
-
|
|
879
|
-
To say "thanks\!" ☝️ Join the Discord or 👇️ send money.
|
|
880
|
-
|
|
881
|
-
[![Sponsor kettle-rb/markdown-merge 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]
|
|
882
|
-
|
|
883
|
-
### Please give the project a star ⭐ ♥.
|
|
551
|
+
The gem is available under the following licenses: [AGPL-3.0-only](https://github.com/structuredmerge/structuredmerge-ruby/blob/main/AGPL-3.0-only.md), [PolyForm-Small-Business-1.0.0](https://github.com/structuredmerge/structuredmerge-ruby/blob/main/PolyForm-Small-Business-1.0.0.md).
|
|
552
|
+
See [LICENSE.md][📄license] for details.
|
|
884
553
|
|
|
885
|
-
|
|
554
|
+
If none of the available licenses suit your use case, please [contact us](mailto:floss@galtzo.com) to discuss a custom commercial license.
|
|
886
555
|
|
|
887
556
|
[⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay&color=a51611&style=flat
|
|
888
557
|
[⛳liberapay-bottom-img]: https://img.shields.io/liberapay/goal/pboling.svg?style=for-the-badge&logo=liberapay&color=a51611
|
|
889
558
|
[⛳liberapay]: https://liberapay.com/pboling/donate
|
|
890
|
-
[🖇osc-all-img]: https://img.shields.io/opencollective/all/kettle-rb
|
|
891
|
-
[🖇osc-sponsors-img]: https://img.shields.io/opencollective/sponsors/kettle-rb
|
|
892
|
-
[🖇osc-backers-img]: https://img.shields.io/opencollective/backers/kettle-rb
|
|
893
|
-
[🖇osc-backers]: https://opencollective.com/kettle-rb#backer
|
|
894
|
-
[🖇osc-backers-i]: https://opencollective.com/kettle-rb/backers/badge.svg?style=flat
|
|
895
|
-
[🖇osc-sponsors]: https://opencollective.com/kettle-rb#sponsor
|
|
896
|
-
[🖇osc-sponsors-i]: https://opencollective.com/kettle-rb/sponsors/badge.svg?style=flat
|
|
897
|
-
[🖇osc-all-bottom-img]: https://img.shields.io/opencollective/all/kettle-rb?style=for-the-badge
|
|
898
|
-
[🖇osc-sponsors-bottom-img]: https://img.shields.io/opencollective/sponsors/kettle-rb?style=for-the-badge
|
|
899
|
-
[🖇osc-backers-bottom-img]: https://img.shields.io/opencollective/backers/kettle-rb?style=for-the-badge
|
|
900
|
-
[🖇osc]: https://opencollective.com/kettle-rb
|
|
901
559
|
[🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
|
|
902
560
|
[🖇sponsor-bottom-img]: https://img.shields.io/badge/Sponsor_Me!-pboling-blue?style=for-the-badge&logo=github
|
|
903
561
|
[🖇sponsor]: https://github.com/sponsors/pboling
|
|
904
|
-
[🖇polar-img]: https://img.shields.io/badge/polar-donate-a51611.svg?style=flat
|
|
905
|
-
[🖇polar]: https://polar.sh/pboling
|
|
906
562
|
[🖇kofi-img]: https://img.shields.io/badge/ko--fi-%E2%9C%93-a51611.svg?style=flat
|
|
907
|
-
[🖇kofi]: https://ko-fi.com/
|
|
908
|
-
[🖇patreon-img]: https://img.shields.io/badge/patreon-donate-a51611.svg?style=flat
|
|
909
|
-
[🖇patreon]: https://patreon.com/galtzo
|
|
563
|
+
[🖇kofi]: https://ko-fi.com/pboling
|
|
910
564
|
[🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-%E2%9C%93-a51611.svg?style=flat
|
|
911
565
|
[🖇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
|
|
912
566
|
[🖇buyme]: https://www.buymeacoffee.com/pboling
|
|
@@ -919,19 +573,22 @@ Thanks for RTFM. ☺️
|
|
|
919
573
|
[✉️discord-invite-img-ftb]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge&logo=discord
|
|
920
574
|
[✉️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
|
|
921
575
|
[✉️ruby-friends]: https://app.daily.dev/squads/rubyfriends
|
|
576
|
+
[✉️ruby-forum-top-img]: https://img.shields.io/discourse/topics?server=https%3A%2F%2Fwww.rubyforum.org&style=flat&logo=discourse&label=Ruby%20Users%20Forum
|
|
577
|
+
[✉️ruby-forum-img]: https://img.shields.io/discourse/topics?server=https%3A%2F%2Fwww.rubyforum.org&style=for-the-badge&logo=discourse&label=Ruby%20Users%20Forum
|
|
578
|
+
[✉️ruby-forum]: https://www.rubyforum.org/tag/structuredmerge
|
|
922
579
|
[✇bundle-group-pattern]: https://gist.github.com/pboling/4564780
|
|
923
|
-
[⛳️gem-namespace]: https://github.com/
|
|
580
|
+
[⛳️gem-namespace]: https://github.com/structuredmerge/structuredmerge-ruby/tree/main/gems/markdown-merge
|
|
924
581
|
[⛳️namespace-img]: https://img.shields.io/badge/namespace-Markdown::Merge-3C2D2D.svg?style=square&logo=ruby&logoColor=white
|
|
925
|
-
[⛳️gem-name]: https://
|
|
582
|
+
[⛳️gem-name]: https://clickgems.clickhouse.com/dashboard/markdown-merge
|
|
926
583
|
[⛳️name-img]: https://img.shields.io/badge/name-markdown--merge-3C2D2D.svg?style=square&logo=rubygems&logoColor=red
|
|
927
|
-
[⛳️tag-img]: https://img.shields.io/github/tag/
|
|
928
|
-
[⛳️tag]:
|
|
584
|
+
[⛳️tag-img]: https://img.shields.io/github/tag/structuredmerge/structuredmerge-ruby.svg
|
|
585
|
+
[⛳️tag]: https://github.com/structuredmerge/structuredmerge-ruby/releases
|
|
929
586
|
[🚂maint-blog]: http://www.railsbling.com/tags/markdown-merge
|
|
930
587
|
[🚂maint-blog-img]: https://img.shields.io/badge/blog-railsbling-0093D0.svg?style=for-the-badge&logo=rubyonrails&logoColor=orange
|
|
931
588
|
[🚂maint-contact]: http://www.railsbling.com/contact
|
|
932
589
|
[🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
|
|
933
590
|
[💖🖇linkedin]: http://www.linkedin.com/in/peterboling
|
|
934
|
-
[💖🖇linkedin-img]: https://img.shields.io/badge/
|
|
591
|
+
[💖🖇linkedin-img]: https://img.shields.io/badge/LinkedIn-Profile-0B66C2?style=flat&logo=newjapanprowrestling
|
|
935
592
|
[💖✌️wellfound]: https://wellfound.com/u/peter-boling
|
|
936
593
|
[💖✌️wellfound-img]: https://img.shields.io/badge/peter--boling-orange?style=flat&logo=wellfound
|
|
937
594
|
[💖💲crunchbase]: https://www.crunchbase.com/person/peter-boling
|
|
@@ -960,103 +617,63 @@ Thanks for RTFM. ☺️
|
|
|
960
617
|
[💁🏼♂️peterboling]: http://www.peterboling.com
|
|
961
618
|
[🚂railsbling]: http://www.railsbling.com
|
|
962
619
|
[📜src-gl-img]: https://img.shields.io/badge/GitLab-FBA326?style=for-the-badge&logo=Gitlab&logoColor=orange
|
|
963
|
-
[📜src-gl]: https://gitlab.com/
|
|
620
|
+
[📜src-gl]: https://gitlab.com/structuredmerge/structuredmerge-ruby/-/tree/main/gems/markdown-merge
|
|
964
621
|
[📜src-cb-img]: https://img.shields.io/badge/CodeBerg-4893CC?style=for-the-badge&logo=CodeBerg&logoColor=blue
|
|
965
|
-
[📜src-cb]: https://codeberg.org/
|
|
966
|
-
[📜src-gh-img]: https://img.shields.io/badge/GitHub-238636?style=for-the-badge&logo=
|
|
967
|
-
[📜src-gh]: https://github.com/
|
|
622
|
+
[📜src-cb]: https://codeberg.org/structuredmerge/structuredmerge-ruby/src/branch/main/gems/markdown-merge
|
|
623
|
+
[📜src-gh-img]: https://img.shields.io/badge/GitHub-238636?style=for-the-badge&logo=GitHub&logoColor=green
|
|
624
|
+
[📜src-gh]: https://github.com/structuredmerge/structuredmerge-ruby/tree/main/gems/markdown-merge
|
|
968
625
|
[📜docs-cr-rd-img]: https://img.shields.io/badge/RubyDoc-Current_Release-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
|
|
969
626
|
[📜docs-head-rd-img]: https://img.shields.io/badge/YARD_on_Galtzo.com-HEAD-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
|
|
970
|
-
[📜gl-wiki]: https://gitlab.com/
|
|
971
|
-
[📜gh-wiki]: https://github.com/
|
|
972
|
-
[📜gl-wiki-img]: https://img.shields.io/badge/wiki-
|
|
973
|
-
[📜gh-wiki-img]: https://img.shields.io/badge/wiki-
|
|
974
|
-
[👽dl-rank]: https://
|
|
975
|
-
[👽dl-ranki]: https://img.shields.io/gem/
|
|
976
|
-
[👽
|
|
977
|
-
[👽oss-helpi]: https://www.codetriage.com/kettle-rb/markdown-merge/badges/users.svg
|
|
978
|
-
[👽version]: https://bestgems.org/gems/markdown-merge
|
|
627
|
+
[📜gl-wiki]: https://gitlab.com/structuredmerge/structuredmerge-ruby/-/wikis/home
|
|
628
|
+
[📜gh-wiki]: https://github.com/structuredmerge/structuredmerge-ruby/wiki
|
|
629
|
+
[📜gl-wiki-img]: https://img.shields.io/badge/wiki-gitlab-943CD2.svg?style=for-the-badge&logo=gitlab&logoColor=white
|
|
630
|
+
[📜gh-wiki-img]: https://img.shields.io/badge/wiki-github-943CD2.svg?style=for-the-badge&logo=github&logoColor=white
|
|
631
|
+
[👽dl-rank]: https://clickgems.clickhouse.com/dashboard/markdown-merge
|
|
632
|
+
[👽dl-ranki]: https://img.shields.io/gem/dt/markdown-merge.svg
|
|
633
|
+
[👽version]: https://clickgems.clickhouse.com/dashboard/markdown-merge
|
|
979
634
|
[👽versioni]: https://img.shields.io/gem/v/markdown-merge.svg
|
|
980
|
-
[
|
|
981
|
-
[
|
|
982
|
-
[🏀qlty-cov]: https://qlty.sh/gh/kettle-rb/projects/markdown-merge/metrics/code?sort=coverageRating
|
|
983
|
-
[🏀qlty-covi]: https://qlty.sh/gh/kettle-rb/projects/markdown-merge/coverage.svg
|
|
984
|
-
[🏀codecov]: https://codecov.io/gh/kettle-rb/markdown-merge
|
|
985
|
-
[🏀codecovi]: https://codecov.io/gh/kettle-rb/markdown-merge/graph/badge.svg
|
|
986
|
-
[🏀coveralls]: https://coveralls.io/github/kettle-rb/markdown-merge?branch=main
|
|
987
|
-
[🏀coveralls-img]: https://coveralls.io/repos/github/kettle-rb/markdown-merge/badge.svg?branch=main
|
|
988
|
-
[🖐codeQL]: https://github.com/kettle-rb/markdown-merge/security/code-scanning
|
|
989
|
-
[🖐codeQL-img]: https://github.com/kettle-rb/markdown-merge/actions/workflows/codeql-analysis.yml/badge.svg
|
|
990
|
-
[🚎2-cov-wf]: https://github.com/kettle-rb/markdown-merge/actions/workflows/coverage.yml
|
|
991
|
-
[🚎2-cov-wfi]: https://github.com/kettle-rb/markdown-merge/actions/workflows/coverage.yml/badge.svg
|
|
992
|
-
[🚎3-hd-wf]: https://github.com/kettle-rb/markdown-merge/actions/workflows/heads.yml
|
|
993
|
-
[🚎3-hd-wfi]: https://github.com/kettle-rb/markdown-merge/actions/workflows/heads.yml/badge.svg
|
|
994
|
-
[🚎5-st-wf]: https://github.com/kettle-rb/markdown-merge/actions/workflows/style.yml
|
|
995
|
-
[🚎5-st-wfi]: https://github.com/kettle-rb/markdown-merge/actions/workflows/style.yml/badge.svg
|
|
996
|
-
[🚎6-s-wf]: https://github.com/kettle-rb/markdown-merge/actions/workflows/supported.yml
|
|
997
|
-
[🚎6-s-wfi]: https://github.com/kettle-rb/markdown-merge/actions/workflows/supported.yml/badge.svg
|
|
998
|
-
[🚎9-t-wf]: https://github.com/kettle-rb/markdown-merge/actions/workflows/truffle.yml
|
|
999
|
-
[🚎9-t-wfi]: https://github.com/kettle-rb/markdown-merge/actions/workflows/truffle.yml/badge.svg
|
|
1000
|
-
[🚎11-c-wf]: https://github.com/kettle-rb/markdown-merge/actions/workflows/current.yml
|
|
1001
|
-
[🚎11-c-wfi]: https://github.com/kettle-rb/markdown-merge/actions/workflows/current.yml/badge.svg
|
|
1002
|
-
[🚎12-crh-wf]: https://github.com/kettle-rb/markdown-merge/actions/workflows/dep-heads.yml
|
|
1003
|
-
[🚎12-crh-wfi]: https://github.com/kettle-rb/markdown-merge/actions/workflows/dep-heads.yml/badge.svg
|
|
1004
|
-
[🚎13-🔒️-wf]: https://github.com/kettle-rb/markdown-merge/actions/workflows/locked_deps.yml
|
|
1005
|
-
[🚎13-🔒️-wfi]: https://github.com/kettle-rb/markdown-merge/actions/workflows/locked_deps.yml/badge.svg
|
|
1006
|
-
[🚎14-🔓️-wf]: https://github.com/kettle-rb/markdown-merge/actions/workflows/unlocked_deps.yml
|
|
1007
|
-
[🚎14-🔓️-wfi]: https://github.com/kettle-rb/markdown-merge/actions/workflows/unlocked_deps.yml/badge.svg
|
|
1008
|
-
[🚎15-🪪-wf]: https://github.com/kettle-rb/markdown-merge/actions/workflows/license-eye.yml
|
|
1009
|
-
[🚎15-🪪-wfi]: https://github.com/kettle-rb/markdown-merge/actions/workflows/license-eye.yml/badge.svg
|
|
1010
|
-
[💎ruby-3.2i]: https://img.shields.io/badge/Ruby-3.2-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
|
1011
|
-
[💎ruby-3.3i]: https://img.shields.io/badge/Ruby-3.3-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
|
635
|
+
[🚎11-c-wf]: https://github.com/structuredmerge/structuredmerge-ruby/actions/workflows/current.yml
|
|
636
|
+
[🚎11-c-wfi]: https://github.com/structuredmerge/structuredmerge-ruby/actions/workflows/current.yml/badge.svg
|
|
1012
637
|
[💎ruby-c-i]: https://img.shields.io/badge/Ruby-current-CC342D?style=for-the-badge&logo=ruby&logoColor=green
|
|
1013
|
-
[
|
|
1014
|
-
[
|
|
1015
|
-
[
|
|
1016
|
-
[
|
|
1017
|
-
[
|
|
1018
|
-
[
|
|
1019
|
-
[🤝gh-issues]: https://github.com/kettle-rb/markdown-merge/issues
|
|
1020
|
-
[🤝gh-pulls]: https://github.com/kettle-rb/markdown-merge/pulls
|
|
1021
|
-
[🤝gl-issues]: https://gitlab.com/kettle-rb/markdown-merge/-/issues
|
|
1022
|
-
[🤝gl-pulls]: https://gitlab.com/kettle-rb/markdown-merge/-/merge_requests
|
|
1023
|
-
[🤝cb-issues]: https://codeberg.org/kettle-rb/markdown-merge/issues
|
|
1024
|
-
[🤝cb-pulls]: https://codeberg.org/kettle-rb/markdown-merge/pulls
|
|
638
|
+
[🤝gh-issues]: https://github.com/structuredmerge/structuredmerge-ruby/issues
|
|
639
|
+
[🤝gh-pulls]: https://github.com/structuredmerge/structuredmerge-ruby/pulls
|
|
640
|
+
[🤝gl-issues]: https://gitlab.com/structuredmerge/structuredmerge-ruby/-/issues
|
|
641
|
+
[🤝gl-pulls]: https://gitlab.com/structuredmerge/structuredmerge-ruby/-/merge_requests
|
|
642
|
+
[🤝cb-issues]: https://codeberg.org/structuredmerge/structuredmerge-ruby/issues
|
|
643
|
+
[🤝cb-pulls]: https://codeberg.org/structuredmerge/structuredmerge-ruby/pulls
|
|
1025
644
|
[🤝cb-donate]: https://donate.codeberg.org/
|
|
1026
|
-
[🤝contributing]: CONTRIBUTING.md
|
|
1027
|
-
[🏀codecov-g]: https://codecov.io/gh/kettle-rb/markdown-merge/graphs/tree.svg
|
|
645
|
+
[🤝contributing]: https://github.com/structuredmerge/structuredmerge-ruby/blob/main/CONTRIBUTING.md
|
|
1028
646
|
[🖐contrib-rocks]: https://contrib.rocks
|
|
1029
|
-
[🖐contributors]: https://github.com/
|
|
1030
|
-
[🖐contributors-img]: https://contrib.rocks/image?repo=
|
|
1031
|
-
[
|
|
1032
|
-
[🪇conduct]: CODE_OF_CONDUCT.md
|
|
647
|
+
[🖐contributors]: https://github.com/structuredmerge/structuredmerge-ruby/graphs/contributors
|
|
648
|
+
[🖐contributors-img]: https://contrib.rocks/image?repo=structuredmerge/structuredmerge-ruby
|
|
649
|
+
[🪇conduct]: https://github.com/structuredmerge/structuredmerge-ruby/blob/main/CODE_OF_CONDUCT.md
|
|
1033
650
|
[🪇conduct-img]: https://img.shields.io/badge/Contributor_Covenant-2.1-259D6C.svg
|
|
1034
651
|
[📌pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
|
|
1035
652
|
[📌semver]: https://semver.org/spec/v2.0.0.html
|
|
1036
653
|
[📌semver-img]: https://img.shields.io/badge/semver-2.0.0-259D6C.svg?style=flat
|
|
1037
654
|
[📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
|
|
1038
655
|
[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
|
|
1039
|
-
[📌changelog]: CHANGELOG.md
|
|
656
|
+
[📌changelog]: https://github.com/structuredmerge/structuredmerge-ruby/blob/main/CHANGELOG.md
|
|
1040
657
|
[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
|
|
1041
658
|
[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-34495e.svg?style=flat
|
|
1042
659
|
[📌gitmoji]: https://gitmoji.dev
|
|
1043
660
|
[📌gitmoji-img]: https://img.shields.io/badge/gitmoji_commits-%20%F0%9F%98%9C%20%F0%9F%98%8D-34495e.svg?style=flat-square
|
|
1044
661
|
[🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
|
|
1045
|
-
[🧮kloc-img]: https://img.shields.io/badge/KLOC-
|
|
1046
|
-
[🔐security]: SECURITY.md
|
|
662
|
+
[🧮kloc-img]: https://img.shields.io/badge/KLOC-4.086-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
|
|
663
|
+
[🔐security]: https://github.com/structuredmerge/structuredmerge-ruby/blob/main/SECURITY.md
|
|
1047
664
|
[🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
|
|
1048
665
|
[📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
|
|
1049
|
-
[📄license]: LICENSE.
|
|
1050
|
-
[📄license-ref]:
|
|
1051
|
-
[📄license-img]: https://img.shields.io/badge/License-
|
|
1052
|
-
[📄license-compat]: https://
|
|
1053
|
-
[📄license-compat-img]: https://img.shields.io/badge/
|
|
666
|
+
[📄license]: LICENSE.md
|
|
667
|
+
[📄license-ref]: LICENSE.md
|
|
668
|
+
[📄license-img]: https://img.shields.io/badge/License-AGPL--3.0--only_OR_PolyForm--Small--Business--1.0.0-259D6C.svg
|
|
669
|
+
[📄license-compat]: https://www.apache.org/legal/resolved.html#category-x
|
|
670
|
+
[📄license-compat-img]: https://img.shields.io/badge/Apache_Incompatible:_Category_X-%E2%9C%97-C0392B.svg?style=flat&logo=Apache
|
|
1054
671
|
[📄ilo-declaration]: https://www.ilo.org/declaration/lang--en/index.htm
|
|
1055
672
|
[📄ilo-declaration-img]: https://img.shields.io/badge/ILO_Fundamental_Principles-✓-259D6C.svg?style=flat
|
|
1056
673
|
[🚎yard-current]: http://rubydoc.info/gems/markdown-merge
|
|
1057
674
|
[🚎yard-head]: https://markdown-merge.galtzo.com
|
|
1058
675
|
[💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
|
|
1059
|
-
[💎SHA_checksums]: https://gitlab.com/
|
|
676
|
+
[💎SHA_checksums]: https://gitlab.com/structuredmerge/structuredmerge-ruby/-/tree/main/checksums
|
|
1060
677
|
[💎rlts]: https://github.com/rubocop-lts/rubocop-lts
|
|
1061
678
|
[💎rlts-img]: https://img.shields.io/badge/code_style_&_linting-rubocop--lts-34495e.svg?plastic&logo=ruby&logoColor=white
|
|
1062
679
|
[💎appraisal2]: https://github.com/appraisal-rb/appraisal2
|