glyptodont 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0bdb41b7c944725ff0cc501c8ee3b64d77fd8aa5cee211d1697ce43fe8547d1
-  data.tar.gz: 5d1a40a6f07b45b89487775ffad5d92ce3a84982ee19db732d13b8066e56ca68
+  metadata.gz: 7e18bcfa3a3f046b7b675c1612f35086438674024367463433cb60066cb008eb
+  data.tar.gz: 9cd7f2d0fe5ba7a0b947461164a48cd5875a4de539cd86cb26a1c7c2e5121898
 SHA512:
-  metadata.gz: efdfeb5ca64d4c3f41b6320b7d7de4df52d02cc5dd68bf223c036c769c8b8477240e2b57336de69cbdbe8878cda22d7b3dfe56b6fe826d143f2342d11a9deb38
-  data.tar.gz: 3672461a3f02c7572bae1289e4db373efde349a1d00ff34ee94cd142efbd1c8accdf3df4622e324395d70af9ee9b5136aba2d31e613f772664f7ca8b8f7812a9
+  metadata.gz: 6ebbbc04a10fc604c99bb9e6cee6757e5cfe21ed615f82177e1bf35e76ffaef4c201345c40f643d9fe81489d17457a06c85e0fdec389f572b16a0930580efa4c
+  data.tar.gz: b169d17d00ee585261e7d8dac21b5bb356365fc72de151593f1f77d9acda3ddce32d7e1f53d0f58743aa9d54f4928086ef433c8c0f80bcbf6b03f6beb1f95447

data/.github/workflows/publish-gem.yml

@@ -5,9 +5,9 @@
 name: Publish gem
 
 on:
-  push:
-    tags:
-      - "v*"
+  release:
+    types:
+      - published
 
 env:
   FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true

data/.glyptodont.yaml

@@ -1,14 +1,21 @@
 ---
 threshold: 1
 max_age_in_days: 1
+documentation_files:
+  - README.md
+  - CHANGELOG.md
+  - docs/index.html
 ignore:
-  - README.md:11
-  - README.md:16
+  - lib/glyptodont/checker.rb:18
+  - lib/glyptodont/checker.rb:19
+  - lib/glyptodont/checker.rb:20
+  - lib/glyptodont/checker.rb:21
   - lib/glyptodont/checkers/counter.rb:30
   - lib/glyptodont/checkers/counter.rb:32
-  - lib/glyptodont/todo_researcher.rb:33
-  - lib/glyptodont/todo_researcher.rb:34
-  - lib/glyptodont/todo_researcher.rb:35
-  - lib/glyptodont/todo_researcher.rb:36
-  - spec/checkers/counter_spec.rb:20
-  - spec/checkers/counter_spec.rb:28
+  - lib/glyptodont/options.rb:52
+  - lib/glyptodont/options.rb:54
+  - spec/glyptodont/checkers/counter_spec.rb:20
+  - spec/glyptodont/checkers/counter_spec.rb:28
+  - spec/glyptodont/todo_researcher_spec.rb:10
+  - spec/glyptodont/todo_researcher_spec.rb:33
+  - spec/glyptodont/todo_researcher_spec.rb:34

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.0.0"
+  ".": "1.1.0"
 }

data/CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.0](https://github.com/johnsyweb/glyptodont/compare/v1.0.0...v1.1.0) (2026-03-11)
+
+
+### Features
+
+* support documentation_files in configuration ([b6d2745](https://github.com/johnsyweb/glyptodont/commit/b6d27453f9ccb8198a20d45043335511f0d9e49a))
+
 ## [1.0.0](https://github.com/johnsyweb/glyptodont/compare/v0.3.0...v1.0.0) (2026-03-11)
 
 

data/README.md

@@ -72,6 +72,11 @@ gem install glyptodont
 For usage, command-line options, configuration (`.glyptodont.yaml`), and CI
 examples (GitHub Actions, Buildkite, Docker), see the [documentation](https://www.johnsy.com/glyptodont/).
 
+To avoid TODO-style comments in documentation and changelogs causing noise, you
+can list whole documentation files in the `documentation_files` key in
+`.glyptodont.yaml` (e.g. `CHANGELOG.md`, `docs/index.html`). Those files will
+be skipped entirely, while source files continue to be checked.
+
 ## Requirements
 
 - [Mise](https://mise.jdx.dev/) — install once; `script/setup` uses it to install

data/docs/index.html

@@ -172,6 +172,7 @@
           <li><strong>max_age_in_days</strong> — Maximum number of days to allow TODOs to stay. Overridable by <code>--max-age</code>.</li>
           <li><strong>ignore</strong> — List of <code>file_name:line_number</code> pairs to ignore (e.g. Spanish text or frequent mentions of TODOs).</li>
           <li><strong>keywords</strong> — List of synonyms for TODO in your project.</li>
+          <li><strong>documentation_files</strong> — List of documentation files to skip entirely when scanning for TODOs (e.g. <code>CHANGELOG.md</code>, <code>docs/index.html</code>).</li>
         </ul>
         <p>Example:</p>
         <pre><code>---
@@ -181,7 +182,10 @@ ignore:
   - README.md:11
   - lib/glyptodont/checkers/counter.rb:30
   - lib/glyptodont/todo_researcher.rb:33
-  - spec/checkers/counter_spec.rb:20</code></pre>
+  - spec/checkers/counter_spec.rb:20
+documentation_files:
+  - CHANGELOG.md
+  - docs/index.html</code></pre>
 
         <h3 id="command-line-options">Command-line options</h3>
         <pre><code>Usage: glyptodont [options]

data/lib/glyptodont/checker.rb

@@ -27,7 +27,7 @@ module Glyptodont
     end
 
     def check?
-      todos = TodoResearcher.new(directory, ignore, keywords).research
+      todos = TodoResearcher.new(directory, ignore, keywords, documentation_files).research
 
       checks = [
         Checkers::Counter.new(todos: todos, threshold: threshold),
@@ -44,6 +44,7 @@ module Glyptodont
     extend Forwardable
 
     def_delegator :@configuration, :ignore
+    def_delegator :@configuration, :documentation_files
     def_delegators :@options, :directory
 
     def threshold

data/lib/glyptodont/configuration.rb

@@ -27,6 +27,10 @@ module Glyptodont
       @keywords ||= config.fetch("keywords", nil)
     end
 
+    def documentation_files
+      @documentation_files ||= Array(config.fetch("documentation_files", []))
+    end
+
     private
 
     attr_reader :config_filename

data/lib/glyptodont/todo_researcher.rb

@@ -6,20 +6,24 @@ require "rugged"
 module Glyptodont
   # Finds all the TODOs in a directory managed by Git, who last touched them and when.
   class TodoResearcher
-    def initialize(directory, ignore, keywords)
+    def initialize(directory, ignore, keywords, documentation_files = [])
       @directory = directory
       @ignore = ignore
       @keywords = Array(keywords)
+      @documentation_files = Array(documentation_files)
       @annotator = {}
     end
 
     def research
-      annotate(exclude_ignored(extract_details(git.grep(keyword_rexexp))))
+      todos = extract_details(git.grep(keyword_rexexp))
+      todos = exclude_documentation_files(todos)
+      todos = exclude_ignored(todos)
+      annotate(todos)
     end
 
     private
 
-    attr_reader :directory, :ignore, :keywords
+    attr_reader :directory, :ignore, :keywords, :documentation_files
 
     def git
       Git.open(directory)
@@ -42,6 +46,12 @@ module Glyptodont
       end
     end
 
+    def exclude_documentation_files(todos)
+      return todos if documentation_files.empty?
+
+      todos.reject { |todo| documentation_files.include?(todo[:file]) }
+    end
+
     def exclude_ignored(todos)
       todos.reject { |todo| ignore.include?(todo.slice(:file, :line)) }
     end

data/lib/glyptodont/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Glyptodont
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glyptodont
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Pete Johns