mdtoc 0.3.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd651a744c265508fe1b78eae797f688f83a417d0710ed70fdff838a05e8e2b9
-  data.tar.gz: bfd727b632d7d5076ef17e309e1a2715f5de971a313e74190b9e1facadcade7a
+  metadata.gz: 18181b859f98c2413c06fc51d9cb02d6350eda1e82953019dc7007e48a00784b
+  data.tar.gz: 6bcd6502f07056de61e2ac6679b296338babbfd5470b731a2a7ca6ccc0f06259
 SHA512:
-  metadata.gz: 2282ca2fb424b8dc093c856c83d4c13373bc10206d0a0f6c80c05c83329d057d1b3ce2c8dcf1a68ca2a7f303df22b95fccf3a71c1ead0f4c4e6da8049477005e
-  data.tar.gz: 714e58db5f76da82a910398f308698ed049bd56c9632b85d7131465d04d247ac57a0648b718f28b37dfa86be275535b0aee31a0cf5362a4f86523ced23037151
+  metadata.gz: 8045d2d699f6f6fcdd5d2c5671ed08950c279f3a6c3d836f149f1bfc7d8edad60582cf2539f2e042ebabde2b99b3eb7ccf0b6c3476fb294ba170afbe9c787b6f
+  data.tar.gz: d077544177ade528172c9642df28174c596ba663e658ea36b838d8fc616eb662960be342fa030137a987eace0e2615389c339562d1cde09997038d9416f866f5

data/README.md

@@ -1,5 +1,8 @@
 # mdtoc - Markdown Table of Contents
 
+[![CI](https://github.com/andornaut/mdtoc/actions/workflows/release.yml/badge.svg)](https://github.com/andornaut/mdtoc/actions/workflows/release.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
 Read Markdown files and output a table of contents.
 
 ## Installation
@@ -15,7 +18,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,25 +28,24 @@ 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
 * Run `mdtoc` to update the generated table of contents in the ./README.md file
-* Git commit and push any changes
+* `git add` any `*.md` files
+* Git commit, pull, and push any changes
 
 ```ruby
 task default: %w[mdtoc]
@@ -57,7 +59,7 @@ task :mdtoc do
       exit 1
     fi
     mdtoc --append --create --output README.md docs/
-    git add *.md **/*.md
+    git add README.md docs/*.md
     git commit -qm 'Update TOC' || true
     git pull
     git push
@@ -70,9 +72,9 @@ task :mdtoc do
 end
 ```
 
-See [andornaut/til](https://github.com/andornaut/til/blob/master/Rakefile) for an example.
+See [andornaut/til](https://github.com/andornaut/til/blob/main/Rakefile) for an example.
 
-## Development
+## Developing
 
 ### Setup
 
@@ -90,23 +92,34 @@ 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. Tag the commit `vX.Y.Z` and push the tag
+
+Pushing the tag is the whole release. The Release workflow runs the checks,
+builds the gem, cuts the GitHub release, and pushes that same gem to RubyGems.
+`rake release` is not run by hand.
+
+Nothing here holds a RubyGems API key. The workflow authenticates with a
+short-lived credential minted from its own OIDC claim, against a trusted
+publisher registered on RubyGems that names this repository and
+`.github/workflows/release.yml`. Renaming that file stops publishing until the
+trusted publisher is updated to match.

data/bin/mdtoc

@@ -2,5 +2,5 @@
 # typed: true
 # frozen_string_literal: true
 
-require "mdtoc"
+require 'mdtoc'
 Mdtoc.main(ARGV)

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,10 @@ 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
+        headers.each { |h| h.depth -= min_depth } if min_depth.positive?
+        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.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mdtoc
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.2
 platform: ruby
 authors:
 - andornaut
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-03 00:00:00.000000000 Z
+date: 2026-08-17 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.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.13.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
@@ -111,6 +111,9 @@ dependencies:
 description: |
   # mdtoc - Markdown Table of Contents
 
+  [![CI](https://github.com/andornaut/mdtoc/actions/workflows/release.yml/badge.svg)](https://github.com/andornaut/mdtoc/actions/workflows/release.yml)
+  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
   Read Markdown files and output a table of contents.
 
   ## Installation
@@ -126,7 +129,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,25 +139,24 @@ 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
   * Run `mdtoc` to update the generated table of contents in the ./README.md file
-  * Git commit and push any changes
+  * `git add` any `*.md` files
+  * Git commit, pull, and push any changes
 
   ```ruby
   task default: %w[mdtoc]
@@ -168,7 +170,7 @@ description: |
         exit 1
       fi
       mdtoc --append --create --output README.md docs/
-      git add *.md **/*.md
+      git add README.md docs/*.md
       git commit -qm 'Update TOC' || true
       git pull
       git push
@@ -181,9 +183,9 @@ description: |
   end
   ```
 
-  See [andornaut/til](https://github.com/andornaut/til/blob/master/Rakefile) for an example.
+  See [andornaut/til](https://github.com/andornaut/til/blob/main/Rakefile) for an example.
 
-  ## Development
+  ## Developing
 
   ### Setup
 
@@ -201,26 +203,37 @@ 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. Tag the commit `vX.Y.Z` and push the tag
+
+  Pushing the tag is the whole release. The Release workflow runs the checks,
+  builds the gem, cuts the GitHub release, and pushes that same gem to RubyGems.
+  `rake release` is not run by hand.
+
+  Nothing here holds a RubyGems API key. The workflow authenticates with a
+  short-lived credential minted from its own OIDC claim, against a trusted
+  publisher registered on RubyGems that names this repository and
+  `.github/workflows/release.yml`. Renaming that file stops publishing until the
+  trusted publisher is updated to match.
 email:
 executables:
 - mdtoc
@@ -252,7 +265,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.2
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="