yard-lint 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce486b9b4338392c9c03ff8392f0f8bacbb7e303e1b594222ee7092ec2b916a7
-  data.tar.gz: 22defb3b4fc8f1ea0481bd16f3a0690930ce570678d3f625ae2500bd359fb8c0
+  metadata.gz: 21f921e879abc0fa9e4722a7731ca9a9cd2bf9ba80791be5de62e54c815dc64b
+  data.tar.gz: 921d9ece14e2b400b31c46cce77546fb59967d52fd7c0edb9e2e38a4085fd76a
 SHA512:
-  metadata.gz: 134751b6c3b73c9749d0b3ec156c67333caa3b610fdd74ddd86b581c4456c05e8485a7f9ab2adffefbbfe90d706b7a0919a78d2439f9219405c0c82e9dc5dd2d
-  data.tar.gz: 3e9fd559c1583cea798fdbe014e0e6c1a5bfb5243faf9cab8aad30ffeefce7771728fe679645eca2e35621675df3f8d2ec29f21f59d747be08ec275b765ecea2
+  metadata.gz: 83ee69985db1ad6ef6180e29a5a5b337f2e315616df2efabf8f954bad2940151bd55c79dd83fe872dbd10135250f571edc9010c5ce465f19fdc52508041a03b4
+  data.tar.gz: 81a12c4ecdbebe8eb45987d2b8a5e5b6d75104640e8af225c3a005b1db6daa17ba0bfbb46256e463ed71587de424e7acf70318d6ba88d877a0aff581f878339c

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # YARD-Lint Changelog
 
+## 1.2.3 (2025-11-13)
+- **[Feature]** Add per-validator exclusion support for fine-grained file filtering
+  - Individual validators can now specify `Exclude` patterns in `.yard-lint.yml`
+  - Exclusions work alongside global `AllValidators.Exclude` patterns
+  - Both global and per-validator exclusions are applied (union of both pattern sets)
+  - Enables excluding intentionally invalid documentation examples from specific validators
+  - Default config excludes validator implementation files and spec fixtures from `Tags/ExampleSyntax`
+  - Pattern matching works with glob patterns (`**/*.rb`, `**/validators/**/parser.rb`)
+  - Filters validator results based on file location, not just input file selection
+  - Handles both absolute and relative paths correctly in pattern matching
+  - Comprehensive integration test coverage for exclusion scenarios
+  - Example: Exclude parser.rb files with intentionally broken @example tags from syntax validation
+- **[Change]** Update `.yard-lint.yml` to set all validator severities to `error` level
+  - Changes `FailOnSeverity` from `warning` to `error` for stricter enforcement
+  - All validators now use `error` severity instead of `warning` or `convention`
+  - Ensures any documentation issue triggers exit code 1 for CI/CD pipelines
+  - Provides consistent behavior across all validation rules
+- **[Fix]** Fix integration tests failing due to fixture files being filtered by global exclusions
+  - Added `test_config` helper in spec_helper.rb that clears default exclusions for tests
+  - Updated all integration test files to use `test_config` instead of `Yard::Lint::Config.new`
+  - Prevents test fixtures in `spec/fixtures/` from being filtered out by `spec/**/*` exclusion pattern
+  - Ensures integration tests can properly validate linter behavior on fixture files
+- **[Fix]** Remove not needed `bin/` files.
+
 ## 1.2.2 (2025-11-13)
 - **[Fix]** Fix `--version` flag failing with `uninitialized constant Yard::Lint::VERSION` error
   - Zeitwerk expected `Version` (camel case) but file defined `VERSION` (all caps)

data/README.md

@@ -67,6 +67,17 @@ yard-lint --init
 
 This creates `.yard-lint.yml` with sensible defaults in your current directory.
 
