mdtoc 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd651a744c265508fe1b78eae797f688f83a417d0710ed70fdff838a05e8e2b9
-  data.tar.gz: bfd727b632d7d5076ef17e309e1a2715f5de971a313e74190b9e1facadcade7a
+  metadata.gz: f53365d2172397bc4b50a26f88ce05d13c8766453b56c96fd1513151b2d72cad
+  data.tar.gz: c49f859803c2bf3928c51f70535ba35a9bffda3ccc69457713977497c6a50f6e
 SHA512:
-  metadata.gz: 2282ca2fb424b8dc093c856c83d4c13373bc10206d0a0f6c80c05c83329d057d1b3ce2c8dcf1a68ca2a7f303df22b95fccf3a71c1ead0f4c4e6da8049477005e
-  data.tar.gz: 714e58db5f76da82a910398f308698ed049bd56c9632b85d7131465d04d247ac57a0648b718f28b37dfa86be275535b0aee31a0cf5362a4f86523ced23037151
+  metadata.gz: de596f6886429e537d249cc2c2516521cfb23ee8c407f002348a68fe93b3de30f0b6e4809d64c5c2e75858e33791e4507d9060c35c79a8f0459202c105e54b73
+  data.tar.gz: 8da62161d757e8be2c7970ed076b58ea1dbc0b1416e35d497dbc5545faf84764ab88e08895f21c3995e98acd2c1f0f88bec4c9b96b5bcb3f27ad6a80ef07b88e

data/README.md

@@ -15,7 +15,7 @@ gem install mdtoc
 ## Usage
 
 ```bash
-$ mdtoc --help
+mdtoc --help
 Usage: mdtoc [options] files or directories...
     -h, --help                       Show this message
     -o, --output PATH                Update a table of contents in the file at PATH
@@ -25,23 +25,23 @@ Usage: mdtoc [options] files or directories...
 
 1. Add a `<!-- mdtoc -->` tag to a Markdown file.
 
-  ```bash
-  echo '<!-- mdtoc -->' >> README.md
-  ```
+    ```bash
+    echo '<!-- mdtoc -->' >> README.md
+    ```
 
 2. Run `mdtoc` and specify input files or directories (eg. the "test/samples" directory) and an output file (eg. "README.md").
 
-  ```bash
-  mdtoc -aco README.md test/samples
-  ```
+    ```bash
+    mdtoc -aco README.md test/samples
+    ```
 
 ## Example Rakefile
 
 Create a `Rakefile` with the contents below, then run
 [`rake`](https://github.com/ruby/rake) to:
 
-* `git pullgem push pkg/mdtoc-0.2.0.gem`
-* `git add` any *.md files
+* `git pull`
+* `git add` any `*.md` files
 * Run `mdtoc` to update the generated table of contents in the ./README.md file
 * Git commit and push any changes
 
@@ -90,23 +90,24 @@ bin/setup
 
 ```bash
 # List rake tasks
-$ rake -T
+rake -T
 rake build                    # Build gem into the pkg directory
 rake default                  # Run the build, rubocop, sorbet and test tasks
 rake install                  # Build and install gem into system gems
 rake rubocop                  # Run RuboCop
 rake sorbet                   # Run the Sorbet type checker
 rake test                     # Run tests
-```
+
 # Run mdtoc with test inputs
-$ ruby -Ilib bin/mdtoc test/samples
+ruby -Ilib bin/mdtoc test/samples
 
 # Run mdtoc with test inputs, and write to a newly created output file
-$ f=$(mktemp) && ruby -Ilib bin/mdtoc -aco ${f} test/samples ; cat ${f}
+f=$(mktemp) && ruby -Ilib bin/mdtoc -aco ${f} test/samples ; cat ${f}
 ```
 
 ### Publishing
 
-```bash
-rake release
-```
+1. Bump version in `lib/mdtoc/version.rb`
+2. Run `bundle install` to update `Gemfile.lock`
+3. Commit the changes
+4. Run `rake release` to publish the gem to RubyGems, create the git tag, and push

