Replace yardstick and yard-junk with yard-lint for docs

Removed yardstick and yard-junk dependencies, configuration, and tasks in favor of using yard-lint for documentation linting and coverage enforcement. Updated documentation, Rakefile, CI workflow, and Gemfile accordingly. This simplifies documentation quality checks and unifies the workflow around yard-lint.

Author: wilsonsilva

.claude/commands/document.md

@@ -14,46 +14,11 @@ Format YARD comments:
 bundle exec rake yard:format
 ```
 
-Verify 100% documentation coverage:
-```bash
-bundle exec rake verify_measurements
-```
-
 Check for documentation quality issues:
 ```bash
-bundle exec rake yard:junk
-```
-
-Generate coverage report:
-```bash
-bundle exec rake yardstick_measure
+bundle exec yard-lint lib/
 ```
 
-## Configuration
-
-Requires `.yardstick.yml` in project root with 100% threshold:
-```yaml
-threshold: 100
-rules:
-  ApiTag::Presence: { enabled: true }
-  ApiTag::Inclusion: { enabled: true }
-  ApiTag::ProtectedMethod: { enabled: true }
-  ApiTag::PrivateMethod: { enabled: true }
-  ExampleTag: { enabled: true }
-  ReturnTag: { enabled: true }
-  Summary::Presence: { enabled: true }
-  Summary::Delimiter: { enabled: true }
-```
-
-## Coverage Report
-
-After running measurement, check detailed line-by-line issues:
-```bash
-cat measurements/report.txt
-```
-
-Report shows specific file, line number, method, and documentation issues that need fixing.
-
 ## Documentation Standards
 
 ### Required Tags
@@ -87,7 +52,7 @@ Report shows specific file, line number, method, and documentation issues that n
 #   result # => expected_output
 #
 # @param name [Type] Description
-# @param other [Type] Other description  
+# @param other [Type] Other description
 #
 # @return [Type] Description
 #
@@ -102,4 +67,4 @@ end
 Documentation verification is included in the quality assurance pipeline:
 ```bash
 bundle exec rake qa
-```
+```

.claude/docs/yard.md

@@ -29,32 +29,7 @@ Every piece of public and private code must be documented. Documentation serves
 
 ## YARD Configuration
 
-Create a `.yardstick.yml` file in your project root with 100% coverage requirements:
-
-```yaml
-threshold: 100
-rules:
-  ApiTag::Presence:
-    enabled: true
-  ApiTag::Inclusion:
-    enabled: true
-  ApiTag::ProtectedMethod:
-    enabled: true
-  ApiTag::PrivateMethod:
-    enabled: true
-  ExampleTag:
-    enabled: true
-  ReturnTag:
-    enabled: true
-  Summary::Presence:
-    enabled: true
-  Summary::Length:
-    enabled: false
-  Summary::Delimiter:
-    enabled: true
-  Summary::SingleLine:
-    enabled: false
-```
+The configuration file is located at `.yard-lint.yml` in the root of the project.
 
 ## Basic Documentation Structure
 
@@ -460,64 +435,26 @@ end
 
 ## Quality Enforcement
 
-Our project enforces 100% documentation coverage using the `yardstick` gem and maintains documentation quality with the `yard:junk` task. This ensures that all code is thoroughly documented, maintainable, and easy for developers to use.
+This project uses `yard-lint` to enforce documentation standards and coverage.
 
 ### How it Works
 
-1.  **Configuration**: A `.yardstick.yml` file in the project root sets the documentation coverage threshold to 100% and defines specific documentation rules.
-
-2.  **Measurement**: The `yardstick_measure` Rake task measures the current documentation coverage against the configured rules. Run it using:
+1.  **Configuration**: A `.yard-lint.yml` file in the project root defines the rules, severity, and coverage requirements.
+2.  **Linting**: Run `yard-lint` to check for documentation issues.
 
     ```bash
-    bundle exec rake yardstick_measure
+    bundle exec yard-lint lib/
     ```
 
-    This task generates a detailed report in `measurements/report.txt` that lists all documentation issues that need to be addressed.
+    This command will output any documentation issues found.
 
-3.  **Verification**: The `verify_measurements` Rake task checks if the coverage meets the 100% threshold. Run it using:
+3.  **Rake Integration**: A Rake task is provided for convenience.
 
     ```bash
-    bundle exec rake verify_measurements
+    bundle exec rake yard:lint
     ```
 
-    This task will fail if coverage is below 100%, displaying the current coverage percentage and indicating that documentation improvements are needed.
-
-4.  **Review Report**: Always check the contents of `measurements/report.txt` after running measurement tasks. This file contains specific details about:
-    - Missing method documentation
-    - Incomplete parameter descriptions
-    - Missing return value documentation
-    - Missing examples
-    - Incorrect API tags
-
-    Each line in the report shows the file, line number, method, and specific issue that needs to be addressed to achieve 100% documentation compliance.
-
-### Rake Integration
-
-The `Rakefile` integrates `yardstick` into our development workflow. The `qa` task, which runs a full suite of tests and checks, includes the documentation verification step.
-
-```ruby
-# Rakefile
-require 'yardstick/rake/measurement'
-require 'yardstick/rake/verify'
-
-yardstick_options = YAML.load_file('.yardstick.yml')
-
-Yardstick::Rake::Measurement.new(:yardstick_measure, yardstick_options)
-Yardstick::Rake::Verify.new
-
-desc 'Test, lint and perform security and documentation audits'
-task qa: %w[spec rubocop yard:junk verify_measurements bundle:audit]
-```
-
-### CI Integration
-
-Continuous Integration (CI) automatically enforces our documentation standard on every commit by running:
-
-```bash
-bundle exec rake verify_measurements
-```
-
-This prevents any code with incomplete documentation from being merged.
+4.  **CI Integration**: The CI pipeline runs `yard-lint` on every commit to ensure that all code is well-documented.
 
 ## Best Practices
 