+For new projects with high documentation standards, use strict mode:
+
+```bash
+yard-lint --init --strict
+```
+
+This creates a strict configuration with:
+- All validators set to `error` severity (no warnings or conventions)
+- Minimum documentation coverage set to 100%
+- Perfect for bootstrapping new repositories with high quality standards
+
 ### Command Line
 
 Basic usage:
@@ -87,6 +98,9 @@ yard-lint lib/ --format json > report.json
 # Generate config file (use --force to overwrite existing)
 yard-lint --init
 yard-lint --init --force
+
+# Generate strict config (all errors, 100% coverage)
+yard-lint --init --strict
 ```
 
 ### Diff Mode (Incremental Linting)
@@ -589,7 +603,14 @@ Options:
   -f, --format FORMAT     Output format (text, json)
   -q, --quiet             Quiet mode (only show summary)
       --stats             Show statistics summary
+      --min-coverage N    Minimum documentation coverage required (0-100)
       --[no-]progress     Show progress indicator (default: auto-detect TTY)
+      --diff [REF]        Lint only files changed since REF
+      --staged            Lint only staged files
+      --changed           Lint only uncommitted files
+      --init              Generate .yard-lint.yml config file
+      --strict            Generate strict config (use with --init)
+      --force             Force overwrite when using --init
   -v, --version           Show version
   -h, --help              Show this help
 ```

data/bin/yard-lint

@@ -59,6 +59,10 @@ OptionParser.new do |opts|
     options[:init] = true
   end
 
+  opts.on('--strict', 'Generate strict config (all Error severity, 100% coverage). Use with --init') do
+    options[:strict] = true
+  end
+
   opts.on('--force', 'Force overwrite when using --init') do
     options[:force] = true
   end
@@ -77,14 +81,20 @@ OptionParser.new do |opts|
     puts '  yard-lint lib/ --staged                 # Lint only staged files'
     puts '  yard-lint lib/ --changed                # Lint only uncommitted files'
     puts '  yard-lint lib/ --format json            # Output in JSON format'
+    puts '  yard-lint --init                        # Generate default config'
+    puts '  yard-lint --init --strict               # Generate strict config (all errors, 100% coverage)'
     exit
   end
 end.parse!
 
 # Handle --init flag
 if options[:init]
-  if Yard::Lint::ConfigGenerator.generate(force: options[:force])
-    puts 'Created .yard-lint.yml with default configuration'
+  if Yard::Lint::ConfigGenerator.generate(force: options[:force], strict: options[:strict])
+    if options[:strict]
+      puts 'Created .yard-lint.yml with strict configuration (all Error severity, 100% coverage)'
+    else
+      puts 'Created .yard-lint.yml with default configuration'
+    end
     exit 0
   else
     puts 'Error: .yard-lint.yml already exists'

data/lib/yard/lint/config_generator.rb

@@ -4,194 +4,23 @@ module Yard
   module Lint
     # Generates default .yard-lint.yml configuration file
     class ConfigGenerator
-      # Default configuration template
-      DEFAULT_CONFIG = <<~YAML
-        # YARD-Lint Configuration
-        # See https://github.com/mensfeld/yard-lint for documentation
-
-        # Global settings for all validators
-        AllValidators:
-          # YARD command-line options (applied to all validators by default)
-          YardOptions:
-            - --private
-            - --protected
-
-          # Global file exclusion patterns
-          Exclude:
-            - '\\.git'
-            - 'vendor/**/*'
-            - 'node_modules/**/*'
-            - 'spec/**/*'
-            - 'test/**/*'
-
-          # Exit code behavior (error, warning, convention, never)
-          FailOnSeverity: warning
-
-          # Minimum documentation coverage percentage (0-100)
-          # Fails if coverage is below this threshold
-          # MinCoverage: 80.0
-
-          # Diff mode settings
-          DiffMode:
-            # Default base ref for --diff (auto-detects main/master if not specified)
-            DefaultBaseRef: ~
-
-        # Documentation validators
-        Documentation/UndocumentedObjects:
-          Description: 'Checks for classes, modules, and methods without documentation.'
-          Enabled: true
-          Severity: warning
-          ExcludedMethods:
-            - 'initialize/0'  # Exclude parameter-less initialize
-            - '/^_/'          # Exclude private methods (by convention)
-
-        Documentation/UndocumentedMethodArguments:
-          Description: 'Checks for method parameters without @param tags.'
-          Enabled: true
-          Severity: warning
-
-        Documentation/UndocumentedBooleanMethods:
-          Description: 'Checks that question mark methods document their boolean return.'
-          Enabled: true
-          Severity: warning
-
-        Documentation/UndocumentedOptions:
-          Description: 'Detects methods with options hash parameters but no @option tags.'
-          Enabled: true
-          Severity: warning
-
-        Documentation/MarkdownSyntax:
-          Description: 'Detects common markdown syntax errors in documentation.'
-          Enabled: true
-          Severity: warning
-
-        # Tags validators
-        Tags/Order:
-          Description: 'Enforces consistent ordering of YARD tags.'
-          Enabled: true
-          Severity: convention
-          EnforcedOrder:
-            - param
-            - option
-            - return
-            - raise
-            - example
-
-        Tags/InvalidTypes:
-          Description: 'Validates type definitions in @param, @return, @option tags.'
-          Enabled: true
-          Severity: warning
-          ValidatedTags:
-            - param
-            - option
-            - return
-
-        Tags/TypeSyntax:
-          Description: 'Validates YARD type syntax using YARD parser.'
-          Enabled: true
-          Severity: warning
-          ValidatedTags:
-            - param
-            - option
-            - return
-            - yieldreturn
-
-        Tags/MeaninglessTag:
-          Description: 'Detects @param/@option tags on classes, modules, or constants.'
-          Enabled: true
-          Severity: warning
-          CheckedTags:
-            - param
-            - option
-          InvalidObjectTypes:
-            - class
-            - module
-            - constant
-
-        Tags/CollectionType:
-          Description: 'Validates Hash collection syntax consistency.'
-          Enabled: true
-          Severity: convention
-          EnforcedStyle: long  # 'long' for Hash{K => V} (YARD standard), 'short' for {K => V}
-          ValidatedTags:
-            - param
-            - option
-            - return
-            - yieldreturn
-
-        Tags/TagTypePosition:
-          Description: 'Validates type annotation position in tags.'
-          Enabled: true
-          Severity: convention
-          CheckedTags:
-            - param
-            - option
-          # EnforcedStyle: 'type_after_name' (YARD standard: @param name [Type])
-          #                or 'type_first' (@param [Type] name)
-          EnforcedStyle: type_after_name
-
-        Tags/ApiTags:
-          Description: 'Enforces @api tags on public objects.'
-          Enabled: false  # Opt-in validator
-          Severity: warning
-          AllowedApis:
-            - public
-            - private
-            - internal
-
-        Tags/OptionTags:
-          Description: 'Requires @option tags for methods with options parameters.'
-          Enabled: true
-          Severity: warning
-
-        # Warnings validators - catches YARD parser errors
-        Warnings/UnknownTag:
-          Description: 'Detects unknown YARD tags.'
-          Enabled: true
-          Severity: error
-
-        Warnings/UnknownDirective:
-          Description: 'Detects unknown YARD directives.'
-          Enabled: true
-          Severity: error
-
-        Warnings/InvalidTagFormat:
-          Description: 'Detects malformed tag syntax.'
-          Enabled: true
-          Severity: error
-
-        Warnings/InvalidDirectiveFormat:
-          Description: 'Detects malformed directive syntax.'
-          Enabled: true
-          Severity: error
-
-        Warnings/DuplicatedParameterName:
-          Description: 'Detects duplicate @param tags.'
-          Enabled: true
-          Severity: error
-
-        Warnings/UnknownParameterName:
-          Description: 'Detects @param tags for non-existent parameters.'
-          Enabled: true
-          Severity: error
-
-        # Semantic validators
-        Semantic/AbstractMethods:
-          Description: 'Ensures @abstract methods do not have real implementations.'
-          Enabled: true
-          Severity: warning
-      YAML
+      # Path to templates directory
+      TEMPLATES_DIR = File.expand_path('templates', __dir__)
 
       # Generate .yard-lint.yml file in current directory
       # @param force [Boolean] overwrite existing file if true
+      # @param strict [Boolean] generate strict configuration (all errors, 100% coverage)
       # @return [Boolean] true if file was created, false if already exists
-      def self.generate(force: false)
+      def self.generate(force: false, strict: false)
         config_path = File.join(Dir.pwd, Config::DEFAULT_CONFIG_FILE)
 
         if File.exist?(config_path) && !force
           false
         else
-          File.write(config_path, DEFAULT_CONFIG)
+          template_name = strict ? 'strict_config.yml' : 'default_config.yml'
+          template_path = File.join(TEMPLATES_DIR, template_name)
+          content = File.read(template_path)
+          File.write(config_path, content)
           true
         end
       end

data/lib/yard/lint/runner.rb

@@ -96,6 +96,43 @@ module Yard
         end
       end
 
+      # Filter result offenses based on per-validator exclusions
+      # Removes offenses where the file path matches exclusion patterns
+      # @param validator_name [String] full validator name
+      # @param result [Results::Base] result object with offenses
+      # @return [Results::Base, nil] result with filtered offenses, or nil if no offenses remain
+      def filter_result_offenses(validator_name, result)
+        validator_excludes = config.validator_all_excludes(validator_name)
+        return result if validator_excludes.empty?
+
+        working_dir = Dir.pwd
+        filtered_keys = %i[severity type name message location_line]
+
+        filtered_offenses = result.offenses.reject do |offense|
+          file_path = offense[:location] || offense[:file]
+          next true unless file_path
+
+          # Convert to relative path for pattern matching
+          relative_path = if file_path.start_with?(working_dir)
+                            file_path.sub(%r{^#{Regexp.escape(working_dir)}/}, '')
+                          else
+                            file_path
+                          end
+
+          # Check if file matches any exclusion pattern
+          validator_excludes.any? do |pattern|
+            File.fnmatch(pattern, relative_path, File::FNM_PATHNAME | File::FNM_EXTGLOB)
+          end
+        end
+
+        # Return nil if no offenses remain after filtering
+        return nil if filtered_offenses.empty?
+
+        # Create a new result object with filtered offenses
+        # We need to preserve the result class and config
+        result.class.new(filtered_offenses.map { |o| o.except(*filtered_keys) }, result.config)
+      end
+
       # Parse raw results from validators and create Result objects
       # Delegates result building to ResultBuilder
       # @param raw [Hash] hash with raw results from all validators
@@ -108,7 +145,11 @@ module Yard
           next unless config.validator_enabled?(validator_name)
 
           result = @result_builder.build(validator_name, raw)
-          results << result if result
+          next unless result
+
+          # Filter offenses based on per-validator exclusions
+          filtered_result = filter_result_offenses(validator_name, result)
+          results << filtered_result if filtered_result
         end
 
         results

data/lib/yard/lint/stats_calculator.rb

@@ -8,7 +8,7 @@ module Yard
       attr_reader :config, :files
 
       # @param config [Yard::Lint::Config] configuration object
-      # @param files [Array<String>] files to analyze
+      # @param files [Array<String>] Ruby source files whose YARD documentation will be checked for coverage statistics
       def initialize(config, files)
         @config = config
         @files = Array(files).compact

data/lib/yard/lint/templates/default_config.yml

@@ -0,0 +1,174 @@
+# YARD-Lint Configuration
+# See https://github.com/mensfeld/yard-lint for documentation
+
+# Global settings for all validators
+AllValidators:
+  # YARD command-line options (applied to all validators by default)
+  YardOptions:
+    - --private
+    - --protected
+
+  # Global file exclusion patterns
+  Exclude:
+    - '\.git'
+    - 'vendor/**/*'
+    - 'node_modules/**/*'
+    - 'spec/**/*'
+    - 'test/**/*'
+
+  # Exit code behavior (error, warning, convention, never)
+  FailOnSeverity: warning
+
+  # Minimum documentation coverage percentage (0-100)
+  # Fails if coverage is below this threshold
+  # MinCoverage: 80.0
+
+  # Diff mode settings
+  DiffMode:
+    # Default base ref for --diff (auto-detects main/master if not specified)
+    DefaultBaseRef: ~
+
+# Documentation validators
+Documentation/UndocumentedObjects:
+  Description: 'Checks for classes, modules, and methods without documentation.'
+  Enabled: true
+  Severity: warning
+  ExcludedMethods:
+    - 'initialize/0'  # Exclude parameter-less initialize
+    - '/^_/'          # Exclude private methods (by convention)
+
+Documentation/UndocumentedMethodArguments:
+  Description: 'Checks for method parameters without @param tags.'
+  Enabled: true
+  Severity: warning
+
+Documentation/UndocumentedBooleanMethods:
+  Description: 'Checks that question mark methods document their boolean return.'
+  Enabled: true
+  Severity: warning
+
+Documentation/UndocumentedOptions:
+  Description: 'Detects methods with options hash parameters but no @option tags.'
+  Enabled: true
+  Severity: warning
+
+Documentation/MarkdownSyntax:
+  Description: 'Detects common markdown syntax errors in documentation.'
+  Enabled: true
+  Severity: warning
+
+# Tags validators
+Tags/Order:
+  Description: 'Enforces consistent ordering of YARD tags.'
+  Enabled: true
+  Severity: convention
+  EnforcedOrder:
+    - param
+    - option
+    - return
+    - raise
+    - example
+
+Tags/InvalidTypes:
+  Description: 'Validates type definitions in @param, @return, @option tags.'
+  Enabled: true
+  Severity: warning
+  ValidatedTags:
+    - param
+    - option
+    - return
+
+Tags/TypeSyntax:
+  Description: 'Validates YARD type syntax using YARD parser.'
+  Enabled: true
+  Severity: warning
+  ValidatedTags:
+    - param
+    - option
+    - return
+    - yieldreturn
+
+Tags/MeaninglessTag:
+  Description: 'Detects @param/@option tags on classes, modules, or constants.'
+  Enabled: true
+  Severity: warning
+  CheckedTags:
+    - param
+    - option
+  InvalidObjectTypes:
+    - class
+    - module
+    - constant
+
+Tags/CollectionType:
+  Description: 'Validates Hash collection syntax consistency.'
+  Enabled: true
+  Severity: convention
+  EnforcedStyle: long  # 'long' for Hash{K => V} (YARD standard), 'short' for {K => V}
+  ValidatedTags:
+    - param
+    - option
+    - return
+    - yieldreturn
+
+Tags/TagTypePosition:
+  Description: 'Validates type annotation position in tags.'
+  Enabled: true
+  Severity: convention
+  CheckedTags:
+    - param
+    - option
+  # EnforcedStyle: 'type_after_name' (YARD standard: @param name [Type])
+  #                or 'type_first' (@param [Type] name)
+  EnforcedStyle: type_after_name
+
+Tags/ApiTags:
+  Description: 'Enforces @api tags on public objects.'
+  Enabled: false  # Opt-in validator
+  Severity: warning
+  AllowedApis:
+    - public
+    - private
+    - internal
+
+Tags/OptionTags:
+  Description: 'Requires @option tags for methods with options parameters.'
+  Enabled: true
+  Severity: warning
+
+# Warnings validators - catches YARD parser errors
+Warnings/UnknownTag:
+  Description: 'Detects unknown YARD tags.'
+  Enabled: true
+  Severity: error
+
+Warnings/UnknownDirective:
+  Description: 'Detects unknown YARD directives.'
+  Enabled: true
+  Severity: error
+
+Warnings/InvalidTagFormat:
+  Description: 'Detects malformed tag syntax.'
+  Enabled: true
+  Severity: error
+
+Warnings/InvalidDirectiveFormat:
+  Description: 'Detects malformed directive syntax.'
+  Enabled: true
+  Severity: error
+
+Warnings/DuplicatedParameterName:
+  Description: 'Detects duplicate @param tags.'
+  Enabled: true
+  Severity: error
+
+Warnings/UnknownParameterName:
+  Description: 'Detects @param tags for non-existent parameters.'
+  Enabled: true
+  Severity: error
+
+# Semantic validators
+Semantic/AbstractMethods:
+  Description: 'Ensures @abstract methods do not have real implementations.'
+  Enabled: true
+  Severity: warning

data/lib/yard/lint/templates/strict_config.yml

@@ -0,0 +1,178 @@
+# YARD-Lint Configuration (Strict Mode)
+# See https://github.com/mensfeld/yard-lint for documentation
+#
+# This is a strict configuration suitable for new projects with high documentation standards.
+# All validators are set to 'error' severity (no warnings or conventions).
+# Minimum coverage is set to 100%.
+
+# Global settings for all validators
+AllValidators:
+  # YARD command-line options (applied to all validators by default)
+  YardOptions:
+    - --private
+    - --protected
+
+  # Global file exclusion patterns
+  Exclude:
+    - '\.git'
+    - 'vendor/**/*'
+    - 'node_modules/**/*'
+    - 'spec/**/*'
+    - 'test/**/*'
+
+  # Exit code behavior (error, warning, convention, never)
+  FailOnSeverity: error
+
+  # Minimum documentation coverage percentage (0-100)
+  # Fails if coverage is below this threshold
+  MinCoverage: 100.0
+
+  # Diff mode settings
+  DiffMode:
+    # Default base ref for --diff (auto-detects main/master if not specified)
+    DefaultBaseRef: ~
+
+# Documentation validators
+Documentation/UndocumentedObjects:
+  Description: 'Checks for classes, modules, and methods without documentation.'
+  Enabled: true
+  Severity: error
+  ExcludedMethods:
+    - 'initialize/0'  # Exclude parameter-less initialize
+    - '/^_/'          # Exclude private methods (by convention)
+
+Documentation/UndocumentedMethodArguments:
+  Description: 'Checks for method parameters without @param tags.'
+  Enabled: true
+  Severity: error
+
+Documentation/UndocumentedBooleanMethods:
+  Description: 'Checks that question mark methods document their boolean return.'
+  Enabled: true
+  Severity: error
+
+Documentation/UndocumentedOptions:
+  Description: 'Detects methods with options hash parameters but no @option tags.'
+  Enabled: true
+  Severity: error
+
+Documentation/MarkdownSyntax:
+  Description: 'Detects common markdown syntax errors in documentation.'
+  Enabled: true
+  Severity: error
+
+# Tags validators
+Tags/Order:
+  Description: 'Enforces consistent ordering of YARD tags.'
+  Enabled: true
+  Severity: error
+  EnforcedOrder:
+    - param
+    - option
+    - return
+    - raise
+    - example
+
+Tags/InvalidTypes:
+  Description: 'Validates type definitions in @param, @return, @option tags.'
+  Enabled: true
+  Severity: error
+  ValidatedTags:
+    - param
+    - option
+    - return
+
+Tags/TypeSyntax:
+  Description: 'Validates YARD type syntax using YARD parser.'
+  Enabled: true
+  Severity: error
+  ValidatedTags:
+    - param
+    - option
+    - return
+    - yieldreturn
+
+Tags/MeaninglessTag:
+  Description: 'Detects @param/@option tags on classes, modules, or constants.'
+  Enabled: true
+  Severity: error
+  CheckedTags:
+    - param
+    - option
+  InvalidObjectTypes:
+    - class
+    - module
+    - constant
+
+Tags/CollectionType:
+  Description: 'Validates Hash collection syntax consistency.'
+  Enabled: true
+  Severity: error
+  EnforcedStyle: long  # 'long' for Hash{K => V} (YARD standard), 'short' for {K => V}
+  ValidatedTags:
+    - param
+    - option
+    - return
+    - yieldreturn
+
+Tags/TagTypePosition:
+  Description: 'Validates type annotation position in tags.'
+  Enabled: true
+  Severity: error
+  CheckedTags:
+    - param
+    - option
+  # EnforcedStyle: 'type_after_name' (YARD standard: @param name [Type])
+  #                or 'type_first' (@param [Type] name)
+  EnforcedStyle: type_after_name
+
+Tags/ApiTags:
+  Description: 'Enforces @api tags on public objects.'
+  Enabled: false  # Opt-in validator
+  Severity: error
+  AllowedApis:
+    - public
+    - private
+    - internal
+
+Tags/OptionTags:
+  Description: 'Requires @option tags for methods with options parameters.'
+  Enabled: true
+  Severity: error
+
+# Warnings validators - catches YARD parser errors
+Warnings/UnknownTag:
+  Description: 'Detects unknown YARD tags.'
+  Enabled: true
+  Severity: error
+
+Warnings/UnknownDirective:
+  Description: 'Detects unknown YARD directives.'
+  Enabled: true
+  Severity: error
+
+Warnings/InvalidTagFormat:
+  Description: 'Detects malformed tag syntax.'
+  Enabled: true
+  Severity: error
+
+Warnings/InvalidDirectiveFormat:
+  Description: 'Detects malformed directive syntax.'
+  Enabled: true
+  Severity: error
+
+Warnings/DuplicatedParameterName:
+  Description: 'Detects duplicate @param tags.'
+  Enabled: true
+  Severity: error
+
+Warnings/UnknownParameterName:
+  Description: 'Detects @param tags for non-existent parameters.'
+  Enabled: true
+  Severity: error
+
+# Semantic validators
+Semantic/AbstractMethods:
+  Description: 'Ensures @abstract methods do not have real implementations.'
+  Enabled: true
+  Severity: error

data/lib/yard/lint/validators/documentation/undocumented_objects/parser.rb

@@ -16,7 +16,7 @@ module Yard
 
             # @param yard_list_output [String] raw yard list results string
             # @param config [Yard::Lint::Config, nil] configuration object (optional)
-            # @param _kwargs [Hash] unused keyword arguments (for compatibility)
+            # @option _kwargs [Object] :unused this parameter accepts no options (reserved for future use)
             # @return [Array<Hash>] Array with undocumented objects details
             def call(yard_list_output, config: nil, **_kwargs)
               excluded_methods = config&.validator_config(
@@ -108,7 +108,7 @@ module Yard
 
             # Match an arity pattern like "initialize/0"
             # @param method_name [String] the method name
-            # @param arity [Integer, nil] the method's arity
+            # @param arity [Integer, nil] number of parameters the method accepts (nil if unknown)
             # @param pattern [String] the full pattern like "initialize/0"
             # @return [Boolean] true if matches
             def match_arity_pattern(method_name, arity, pattern)

data/lib/yard/lint/validators/tags/collection_type/parser.rb

@@ -9,7 +9,7 @@ module Yard
           class Parser < ::Yard::Lint::Parsers::Base
             # Parses YARD query output into structured violation data
             # @param yard_output [String] raw output from YARD query
-            # @param _kwargs [Hash] additional keyword arguments (unused)
+            # @option _kwargs [Object] :unused this parameter accepts no options (reserved for future use)
             # @return [Array<Hash>] array of violation hashes
             def call(yard_output, **_kwargs)
               return [] if yard_output.nil? || yard_output.strip.empty?

data/lib/yard/lint/validators/tags/meaningless_tag/parser.rb

@@ -13,7 +13,7 @@ module Yard
             #   file.rb:LINE: ClassName
             #   object_type|tag_name
             # @param yard_output [String] raw YARD query results
-            # @param _kwargs [Hash] unused keyword arguments (for compatibility)
+            # @option _kwargs [Object] :unused this parameter accepts no options (reserved for future use)
             # @return [Array<Hash>] array with violation details
             def call(yard_output, **_kwargs)
               return [] if yard_output.nil? || yard_output.strip.empty?

data/lib/yard/lint/validators/tags/tag_type_position/parser.rb

@@ -9,7 +9,7 @@ module Yard
           class Parser < ::Yard::Lint::Parsers::Base
             # Parses YARD query output into structured violation data
             # @param yard_output [String] raw output from YARD query
-            # @param _kwargs [Hash] additional keyword arguments (unused)
+            # @option _kwargs [Object] :unused this parameter accepts no options (reserved for future use)
             # @return [Array<Hash>] array of violation hashes
             def call(yard_output, **_kwargs)
               return [] if yard_output.nil? || yard_output.strip.empty?

data/lib/yard/lint/validators/tags/tag_type_position.rb

@@ -20,8 +20,8 @@ module Yard
         #   end
         #
         # @example Bad - Type before parameter name (when using default style)
-        #   # @param [String] name the user's name
-        #   # @param [Integer] age the user's age
+        #   # @param name [String] the user's name
+        #   # @param age [Integer] the user's age
         #   def create_user(name, age)
         #   end
         #
@@ -33,8 +33,8 @@ module Yard
         #       EnforcedStyle: type_first
         #
         # @example Good - When EnforcedStyle is type_first
-        #   # @param [String] name the user's name
-        #   # @param [Integer] age the user's age
+        #   # @param name [String] the user's name
+        #   # @param age [Integer] the user's age
         #   def create_user(name, age)
         #   end
         #

data/lib/yard/lint/validators/tags/type_syntax/parser.rb

@@ -13,7 +13,7 @@ module Yard
             #   file.rb:LINE: ClassName#method_name
             #   tag_name|type_string|error_message
             # @param yard_output [String] raw YARD query results
-            # @param _kwargs [Hash] unused keyword arguments (for compatibility)
+            # @option _kwargs [Object] :unused this parameter accepts no options (reserved for future use)
             # @return [Array<Hash>] array with violation details
             def call(yard_output, **_kwargs)
               return [] if yard_output.nil? || yard_output.strip.empty?

data/lib/yard/lint/version.rb

@@ -3,6 +3,6 @@
 module Yard
   module Lint
     # @return [String] version of the YARD Lint gem
-    VERSION = '1.2.2'
+    VERSION = '1.2.3'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-lint
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -42,8 +42,6 @@ description: A comprehensive linter for YARD documentation that checks for undoc
 email:
 - maciej@mensfeld.pl
 executables:
-- console
-- setup
 - yard-lint
 extensions: []
 extra_rdoc_files: []
@@ -53,8 +51,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - bin/yard-lint
 - lib/yard-lint.rb
 - lib/yard/lint.rb
@@ -74,6 +70,8 @@ files:
 - lib/yard/lint/results/base.rb
 - lib/yard/lint/runner.rb
 - lib/yard/lint/stats_calculator.rb
+- lib/yard/lint/templates/default_config.yml
+- lib/yard/lint/templates/strict_config.yml
 - lib/yard/lint/validators/base.rb
 - lib/yard/lint/validators/config.rb
 - lib/yard/lint/validators/documentation/markdown_syntax.rb

data/bin/console

@@ -1,11 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "yard/lint"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here