data/lib/mdtoc/markdown/header.rb

@@ -9,6 +9,9 @@ module Mdtoc
     class Header
       extend T::Sig
 
+      sig { returns(Integer) }
+      attr_accessor :depth
+
       sig { params(depth: Integer, label: String, url: String).void }
       def initialize(depth, label, url)
         raise ArgumentError, "Header depth must be >= 0, but was #{depth}" if depth.negative?

data/lib/mdtoc/node.rb

@@ -26,9 +26,12 @@ module Mdtoc
 
       sig { params(paths: T::Array[String]).returns(String) }
       def render(paths)
-        paths
-          .flat_map { |path| for_path(path).headers }
-          .join("\n")
+        headers = paths.flat_map { |path| for_path(path).headers }
+        min_depth = headers.map(&:depth).min || 0
+        if min_depth.positive?
+          headers.each { |h| h.depth -= min_depth }
+        end
+        headers.join("\n")
       end
     end
 

data/lib/mdtoc/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Mdtoc
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mdtoc
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - andornaut
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-03 00:00:00.000000000 Z
+date: 2026-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.25'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.25'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -72,28 +72,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: unparser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -126,7 +126,7 @@ description: |
   ## Usage
 
   ```bash
-  $ mdtoc --help
+  mdtoc --help
   Usage: mdtoc [options] files or directories...
       -h, --help                       Show this message
       -o, --output PATH                Update a table of contents in the file at PATH
@@ -136,23 +136,23 @@ description: |
 
   1. Add a `<!-- mdtoc -->` tag to a Markdown file.
 
-    ```bash
-    echo '<!-- mdtoc -->' >> README.md
-    ```
+      ```bash
+      echo '<!-- mdtoc -->' >> README.md
+      ```
 
   2. Run `mdtoc` and specify input files or directories (eg. the "test/samples" directory) and an output file (eg. "README.md").
 
-    ```bash
-    mdtoc -aco README.md test/samples
-    ```
+      ```bash
+      mdtoc -aco README.md test/samples
+      ```
 
   ## Example Rakefile
 
   Create a `Rakefile` with the contents below, then run
   [`rake`](https://github.com/ruby/rake) to:
 
-  * `git pullgem push pkg/mdtoc-0.2.0.gem`
-  * `git add` any *.md files
+  * `git pull`
+  * `git add` any `*.md` files
   * Run `mdtoc` to update the generated table of contents in the ./README.md file
   * Git commit and push any changes
 
@@ -201,26 +201,27 @@ description: |
 
   ```bash
   # List rake tasks
-  $ rake -T
+  rake -T
   rake build                    # Build gem into the pkg directory
   rake default                  # Run the build, rubocop, sorbet and test tasks
   rake install                  # Build and install gem into system gems
   rake rubocop                  # Run RuboCop
   rake sorbet                   # Run the Sorbet type checker
   rake test                     # Run tests
-  ```
+
   # Run mdtoc with test inputs
-  $ ruby -Ilib bin/mdtoc test/samples
+  ruby -Ilib bin/mdtoc test/samples
 
   # Run mdtoc with test inputs, and write to a newly created output file
-  $ f=$(mktemp) && ruby -Ilib bin/mdtoc -aco ${f} test/samples ; cat ${f}
+  f=$(mktemp) && ruby -Ilib bin/mdtoc -aco ${f} test/samples ; cat ${f}
   ```
 
   ### Publishing
 
-  ```bash
-  rake release
-  ```
+  1. Bump version in `lib/mdtoc/version.rb`
+  2. Run `bundle install` to update `Gemfile.lock`
+  3. Commit the changes
+  4. Run `rake release` to publish the gem to RubyGems, create the git tag, and push
 email:
 executables:
 - mdtoc
@@ -252,7 +253,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.2
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="