Skip to content

Conversation

@thomhurst
Copy link
Owner

This PR contains the following updates:

Package Type Update Change
docusaurus-plugin-llms devDependencies minor ^0.2.2^0.3.0

Release Notes

rachfop/docusaurus-plugin-llms (docusaurus-plugin-llms)

v0.3.0

Compare Source

Fixed
Critical Bug Fixes (GitHub Issues)
  • #​19 PluginOptions type compatibility with Docusaurus - Added index signature to resolve TypeScript errors (322f17a)
  • #​23 YAML encoding for special characters and emojis - Added proper YAML.stringify options (adce852)
  • #​25 includeOrder pattern matching - Now matches against both site-relative and docs-relative paths (14e21e5)
  • #​15 Numbered prefix handling - Uses Docusaurus resolved routes before manual prefix removal (b28c6c9)
Data Integrity & Validation
  • Strip UTF-8 BOM from markdown files to prevent parsing errors (1aa2f8a)
  • Validate and handle empty frontmatter fields (d16ff49)
  • Add type validation for frontmatter properties (54aa9a4)
  • Add error handling for URL constructor to prevent crashes (e00fbfc)
  • Add proper URL encoding for path segments (2629e6f)
  • Escape regex special characters in ignorePath to prevent syntax errors (c1039ed)
  • Prevent regex lastIndex state leakage in import detection (057f6ac)
Path & File Handling
  • Improve filename sanitization to preserve valid characters (ebb89d8)
  • Add path length validation and shortening for Windows compatibility (0a7e7f2)
  • Handle whitespace-only strings in path operations (696e30d)
  • Handle slugs with / as nested directory paths (ae371f1)
  • Correct baseUrl concatenation logic (84c9a39)
Safety & Robustness
  • Add bounds checking for array access to prevent undefined propagation (3cebd65, ff77b91)
  • Add iteration limit to prevent infinite loops in path collision detection (61a859b)
  • Add iteration limit to unique identifier generation (3248176)
  • Standardize null/undefined handling patterns (1e24c75)
  • Improve error type safety with unknown instead of any (d2894f3)
  • Standardize empty collection handling with consistent logging (40846c5)
Performance & Scalability
  • Add batch processing to prevent OOM on large sites (1000+ pages) (caa85a2)
Added
Features
  • Configurable logging system for better debugging and quieter output (79dab0d)
  • Comprehensive input validation utilities (112ad2c)
  • Ignored files warning feature for better user feedback (c6559c1)
Documentation
  • Add batch processing documentation to README (6df318b)
  • Improve JSDoc documentation for normalizePath function (0e1b0d8)
  • Add pattern matching documentation and examples (14e21e5)
  • Add numbered prefix handling documentation (b28c6c9)
Changed
Code Quality Improvements
  • Extract nested conditionals to helper functions (5e31591)
  • Extract magic numbers to named constants and improve truncation (9d95f4b)
Testing
  • Add integration test for plugin options validation (1db8a94, e690ffc)
  • Add comprehensive filename sanitization tests (16de4d9)
  • Add comprehensive Windows path normalization tests (4151051)
  • Add YAML encoding test suite (adce852)
  • Add pattern matching test suite with 8 scenarios (14e21e5)
  • Add numbered prefix test suite (b28c6c9)
  • Add URL encoding tests (2629e6f)
  • Add URL error handling tests (e00fbfc)
  • Add regex escaping tests (c1039ed)
  • Add regex lastIndex tests (057f6ac)
  • Add whitespace path tests (696e30d)
  • Add unique identifier iteration limit tests (3248176)
  • Add batch processing tests (caa85a2)
  • Add input validation tests (112ad2c)
  • Add BOM handling tests (1aa2f8a)
  • Add path length validation tests (0a7e7f2)
  • Add nested path tests (ae371f1)
  • Add baseURL handling tests (84c9a39)
  • Total: 300+ tests across 50 test files, all passing
Technical Details

This release focuses on stability, robustness, and addressing edge cases. Key improvements:

  • Windows Compatibility: Path length validation, proper path normalization
  • Large Site Support: Batch processing prevents OOM on sites with 1000+ pages
  • Type Safety: Improved TypeScript types, proper error handling
  • Input Validation: Comprehensive validation prevents crashes from invalid input
  • Pattern Matching: Flexible pattern matching supports multiple path formats
  • URL Handling: Robust URL construction with proper encoding and error handling
  • Frontmatter Parsing: Handles special characters, emojis, and edge cases
  • Code Quality: Reduced complexity, extracted helper functions, named constants
Breaking Changes

None. This release maintains backward compatibility with v0.2.x.

Migration Guide

No migration required. All changes are backward compatible.


Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Renovate Bot.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file MINOR renovate-bot

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants