yard-lint 1.4.0 → 1.5.1

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Yard
+  module Lint
+    module Validators
+      module Tags
+        # ExampleStyle validator
+        #
+        # Validates code style in `@example` tags using RuboCop or StandardRB.
+        # This validator ensures that code examples follow the same style guidelines
+        # as the project codebase for consistency.
+        #
+        # ## Requirements
+        #
+        # - RuboCop or StandardRB gem must be installed
+        # - Validator auto-detects which linter to use based on project setup
+        #
+        # ## Configuration
+        #
+        # Basic usage:
+        #
+        #     Tags/ExampleStyle:
+        #       Enabled: true
+        #
+        # Advanced configuration:
+        #
+        #     Tags/ExampleStyle:
+        #       Enabled: true
+        #       Linter: auto  # 'auto', 'rubocop', 'standard', or 'none'
+        #       SkipPatterns:
+        #         - '/skip-lint/i'
+        #         - '/bad code/i'
+        #       DisabledCops:
+        #         - 'Metrics/MethodLength'
+        #
+        # ## Skipping Examples
+        #
+        # Skip linting for specific examples (negative examples):
+        #
+        #     # @example Bad code (skip-lint)
+        #     #   user = User.new("invalid")
+        #
+        # Or use inline RuboCop directives:
+        #
+        #     # @example
+        #     #   # rubocop:disable all
+        #     #   user = User.new("invalid")
+        #     #   # rubocop:enable all
+        module ExampleStyle
+          autoload :Validator, 'yard/lint/validators/tags/example_style/validator'
+          autoload :Config, 'yard/lint/validators/tags/example_style/config'
+          autoload :Parser, 'yard/lint/validators/tags/example_style/parser'
+          autoload :Result, 'yard/lint/validators/tags/example_style/result'
+          autoload :MessagesBuilder, 'yard/lint/validators/tags/example_style/messages_builder'
+          autoload :LinterDetector, 'yard/lint/validators/tags/example_style/linter_detector'
+          autoload :RubocopRunner, 'yard/lint/validators/tags/example_style/rubocop_runner'
+        end
+      end
+    end
+  end
+end

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

@@ -37,14 +37,14 @@ module Yard
         #   # Does something
         #   # @return [void]
         #   def do_something
-        #     puts 'done'
+        #     puts "done"
         #   end
         #
         # @example Good - Document side effects instead
         #   # Prints 'done' to stdout
         #   # @return [nil] always returns nil after printing
         #   def do_something
-        #     puts 'done'
+        #     puts "done"
         #   end
         #
         # @example Bad - @param [Object] (when configured as forbidden)

data/lib/yard/lint/validators/tags/invalid_types/validator.rb

@@ -34,7 +34,7 @@ module Yard
               allowed_types = ALLOWED_DEFAULTS + extra_types
 
               # Sanitize type string (remove type syntax characters)
-              sanitize = ->(type) { type.tr('=><>,{} ', '') }
+              sanitize = ->(type) { type.tr('=><>,{} ()', '') }
 
               # Check for invalid types
               invalid_types = object.docstring.tags

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

@@ -7,7 +7,7 @@ module Yard
         module TagGroupSeparator
           # Parser for extracting tag group separator violations from raw validator output.
           #
-          # @example Output format
+          # @example Output format (skip-lint)
           #   /path/to/file.rb:10: ClassName#method_name
           #   param->return,return->error
           class Parser < Parsers::Base

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

@@ -7,6 +7,18 @@ module Yard
         module TypeSyntax
           # Runs YARD to validate type syntax using TypesExplainer::Parser
           class Validator < Base
+            # Matches valid Ruby symbol literals: :foo, :foo?, :foo!, :foo=
+            SYMBOL_LITERAL = /\A:[a-zA-Z_]\w*[?!=]?\z/
+            # Matches valid quoted symbol literals: :"foo", :'foo' (quotes must match)
+            QUOTED_SYMBOL_LITERAL = /\A:("[^"]*"|'[^']*')\z/
+            # Matches string literals: "foo", 'foo' (quotes must match)
+            STRING_LITERAL = /\A("[^"]*"|'[^']*')\z/
+            # Matches numeric literals: 1, -1, 1.0, -2.5
+            NUMERIC_LITERAL = /\A-?\d+(\.\d+)?\z/
+
+            private_constant :SYMBOL_LITERAL, :QUOTED_SYMBOL_LITERAL, :STRING_LITERAL,
+                             :NUMERIC_LITERAL
+
             # Enable in-process execution
             in_process visibility: :public
 
@@ -25,6 +37,13 @@ module Yard
                 next unless tag.types
 
                 tag.types.each do |type_str|
+                  # Skip literal types that YARD accepts but TypesExplainer::Parser doesn't
+                  # See: https://github.com/mensfeld/yard-lint/issues/109
+                  next if type_str.match?(SYMBOL_LITERAL)
+                  next if type_str.match?(QUOTED_SYMBOL_LITERAL)
+                  next if type_str.match?(STRING_LITERAL)
+                  next if type_str.match?(NUMERIC_LITERAL)
+
                   begin
                     YARD::Tags::TypesExplainer::Parser.parse(type_str)
                   rescue SyntaxError => e

data/lib/yard/lint/validators/warnings/unknown_tag/parser.rb

@@ -6,7 +6,7 @@ module Yard
       module Warnings
         module UnknownTag
           # Parser used to extract warnings details that are related to yard unknown tags
