pdd 0.23.2 → 0.24.1

data/README.md

@@ -1,74 +1,107 @@
-<img alt="pdd logo" src="https://avatars2.githubusercontent.com/u/24456188" width="92px" height="92px"/>
+# Collector of TODO Puzzles in Source Code
 
 [![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)
-[![DevOps By Rultor.com](http://www.rultor.com/b/cqfn/pdd)](http://www.rultor.com/p/cqfn/pdd)
+[![DevOps By Rultor.com](https://www.rultor.com/b/cqfn/pdd)](https://www.rultor.com/p/cqfn/pdd)
 [![We recommend RubyMine](https://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/)
 
 [![rake](https://github.com/cqfn/pdd/actions/workflows/rake.yml/badge.svg)](https://github.com/cqfn/pdd/actions/workflows/rake.yml)
-[![PDD status](http://www.0pdd.com/svg?name=cqfn/pdd)](http://www.0pdd.com/p?name=cqfn/pdd)
-[![codecov](https://codecov.io/gh/cqfn/pdd/branch/master/graph/badge.svg)](https://codecov.io/gh/cqfn/pdd)
-![Lines of code](https://img.shields.io/tokei/lines/github/cqfn/pdd)
+[![PDD status](https://www.0pdd.com/svg?name=cqfn/pdd)](https://www.0pdd.com/p?name=cqfn/pdd)
+[![codecov](https://codecov.io/gh/yegor256/pdd/branch/master/graph/badge.svg)](https://codecov.io/gh/yegor/pdd)
 [![Hits-of-Code](https://hitsofcode.com/github/cqfn/pdd)](https://hitsofcode.com/view/github/cqfn/pdd)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/cqfn/pdd/blob/master/LICENSE.txt)
-[![Gem Version](https://badge.fury.io/rb/pdd.svg)](http://badge.fury.io/rb/pdd)
+[![Gem Version](https://badge.fury.io/rb/pdd.svg)](https://badge.fury.io/rb/pdd)
 [![Maintainability](https://api.codeclimate.com/v1/badges/c8e46256fdd8ddc817e5/maintainability)](https://codeclimate.com/github/cqfn/pdd/maintainability)
-[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/cqfn/pdd/master/frames)
+[![Yard Docs](https://img.shields.io/badge/yard-docs-blue.svg)](https://rubydoc.info/github/cqfn/pdd/master/frames)
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/1792d42f96fb45448e8d495ebc4348aa)](https://www.codacy.com/gh/cqfn/pdd/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=cqfn/pdd&amp;utm_campaign=Badge_Grade)
 
 Read this article about
 [_Puzzle Driven Development_](http://www.yegor256.com/2009/03/04/pdd.html).
-Check also patent application [US 12/840,306](http://www.google.com/patents/US20120023476)
+Check also patent application
+[US 12/840,306](http://www.google.com/patents/US20120023476)
 
-Also, check [0pdd.com](http://www.0pdd.com): a hosted service,
+Also, check [0pdd.com](https://www.0pdd.com): a hosted service,
 where this command line tool works for you.
 
 Read
 [_PDD in Action_](http://www.yegor256.com/2017/04/05/pdd-in-action.html)
 and watch [this webinar](https://www.youtube.com/watch?v=nsYGC2aUwfQ).
 
-You should have [Ruby installed](https://www.ruby-lang.org/en/documentation/installation/).
-Then, install our gem:
+First, make sure Ruby 2.6+ and [`libmagic`](#how-to-install-libmagic)
+are installed. Then, install our gem:
 
 ```bash
-$ gem install pdd
+gem install pdd
 ```
 
 Run it locally and read its output:
 
 ```bash
-$ pdd --help
+pdd --help
 ```
 
-You can exclude & include certain number of files from the search via these options:
+## Usage
 
-```
-$ pdd --exclude=glob
+You can exclude & include certain number of files from the search
+via these options:
+
+```bash
+pdd --exclude glob
 ```
 
-You can skip any file(s) with a name suffix that matches the pattern glob, using wildcard matching; 
-a name suffix is either the whole path and name, or reg expr, for example:
+You can skip any file(s) with a name suffix that matches the pattern glob,
+using wildcard matching; a name suffix is either the whole
+path and name, or reg expr, for example:
 
 ```bash
-$ pdd --exclude=src/**/*.java --exclude=target/**/*
-$ pdd --exclude=src/**/*.java # exclude .java files in src/
-$ pdd --exclude=src/**/* # exclude all files in src/
+pdd --exclude src/**/*.java --exclude target/**/*
+pdd --exclude src/**/*.java # exclude .java files in src/
+pdd --exclude src/**/* # exclude all files in src/
 ```
 
 You can include too:
 
+```bash
+pdd --include glob
 ```
-$ pdd --include=glob
+
+Search only files whose name matches glob, using wildcard matching
+as described under ``--exclude``.
+If contradictory ``--include`` and ``--exclude`` options are given,
+the last matching one wins.
+If no ``--include`` or ``--exclude`` options are given, all files
+from the working directory are included, example:
+
+```bash
+pdd --include src/**/*.py # include only .py files in src/
+pdd --include src/**/* # include all files in src/
 ```
 
-Search only files whose name matches glob, using wildcard matching as described under ``--exclude``. 
-If contradictory ``--include`` and ``--exclude`` options are given, the last matching one wins. 
-If no ``--include`` or ``--exclude`` options are given, all files from working directory are included, example:
+Full command format is (all parameters are optional):
 
 ```bash
-$ pdd --include=src/**/*.py # include only .py files in src/
-$ pdd --include=src/**/* # include all files in src/
+pdd [--verbose] [--quiet] [--remove] [--skip-gitignore] [--skip-errors] \
+  [--source <project_dir_path>] [--file puzzles_file.xml] \
+  [--include src/**/*.py] \
+  [--format xml|html] [--rule min-words:5] [--exclude src/**/*.java]
 ```
 
+| Parameter               | Description                                                                           |
+|-------------------------|---------------------------------------------------------------------------------------|
+| --verbose               | Enable verbose (debug) mode. --file must be used in case of using this option         |
+| --quiet                 | Disable logs                                                                          |
+| --remove                | Remove all found puzzles from the source code                                         |
+| --skip-gitignore        | Don't look into .gitignore for excludes                                               |
+| --skip-errors           | Suppress error as warning and skip badly formatted puzzles (do not skip broken rules) |
+| --source project-path   | Source directory to parse ("." by default)                                            |
+| --file puzzles.xml      | File to save report into (xml or html) (displayed in console by default)              |
+| --include *.py          | Glob pattern to include (can be used several times)                                   |
+| --exclude *.java        | Glob pattern to exclude (can be used several times)                                   |
+| --format xml            | Format of the report xml or html  (xml is default)                                    |
+| --rule min-words:5      | Rule to apply (can be used several times), described later                            |
+
+:bulb: There is an option to create a .pdd file in your project and save all required parameters in it.
+You can see a file example in this project.
+
 ## How to Format?
 
 Every puzzle has to be formatted like this (pay attention
@@ -81,9 +114,9 @@ to the leading space in every consecutive line):
 [related code]
 ```
 
-`[]` - Replace with apropriate data (see text enclosed in brackets)
+`[]` - Replace with appropriate data (see text enclosed in brackets)
 
-`<>` - Omitable (enclosed data can be left out)
+`<>` - Optional (enclosed data can be left out)
 
 Example:
 
@@ -92,13 +125,17 @@ Example:
  * @todo #234:15m/DEV This is something to do later
  *  in one of the next releases. I can't figure out
  *  how to implement it now, that's why the puzzle.
+ *  The text can be so long, as needed, just use
+ *  the same amount of spaces, as the second line.
+ * This text will not be a part of the puzzle, as
+ * it has less spaces.
  */
 void sendEmail() {
   throw new UnsupportedOperationException();
 }
 ```
 
-If you use it in combination with [0pdd](http://www.0pdd.com),
+If you use it in combination with [0pdd](https://www.0pdd.com),
 after processing this text, the issue titled
 "File.java:10-13: This is something to do later in one of ..." will be created.
 The specified markers will be included in the issues body
@@ -112,39 +149,75 @@ There are 3 supported keywords, one of which must precede the mandatory
 puzzle marker. They are `@todo`, `TODO` and `TODO:`.
 
 As an example, it starts with `@todo`, followed by a space and a mandatory
-puzzle **marker**. Possible formats of puzzle markers (it doesn't matter what the
-line starts with and where it is located,
+puzzle **marker**. Possible formats of puzzle markers
+(it doesn't matter what the line starts with and where it is located,
 as long as you have one of the 3 supported keywords right in front
 of the mandatory marker):
 
-```
-// @todo #224
-/* @todo #TEST-13 */
-# @todo #55:45min
-@todo #67/DES
-;; @todo #678:40m/DEV
-// TODO: #1:30min
-(* TODO #42 *)
+```text
+// @todo #224 Puzzle description
+# @todo #55:45min Puzzle description
+@todo #67/DES Puzzle description
+;; @todo #678:40m/DEV Puzzle description
+// TODO #TEST-21:30min Puzzle description
 ```
 
-Here `DES` and `DEV` are the roles of people who must fix that puzzles;
+Here `DES` and `DEV` are the roles of people who must fix these puzzles;
 `45min` and `40m` is the amount of time the puzzle should take;
-`224`, `TEST-13`, `55`, `67`, `678`, `1`, and `42` are the IDs of the tickets
+`224`, `55`, `67`, `678` and `TEST-21` are the IDs of the tickets
 these puzzles are coming from.
 
 Markers are absolutely necessary for all puzzles, because they allow
 us to build a hierarchical dependency tree of all puzzles, like
-[this one](http://www.0pdd.com/p?name=yegor256/takes),
+[this one](https://www.0pdd.com/p?name=yegor256/takes),
 for example. Technically, of course, you can abuse the system
 and put a dummy `#1` marker everywhere.
 
+### Multiline examples
+
+For multiline puzzles there are two important things:
+
+- **prefix** - any optional text followed by space before puzzle keyword (todo).
+It should be the same for all lines of puzzle description.
+- \ symbol can be used to logically divide puzzle description.
+prefix should be presented with it.
+
+Examples:
+
+```xml
+<!--
+ ~ if comments should be started and closed by special symbols, then place them in
+ ~ a separate lines
+ ~ Any symbol can be used as a prefix, it will be excluded from the text.
+ ~ But do not forget about the space before puzzle keyword.
+ ~
+ ~ @todo #34 Description can be as long as needed.
+ ~  Just use at least the same amount of the spaces, as on the first line.
+ ~  It will be added to description.
+-->
+```
+
+```java
+/**
+ * @todo #36 Multiline text can use the same prefix in all lines or the same
+ *  amount of spaces.
+ *  So this will be added to the puzzle description. If you want to divide the
+ *  puzzle logically by empty line, just add a backspace to that line
+ *  \
+ *  and continue the text after.
+ *
+ *  This line is not part of the puzzle, because the line before does not contain
+ *  prefix.
+ */
+```
+
 ## How to Configure Rules?
 
 You can specify post-parsing rules for your puzzles, in command line,
 for example:
 
-```
-$ pdd --rule=min-estimate:60 --rule=max-estimate:120
+```bash
+pdd --rule min-estimate:60 --rule max-estimate:120
 ```
 
 These two parameters will add two post-parsing rules `min-estimate`
@@ -168,14 +241,15 @@ Here is a list of rules available now:
   This rule is used by default and you can't configure it at the moment,
   it must always be set to `1`.
 
-You can put all command line options into `.pdd` file. The options from the
+:bulb: You can put all command line options into `.pdd` file. The options from the
 file will be used first. Command line options may be added on top of them.
-See, how it is done in [yegor256/0pdd](https://github.com/yegor256/0pdd/blob/master/.pdd).
+See, how it is done in
+[yegor256/0pdd](https://github.com/yegor256/0pdd/blob/master/.pdd).
 
 ## How to read XML
 
 The XML produced will look approximately like this (here is a
-[real example](http://www.0pdd.com/snapshot?name=yegor256/takes)):
+[real example](https://www.0pdd.com/snapshot?name=yegor256/takes)):
 
 ```xml
 <puzzles>
@@ -193,6 +267,7 @@ The XML produced will look approximately like this (here is a
   </puzzle>
 </puzzles>
 ```
+
 NOTE: puzzles are saved with utf-8 encoding
 
 [XSD Schema](http://pdd-xsd.teamed.io/0.19.4.xsd) is here.
@@ -211,22 +286,42 @@ The most interesting parts of each puzzle are:
 
 - `lines` is where the puzzle is found, inside the file.
 
+## How to install libmagic
+
+For Debian/Ubuntu:
+
+```bash
+apt install libmagic-dev
+```
+
+For macOS:
+
+```bash
+brew install libmagic
+```
+
+Unfortunately, there is no easy way to install on Windows, try to use
+[WSL](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux) or
+[Docker](https://www.docker.com/).
+
 ## How to contribute
 
 Read [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
 Make sure your build is green before you contribute
-your pull request. You will need to have [Ruby](https://www.ruby-lang.org/en/) 2.3+ and
+your pull request. You will need to have
+[Ruby](https://www.ruby-lang.org/en/) 2.7+ and
 [Bundler](https://bundler.io/) installed. Then:
 
-```
-$ bundle install
-$ bundle exec rake
+```bash
+bundle install
+bundle exec rake
 ```
 
 Next, install and run overcommit to install hooks (required once)
-```
-$ gem install overcommit -v '=0.58.0'
-$ overcommit --install
+
+```bash
+gem install overcommit -v '=0.58.0'
+overcommit --install
 ```
 
 If it's clean and you don't see any error messages, submit your pull request.
@@ -234,11 +329,11 @@ If it's clean and you don't see any error messages, submit your pull request.
 This is how you run the tool locally to test how it works:
 
 ```bash
-$ ./bin/pdd --help
+./bin/pdd --help
 ```
 
 To run a single unit test:
 
 ```bash
-$ bundle exec ruby test/test_many.rb
+bundle exec ruby test/test_many.rb
 ```

data/REUSE.toml

@@ -0,0 +1,43 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+version = 1
+[[annotations]]
+path = [
+    ".DS_Store",
+    ".gitattributes",
+    ".gitignore",
+    ".overcommit.yml",
+    ".pdd",
+    "**.ico",
+    "**.jpg",
+    "**.json",
+    "**.md",
+    "**.pdf",
+    "**.png",
+    "**.txt",
+    "**.woff",
+    "**/.DS_Store",
+    "**/.gitignore",
+    "**/.pdd",
+    "**/*.csv",
+    "**/*.jpg",
+    "**/*.json",
+    "**/*.md",
+    "**/*.pdf",
+    "**/*.png",
+    "**/*.svg",
+    "**/*.txt",
+    "**/*.vm",
+    "**/CITATION.cff",
+    "**/CNAME",
+    "**/Gemfile.lock",
+    "CITATION.cff",
+    "Gemfile.lock",
+    "README.md",
+    "renovate.json",
+    "test_assets/puzzles/**",
+]
+precedence = "override"
+SPDX-FileCopyrightText = "Copyright (c) 2025 Yegor Bugayenko"
+SPDX-License-Identifier = "MIT"

data/Rakefile

@@ -1,22 +1,5 @@
-# Copyright (c) 2014-2023 Yegor Bugayenko
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the 'Software'), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
+# SPDX-FileCopyrightText: Copyright (c) 2014-2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
 
 require 'rubygems'
 require 'rake'
@@ -31,7 +14,7 @@ def version
   Gem::Specification.load(Dir['*.gemspec'].first).version
 end
 
-task default: %i[clean test features rubocop xcop copyright]
+task default: %i[clean test features rubocop xcop]
 
 require 'rake/testtask'
 desc 'Run all unit tests'
@@ -55,15 +38,13 @@ require 'rubocop/rake_task'
 desc 'Run RuboCop on all directories'
 RuboCop::RakeTask.new(:rubocop) do |task|
   task.fail_on_error = true
-  task.requires << 'rubocop-rspec'
 end
 
 require 'xcop/rake_task'
 desc 'Validate all XML/XSL/XSD/HTML files for formatting'
 Xcop::RakeTask.new :xcop do |task|
-  task.license = 'LICENSE.txt'
   task.includes = ['**/*.xml', '**/*.xsl', '**/*.xsd', '**/*.html']
-  task.excludes = ['target/**/*', 'coverage/**/*']
+  task.excludes = ['target/**/*', 'coverage/**/*', 'vendor/**/*']
 end
 
 require 'pdd/rake_task'
@@ -74,17 +55,12 @@ end
 
 require 'cucumber/rake/task'
 Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = 'features'
+  t.cucumber_opts = %w[features --strict-undefined]
   Rake::Cleaner.cleanup_files(['coverage'])
 end
 Cucumber::Rake::Task.new(:'features:html') do |t|
   t.profile = 'html_report'
 end
-
-task :copyright do
-  sh "grep -q -r '2014-#{Date.today.strftime('%Y')}' \
-    --include '*.rb' \
-    --include '*.txt' \
-    --include 'Rakefile' \
-    ."
+Cucumber::Rake::Task.new(:'features:json') do |t|
+  t.profile = 'json_report'
 end

data/assets/puzzles.xsd

@@ -1,26 +1,7 @@
-<?xml version="1.0"?>
+<?xml version="1.0" encoding="UTF-8"?>
 <!--
-(The MIT License)
-
-Copyright (c) 2014-2023 Yegor Bugayenko
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the 'Software'), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+ * SPDX-FileCopyrightText: Copyright (c) 2014-2025 Yegor Bugayenko
+ * SPDX-License-Identifier: MIT
 -->
 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:complexType name="puzzle">

data/assets/puzzles.xsl

@@ -1,26 +1,7 @@
-<?xml version="1.0"?>
+<?xml version="1.0" encoding="UTF-8"?>
 <!--
-(The MIT License)
-
-Copyright (c) 2014-2023 Yegor Bugayenko
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the 'Software'), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+ * SPDX-FileCopyrightText: Copyright (c) 2014-2025 Yegor Bugayenko
+ * SPDX-License-Identifier: MIT
 -->
 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml" version="1.0">
   <xsl:template match="/">

data/assets/puzzles_json.xsl

@@ -0,0 +1,60 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * SPDX-FileCopyrightText: Copyright (c) 2014-2025 Yegor Bugayenko
+ * SPDX-License-Identifier: MIT
+-->
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
+  <xsl:output method="text" omit-xml-declaration="yes"/>
+  <xsl:template match="/"><xsl:text disable-output-escaping="yes">{</xsl:text><xsl:apply-templates select="puzzles"/>
+    "puzzles": [
+    <xsl:apply-templates select="puzzles/puzzle"/>
+    <xsl:text disable-output-escaping="yes">
+  ]
+}</xsl:text>
+  </xsl:template>
+  <xsl:template match="puzzles">
+    <xsl:text>
+    "version": "</xsl:text>
+    <xsl:value-of select="@version"/>
+    <xsl:text>",</xsl:text>
+    <xsl:text>
+    "date": "</xsl:text>
+    <xsl:value-of select="@date"/>
+    <xsl:text>", </xsl:text>
+  </xsl:template>
+  <xsl:template match="puzzle">
+    <xsl:text disable-output-escaping="no">{</xsl:text>
+    <xsl:text>
+      "id": "</xsl:text>
+    <xsl:value-of select="id"/>
+    <xsl:text>", </xsl:text>
+    <xsl:text>
+      "ticket": "</xsl:text>
+    <xsl:value-of select="ticket"/>
+    <xsl:text>", </xsl:text>
+    <xsl:text>
+      "file": "</xsl:text>
+    <xsl:value-of select="file"/>
+    <xsl:text>", </xsl:text>
+    <xsl:text>
+      "lines": "</xsl:text>
+    <xsl:value-of select="lines"/>
+    <xsl:text>", </xsl:text>
+    <xsl:text>
+      "body": "</xsl:text>
+    <xsl:value-of select="translate(body, '&quot;', '“')"/>
+    <xsl:text>", </xsl:text>
+    <xsl:text>
+      "estimate": "</xsl:text>
+    <xsl:value-of select="estimate"/>
+    <xsl:text>", </xsl:text>
+    <xsl:text>
+      "role": "</xsl:text>
+    <xsl:value-of select="role"/>
+    <xsl:text>"</xsl:text>
+    <xsl:text disable-output-escaping="yes">
+    }</xsl:text>
+    <xsl:if test="position() != last()">,
+  </xsl:if>
+  </xsl:template>
+</xsl:stylesheet>

data/bin/pdd

@@ -1,26 +1,10 @@
 #!/usr/bin/env ruby
-# Copyright (c) 2014-2023 Yegor Bugayenko
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the 'Software'), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
+# SPDX-FileCopyrightText: Copyright (c) 2014-2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
 
 $stdout.sync = true
 
+require 'backtrace'
 require 'shellwords'
 require 'English'
 require 'find'
@@ -59,12 +43,12 @@ begin
         exit
       end
       o.string '-s', '--source', 'Source directory to parse ("." by default)'
-      o.string '-f', '--file', 'File to save XML into'
+      o.string '-f', '--file', 'File to save report into'
       o.array '-e', '--exclude', 'Glob pattern to exclude, e.g. "**/*.jpg"',
               default: []
       o.array '-n', '--include', 'Glob pattern to include, e.g. "**/*.jpg"',
               default: []
-      o.string '-t', '--format', 'Format of the report (xml|html)'
+      o.string '-t', '--format', 'Format of the report (xml|html|json)'
       o.array(
         '-r', '--rule', 'Rule to apply (can be used many times)',
         delimiter: ';'
@@ -87,7 +71,8 @@ https://github.com/cqfn/pdd/blob/master/README.md"
 
   if opts['skip-gitignore'] && File.exist?('.gitignore')
     cfg = File.new('.gitignore')
-    body = File.read(cfg)
+    body = ''
+    File.foreach(cfg) { |line| body << line unless line.start_with?('#') }
     extra = body.split(/\s+/).map(&:strip)
     opts['skip-gitignore'] = extra
     PDD.log.info "Found #{body.split("\n").length} lines in #{File.absolute_path(cfg)}"
@@ -105,8 +90,15 @@ https://github.com/cqfn/pdd/blob/master/README.md"
         'assets', 'puzzles.xsl'
       )
       output = Nokogiri::XSLT(File.read(xslt)).transform(Nokogiri::XML(xml))
+    elsif opts[:format] == 'json'
+      xslt = File.join(
+        File.dirname(File.dirname(__FILE__)),
+        'assets', 'puzzles_json.xsl'
+      )
+      # result is not xml, so use apply
+      output = Nokogiri::XSLT(File.read(xslt)).apply_to(Nokogiri::XML(xml))
     elsif opts[:format] != 'xml'
-      raise 'Invalid format, use html or xml'
+      raise 'Invalid format, use html or xml or json'
     end
   end
   file << output
@@ -124,7 +116,7 @@ https://github.com/cqfn/pdd/blob/master/README.md"
       File.write(
         f,
         File.readlines(f).reject.each_with_index do |_t, i|
-          all.any? { |pair| i + 1 >= pair[0] && i + 1 <= pair[1] }
+          all.any? { |pair| i + (1.between?(pair[0], pair[1]) ? 1 : 0) }
         end.join
       )
       PDD.log.info "#{all.count} puzzles removed from #{src}"
@@ -145,6 +137,7 @@ more documentation: https://github.com/cqfn/pdd/blob/master/README.md."
   exit(1)
 rescue StandardError => e
   PDD.log.error "#{Rainbow('ERROR').red} (#{e.class.name}): #{e.message}"
+  PDD.log.error Backtrace.new(e).to_s
   PDD.log.info 'Exit code is 255'
   exit(255)
 end