yard-lint 0.2.0 → 1.0.0

data/lib/yard/lint/validators/warnings/invalid_directive_format/validator.rb

@@ -11,15 +11,14 @@ module Yard
 
             # Runs YARD stats command with proper settings on a given dir and files
             # @param dir [String] dir where we should generate the temp docs
-            # @param escaped_file_names [String] files for which we want to run YARD stats
+            # @param file_list_path [String] path to temp file containing file paths (one per line)
             # @return [Hash] shell command execution hash results
-            def yard_cmd(dir, escaped_file_names)
+            def yard_cmd(dir, file_list_path)
               cmd = <<~CMD
-                yard stats \
+                cat #{Shellwords.escape(file_list_path)} | xargs yard stats \
                   #{shell_arguments} \
                 --compact \
-                -b #{Shellwords.escape(dir)} \
-                  #{escaped_file_names}
+                -b #{Shellwords.escape(dir)}
               CMD
               cmd = cmd.tr("\n", ' ')
 

data/lib/yard/lint/validators/warnings/invalid_tag_format/validator.rb

@@ -11,15 +11,14 @@ module Yard
 
             # Runs YARD stats command with proper settings on a given dir and files
             # @param dir [String] dir where we should generate the temp docs
-            # @param escaped_file_names [String] files for which we want to run YARD stats
+            # @param file_list_path [String] path to temp file containing file paths (one per line)
             # @return [Hash] shell command execution hash results
-            def yard_cmd(dir, escaped_file_names)
+            def yard_cmd(dir, file_list_path)
               cmd = <<~CMD
-                yard stats \
+                cat #{Shellwords.escape(file_list_path)} | xargs yard stats \
                   #{shell_arguments} \
                 --compact \
-                -b #{Shellwords.escape(dir)} \
-                  #{escaped_file_names}
+                -b #{Shellwords.escape(dir)}
               CMD
               cmd = cmd.tr("\n", ' ')
 

data/lib/yard/lint/validators/warnings/unknown_directive/validator.rb

@@ -11,15 +11,14 @@ module Yard
 
             # Runs YARD stats command with proper settings on a given dir and files
             # @param dir [String] dir where we should generate the temp docs
-            # @param escaped_file_names [String] files for which we want to run YARD stats
+            # @param file_list_path [String] path to temp file containing file paths (one per line)
             # @return [Hash] shell command execution hash results
-            def yard_cmd(dir, escaped_file_names)
+            def yard_cmd(dir, file_list_path)
               cmd = <<~CMD
-                yard stats \
+                cat #{Shellwords.escape(file_list_path)} | xargs yard stats \
                   #{shell_arguments} \
                 --compact \
-                -b #{Shellwords.escape(dir)} \
-                  #{escaped_file_names}
+                -b #{Shellwords.escape(dir)}
               CMD
               cmd = cmd.tr("\n", ' ')
 

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

@@ -8,10 +8,13 @@ module Yard
           # Parser for UnknownParameterName warnings
           class Parser < ::Yard::Lint::Parsers::TwoLineBase
             # Set of regexps for detecting warnings reported by YARD stats
+            # YARD output format:
+            #   [warn]: @param tag has unknown parameter name: ...
+            #       in file `filename.rb' near line 8
             self.regexps = {
               general: /^\[warn\]: @param tag has unknown parameter name/,
               message: /\[warn\]: (.*)$/,
-              location: /in file `(.*?)'\?\s*near/,
+              location: /in file `(.*?)'\s*near/,
               line: /near line (\d+)/
             }.freeze
           end

data/lib/yard/lint/validators/warnings/unknown_parameter_name/validator.rb

@@ -11,15 +11,14 @@ module Yard
 
             # Runs YARD stats command with proper settings on a given dir and files
             # @param dir [String] dir where we should generate the temp docs
-            # @param escaped_file_names [String] files for which we want to run YARD stats
+            # @param file_list_path [String] path to temp file containing file paths (one per line)
             # @return [Hash] shell command execution hash results
-            def yard_cmd(dir, escaped_file_names)
+            def yard_cmd(dir, file_list_path)
               cmd = <<~CMD
-                yard stats \
+                cat #{Shellwords.escape(file_list_path)} | xargs yard stats \
                   #{shell_arguments} \
                 --compact \