-          # @example
+          # @example Output format (skip-lint)
           #   [warn]: Unknown tag @example1 in file `/builds/path/engine.rb` near line 32
           class Parser < ::Yard::Lint::Parsers::OneLineBase
             # Set of regexps for detecting warnings reported by YARD stats

data/lib/yard/lint/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-lint
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -46,12 +46,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coditsu/ci.yml"
-- ".ruby-version"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
 - bin/yard-lint
 - lib/yard-lint.rb
 - lib/yard/lint.rb
@@ -59,6 +56,7 @@ files:
 - lib/yard/lint/config_generator.rb
 - lib/yard/lint/config_loader.rb
 - lib/yard/lint/config_updater.rb
+- lib/yard/lint/config_validator.rb
 - lib/yard/lint/errors.rb
 - lib/yard/lint/executor/in_process_registry.rb
 - lib/yard/lint/executor/query_executor.rb
@@ -70,6 +68,7 @@ files:
 - lib/yard/lint/parsers/base.rb
 - lib/yard/lint/parsers/one_line_base.rb
 - lib/yard/lint/parsers/two_line_base.rb
+- lib/yard/lint/path_grouper.rb
 - lib/yard/lint/result_builder.rb
 - lib/yard/lint/results/aggregate.rb
 - lib/yard/lint/results/base.rb
@@ -77,6 +76,7 @@ files:
 - lib/yard/lint/stats_calculator.rb
 - lib/yard/lint/templates/default_config.yml
 - lib/yard/lint/templates/strict_config.yml
+- lib/yard/lint/todo_generator.rb
 - lib/yard/lint/validators/base.rb
 - lib/yard/lint/validators/config.rb
 - lib/yard/lint/validators/documentation/blank_line_before_definition.rb
@@ -97,6 +97,12 @@ files:
 - lib/yard/lint/validators/documentation/markdown_syntax/parser.rb
 - lib/yard/lint/validators/documentation/markdown_syntax/result.rb
 - lib/yard/lint/validators/documentation/markdown_syntax/validator.rb
+- lib/yard/lint/validators/documentation/missing_return.rb
+- lib/yard/lint/validators/documentation/missing_return/config.rb
+- lib/yard/lint/validators/documentation/missing_return/messages_builder.rb
+- lib/yard/lint/validators/documentation/missing_return/parser.rb
+- lib/yard/lint/validators/documentation/missing_return/result.rb
+- lib/yard/lint/validators/documentation/missing_return/validator.rb
 - lib/yard/lint/validators/documentation/undocumented_boolean_methods.rb
 - lib/yard/lint/validators/documentation/undocumented_boolean_methods/config.rb
 - lib/yard/lint/validators/documentation/undocumented_boolean_methods/parser.rb
@@ -137,6 +143,14 @@ files:
 - lib/yard/lint/validators/tags/collection_type/parser.rb
 - lib/yard/lint/validators/tags/collection_type/result.rb
 - lib/yard/lint/validators/tags/collection_type/validator.rb
+- lib/yard/lint/validators/tags/example_style.rb
+- lib/yard/lint/validators/tags/example_style/config.rb
+- lib/yard/lint/validators/tags/example_style/linter_detector.rb
+- lib/yard/lint/validators/tags/example_style/messages_builder.rb
+- lib/yard/lint/validators/tags/example_style/parser.rb
+- lib/yard/lint/validators/tags/example_style/result.rb
+- lib/yard/lint/validators/tags/example_style/rubocop_runner.rb
+- lib/yard/lint/validators/tags/example_style/validator.rb
 - lib/yard/lint/validators/tags/example_syntax.rb
 - lib/yard/lint/validators/tags/example_syntax/config.rb
 - lib/yard/lint/validators/tags/example_syntax/messages_builder.rb
@@ -242,8 +256,6 @@ files:
 - lib/yard/lint/validators/warnings/unknown_tag/result.rb
 - lib/yard/lint/validators/warnings/unknown_tag/validator.rb
 - lib/yard/lint/version.rb
-- misc/logo.png
-- renovate.json
 homepage: https://github.com/mensfeld/yard-lint
 licenses:
 - MIT
@@ -266,7 +278,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.0.dev
+rubygems_version: 4.0.6
 specification_version: 4
 summary: YARD documentation linter and validator
 test_files: []

data/.coditsu/ci.yml

@@ -1,3 +0,0 @@
-repository_id: '65b8c66c-02f1-44a2-a078-4af9a0ced5cd'
-api_key: <%= ENV['CODITSU_API_KEY'] %>
-api_secret: <%= ENV['CODITSU_API_SECRET'] %>

data/.ruby-version

@@ -1 +0,0 @@
-4.0

data/Rakefile

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'bundler/gem_tasks'
-require 'etc'
-
-namespace :spec do
-  # Determine optimal number of parallel processes
-  # Use all CPUs if less than 8, otherwise cap at 8
-  def parallel_process_count
-    cpus = Etc.nprocessors
-    [cpus, 8].min
-  end
-
-  desc 'Run integration specs in parallel'
-  task :integrations do
-    sh "bundle exec parallel_rspec -n #{parallel_process_count} spec/integrations/"
-  end
-
-  desc 'Run all specs in parallel'
-  task :parallel do
-    sh "bundle exec parallel_rspec -n #{parallel_process_count} spec/"
-  end
-end

data/renovate.json

@@ -1,15 +0,0 @@
-{
-  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-  "extends": [
-    "config:recommended"
-  ],
-  "minimumReleaseAge": "7 days",
-  "github-actions": {
-    "enabled": true,
-    "pinDigests": true
-  },
-  "includePaths": [
-    "Gemfile",
-    "yard-lint.gemspec"
-  ]
-}