yard-lint 1.4.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 776d4e0a37ddbafe6b61e0df58c8a663432a04397c0d6cd9b36527484cde5675
-  data.tar.gz: afe2b858507d15d1b264cd8ac1a15dd0285eac638ea227643f23fb41977e6521
+  metadata.gz: 88a6ef4d1499a08d7c1776c73605011fd32af9c7afc3f473e4e2c000b2f1d4b6
+  data.tar.gz: a4002c074922df07b82d963f8844745bdd925087b1f6f4b2ba87af10dab1e523
 SHA512:
-  metadata.gz: d2076e759985b33a992394ebba9fc769aa70b3a16fc7914db8e4fb16bb3aac2d1d8bb5b9e6532d65bb545767321d59e1cf2c1ece89588bef12898cf2238dd05d
-  data.tar.gz: '08c2a18358bc5ee1fef76cd5f5d627c9859b99e1ebd7789b29babc1d1317c295e8d688583e7a456d744ff87677e9ac2f3abb925a1f8f176e1bff96a0622c00a9'
+  metadata.gz: 4c7cd92f75e9b839a90340241288966f157c50ba2d82bea1a50892f70b6d62493e81d2f60c4a147616adeada79f65e9ed3ad00fddc6353a9229ec705073ae1c2
+  data.tar.gz: ce364d5460ee86d59e058a78e3d7c72f6d76f32b96279436dd71f9f50b0ff4fb7e16e2bc60a06542642a337707df0df6e8d1e798b0c5282d7f350a3f39a38680

data/CHANGELOG.md

@@ -1,5 +1,62 @@
 # YARD-Lint Changelog
 
+## 1.5.1 (2026-04-09)
+- **[Fix]** Remove `mise.toml` and `proxy_types` from the repository and exclude non-production files (`.ruby-version`, `Rakefile`, `misc/`, `renovate.json`, `package.json`, `package-lock.json`, lock files) from RubyGems releases
+
+## 1.5.0 (2026-04-02)
+- **[Fix]** Skip `@!attribute` methods in `UndocumentedMethodArguments` validator (#115)
+  - Methods documented with `@!attribute` directive are attribute accessors whose setter parameter does not need explicit `@param` documentation, matching `attr_accessor` behavior
+- **[Fix]** Extend `CollectionType` validator to enforce style for Array types, not just Hash (#114)
+  - YARD supports both long (`Array<String>`, `Array(String, Integer)`) and short (`<String>`, `(String, Integer)`) forms for Array collections
+  - The validator now detects and enforces the configured `EnforcedStyle` for Array angle bracket and tuple notation
+  - Correction suggestions in messages now cover Array types (e.g., `<String>` → `Array<String>` or vice versa)
+- **[Fix]** Accept tuple (fixed-length array) types as valid YARD syntax in `InvalidTypes` validator (#113)
+  - YARD supports tuple notation like `(String, Integer)` for fixed-length arrays with typed positions
+  - The `InvalidTypes` validator's sanitize logic did not strip parentheses, causing tuple types to be incorrectly flagged as `InvalidTagType`
+- **[Fix]** Accept symbol, string, and numeric literals as valid YARD types in `TypeSyntax` validator (#109)
+  - YARD accepts literal types like `:error`, `"read"`, `'write'`, `-1`, `2.5` in tags, but its `TypesExplainer::Parser` does not support them
+  - The `TypeSyntax` validator was using that parser, causing false positives for valid literal types
+  - Now skips literal types before passing them to the parser, using strict regexes that only match valid Ruby syntax
+  - Supports: simple symbols (`:foo`), predicate/bang/setter symbols (`:foo?`, `:save!`, `:name=`), quoted symbols (`:"content-type"`, `:'x-request-id'`), double and single-quoted strings (`"read"`, `'write'`), integers (`-1`, `0`, `1`), and floats (`1.0`, `-2.5`)
+- **[Feature]** Add configuration validation to catch typos and invalid settings
+  - Validates validator names exist before processing files (prevents silent failures)
+  - Detects typos in severity levels (e.g., `erro` instead of `error`) with "did you mean" suggestions
+  - Validates boolean values for `Enabled` settings
+  - Validates global settings in `AllValidators` section (FailOnSeverity, MinCoverage, etc.)
+  - Provides helpful error messages pointing to valid options
+  - Fails fast with clear error messages instead of silently ignoring invalid configuration
+  - Catches common mistakes like using non-existent validator names (e.g., `UndocumentedMethod` instead of `Documentation/UndocumentedObjects`)
+- **[Feature]** Add `Tags/ExampleStyle` validator for linting code examples with RuboCop/StandardRB (#74)
+  - Validates code style in `@example` tags using RuboCop or StandardRB
+  - Auto-detects RuboCop or StandardRB from project setup (checks for `.rubocop.yml`, `.standard.yml`, Gemfile, or Gemfile.lock)
+  - Respects project's `.rubocop.yml` or `.standard.yml` configuration
+  - Supports skip patterns for intentional "bad code" examples (e.g., `@example Bad code (skip-lint)`)
+  - Opt-in validator (disabled by default, requires RuboCop or StandardRB gem)
+  - Convention severity by default for style issues
+  - Automatically disables file-level cops irrelevant to code snippets (e.g., `Style/FrozenStringLiteralComment`, metrics cops)
+  - Gracefully degrades when no linter is available (no crashes, debug warning only)
+  - Ensures code examples follow the same style guidelines as your codebase for consistency
+  - Configurable linter selection (`Linter: auto`, `rubocop`, `standard`, or `none`)
+  - Supports inline RuboCop directives (e.g., `# rubocop:disable Style/StringLiterals`)
+- **[Feature]** Add `--auto-gen-config` for incremental adoption on legacy codebases (#71)
+  - Generates `.yard-lint-todo.yml` with per-validator exclusions for all current violations
+  - Allows teams to adopt yard-lint without fixing all existing violations first
+  - New CLI flags:
+    - `--auto-gen-config`: Generate baseline configuration silencing existing violations
+    - `--regenerate-todo`: Regenerate todo file (overwrites existing)
+    - `--exclude-limit N`: Min files in directory before grouping into pattern (default: 15)
+  - Intelligent path grouping: converts many individual files into patterns (e.g., `lib/legacy/**/*`)
+  - Automatically updates `.yard-lint.yml` to inherit from `.yard-lint-todo.yml`
+  - Incremental workflow: remove exclusions from todo file to re-expose violations for fixing
+  - Use case: Enforce strict standards on new code while incrementally fixing legacy issues
+  - Use case: Generate baseline before CI/CD integration to prevent breaking existing builds
+  - Inspired by RuboCop's `--auto-gen-config` feature
+  - See README "Adopting YARD-Lint on Existing Projects" section for detailed usage
+- **[Feature]** Add optional check for missing `@return` tags (#70, #72, @mensfeld)
+  - Enforces `@return` tag presence for all method definitions
+  - Excludes `initialize` methods by default (they typically don't need return documentation)
+  - Opt-in validator to help catch forgotten return value documentation
+
 ## 1.4.0 (2026-01-19)
 - **[Fix]** Handle directive definitions depending on file load order (#65, @zaben903)
 - **[CI]** Update Ruby 4.0 from preview2 to stable release as the default version
@@ -56,7 +113,7 @@
   - Now matches patterns against both relative and absolute paths (similar to RuboCop's `PathUtil#match_path?`)
   - Extracted `discover_ruby_files` method for better separation of concerns
   - Added `determine_base_dir`, `excluded_file?`, `relative_path_from`, and `match_path?` helper methods
-  - Comprehensive integration tests in `spec/integrations/global_exclusions_spec.rb`
+  - Comprehensive integration tests in `test/integrations/global_exclusions_test.rb`
 - **[Enhancement]** Make PATH argument optional, defaulting to current directory (like RuboCop)
   - Running `yard-lint` without arguments now lints the current directory
   - Maintains backward compatibility with explicit path arguments
@@ -183,9 +240,9 @@
   - 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
+  - Added `test_config` helper in test_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
+  - Prevents test fixtures in `test/fixtures/` from being filtered out by `test/**/*` exclusion pattern
   - Ensures integration tests can properly validate linter behavior on fixture files
 - **[Fix]** Remove not needed `bin/` files.