@@ -600,3 +537,4 @@ For complex examples, use proper formatting:
 ```
 
 This documentation standard ensures that your Ruby projects maintain professional-quality documentation that supports both development and maintenance activities while providing excellent IDE integration and user experience.
+

.github/workflows/main.yml

@@ -35,7 +35,7 @@ jobs:
       - name: Run RuboCop
         run: bundle exec rake rubocop
 
-  yard_junk:
+  yard_lint:
     runs-on: ubuntu-latest
     name: Validate YARD documentation
     steps:
@@ -44,20 +44,8 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
-      - name: Run yard:junk
-        run: bundle exec rake yard:junk
-
-  yardstick:
-    runs-on: ubuntu-latest
-    name: Measure YARD documentation
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true
-      - name: Run verify_measurements
-        run: bundle exec rake verify_measurements
+      - name: Run yard-lint
+        run: bundle exec yard-lint lib/
 
   bundle_audit:
     runs-on: ubuntu-latest

.gitignore

@@ -13,9 +13,6 @@
 # secret environment variables
 .env
 
-# yardstick report
-measurements/report.txt
-
 # log files
 *.log
 

.yardstick.yml

@@ -34,7 +34,5 @@ group :development do
   gem 'steep', '~> 1.10'
   gem 'typeprof', '~> 0.30'
   gem 'yard', '~> 0.9'
-  gem 'yard-junk', '~> 0.0'
   gem 'yard-lint', '~> 1.3'
-  gem 'yardstick', '~> 0.9'
 end

Gemfile

@@ -26,7 +26,6 @@ GEM
     ansi (1.5.0)
     ast (2.4.3)
     awesome_print (1.9.2)
-    backports (3.25.1)
     base64 (0.3.0)
     benchmark (0.4.1)
     bigdecimal (3.2.3)
@@ -278,16 +277,9 @@ GEM
     unicode-emoji (4.1.0)
     uri (1.0.3)
     yard (0.9.37)
-    yard-junk (0.0.10)
-      backports (>= 3.18)
-      ostruct
-      rainbow
-      yard
     yard-lint (1.3.0)
       yard (~> 0.9)
       zeitwerk (~> 2.6)
-    yardstick (0.9.9)
-      yard (~> 0.8, >= 0.8.7.2)
     zeitwerk (2.7.3)
 
 PLATFORMS
@@ -333,9 +325,7 @@ DEPENDENCIES
   steep (~> 1.10)
   typeprof (~> 0.30)
   yard (~> 0.9)
-  yard-junk (~> 0.0)
   yard-lint (~> 1.3)
-  yardstick (~> 0.9)
 
 BUNDLED WITH
    2.7.0

Gemfile.lock

@@ -185,11 +185,9 @@ rake rubocop                  # Run RuboCop
 rake rubocop:autocorrect      # Autocorrect RuboCop offenses (only when it's safe)
 rake rubocop:autocorrect_all  # Autocorrect RuboCop offenses (safe and unsafe)
 rake spec                     # Run RSpec code examples
-rake verify_measurements      # Verify that yardstick coverage is at least 100%
 rake yard                     # Generate YARD Documentation
 rake yard:format              # Format YARD documentation
-rake yard:junk                # Check the junk in your YARD Documentation
-rake yardstick_measure        # Measure docs in lib/**/*.rb with yardstick
+rake yard:lint                # Lint YARD documentation
 ```
 
 ### 🧪 Type checking

README.md

@@ -7,19 +7,11 @@ require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 require 'yaml'
 require 'yard/rake/yardoc_task'
-require 'yard-junk/rake'
-require 'yardstick/rake/measurement'
-require 'yardstick/rake/verify'
-
-yardstick_options = YAML.load_file('.yardstick.yml')
 
 Bundler::Audit::Task.new
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new
 YARD::Rake::YardocTask.new
-YardJunk::Rake.define_task
-Yardstick::Rake::Measurement.new(:yardstick_measure, yardstick_options)
-Yardstick::Rake::Verify.new(:verify_measurements, yardstick_options)
 
 task default: %i[spec rubocop]
 
@@ -37,7 +29,7 @@ task :coverage do
 end
 
 desc 'Test, lint and perform security and documentation audits'
-task qa: %w[spec rubocop yard:junk verify_measurements bundle:audit]
+task qa: %w[spec rubocop yard:lint bundle:audit]
 
 namespace :yard do
   desc 'Format YARD documentation'
@@ -95,6 +87,11 @@ namespace :yard do
     puts
     puts 'Done!'
   end
+
+  desc 'Lint YARD documentation'
+  task :lint do
+    system 'bundle exec yard-lint lib/'
+  end
 end
 
 namespace :examples do