-                -b #{Shellwords.escape(dir)} \
-                  #{escaped_file_names}
+                -b #{Shellwords.escape(dir)}
               CMD
               cmd = cmd.tr("\n", ' ')
 

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

@@ -11,15 +11,14 @@ module Yard
 
             # Runs YARD stats command with proper settings on a given dir and files
             # @param dir [String] dir where we should generate the temp docs
-            # @param escaped_file_names [String] files for which we want to run YARD stats
+            # @param file_list_path [String] path to temp file containing file paths (one per line)
             # @return [Hash] shell command execution hash results
-            def yard_cmd(dir, escaped_file_names)
+            def yard_cmd(dir, file_list_path)
               cmd = <<~CMD
-                yard stats \
+                cat #{Shellwords.escape(file_list_path)} | xargs yard stats \
                   #{shell_arguments} \
                 --compact \
-                -b #{Shellwords.escape(dir)} \
-                  #{escaped_file_names}
+                -b #{Shellwords.escape(dir)}
               CMD
               cmd = cmd.tr("\n", ' ')
 

data/lib/yard/lint/version.rb

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

data/lib/yard/lint.rb

@@ -3,6 +3,7 @@
 require 'yaml'
 require 'shellwords'
 require 'open3'
+require 'tempfile'
 require 'tmpdir'
 require 'digest'
 require 'net/http'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-lint
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -52,6 +52,7 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- Rakefile
 - bin/console
 - bin/setup
 - bin/yard-lint
@@ -100,12 +101,24 @@ files:
 - lib/yard/lint/validators/tags/api_tags/parser.rb
 - lib/yard/lint/validators/tags/api_tags/result.rb
 - lib/yard/lint/validators/tags/api_tags/validator.rb
+- lib/yard/lint/validators/tags/collection_type.rb
+- lib/yard/lint/validators/tags/collection_type/config.rb
+- lib/yard/lint/validators/tags/collection_type/messages_builder.rb
+- 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/invalid_types.rb
 - lib/yard/lint/validators/tags/invalid_types/config.rb
 - lib/yard/lint/validators/tags/invalid_types/messages_builder.rb
 - lib/yard/lint/validators/tags/invalid_types/parser.rb
 - lib/yard/lint/validators/tags/invalid_types/result.rb
 - lib/yard/lint/validators/tags/invalid_types/validator.rb
+- lib/yard/lint/validators/tags/meaningless_tag.rb
+- lib/yard/lint/validators/tags/meaningless_tag/config.rb
+- lib/yard/lint/validators/tags/meaningless_tag/messages_builder.rb
+- lib/yard/lint/validators/tags/meaningless_tag/parser.rb
+- lib/yard/lint/validators/tags/meaningless_tag/result.rb
+- lib/yard/lint/validators/tags/meaningless_tag/validator.rb
 - lib/yard/lint/validators/tags/option_tags.rb
 - lib/yard/lint/validators/tags/option_tags/config.rb
 - lib/yard/lint/validators/tags/option_tags/messages_builder.rb
@@ -118,6 +131,18 @@ files:
 - lib/yard/lint/validators/tags/order/parser.rb
 - lib/yard/lint/validators/tags/order/result.rb
 - lib/yard/lint/validators/tags/order/validator.rb
+- lib/yard/lint/validators/tags/tag_type_position.rb
+- lib/yard/lint/validators/tags/tag_type_position/config.rb
+- lib/yard/lint/validators/tags/tag_type_position/messages_builder.rb
+- lib/yard/lint/validators/tags/tag_type_position/parser.rb
+- lib/yard/lint/validators/tags/tag_type_position/result.rb
+- lib/yard/lint/validators/tags/tag_type_position/validator.rb
+- lib/yard/lint/validators/tags/type_syntax.rb
+- lib/yard/lint/validators/tags/type_syntax/config.rb
+- lib/yard/lint/validators/tags/type_syntax/messages_builder.rb
+- lib/yard/lint/validators/tags/type_syntax/parser.rb
+- lib/yard/lint/validators/tags/type_syntax/result.rb
+- lib/yard/lint/validators/tags/type_syntax/validator.rb
 - lib/yard/lint/validators/warnings/duplicated_parameter_name.rb
 - lib/yard/lint/validators/warnings/duplicated_parameter_name/config.rb
 - lib/yard/lint/validators/warnings/duplicated_parameter_name/parser.rb
@@ -149,6 +174,7 @@ 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: