rumdl 0.0.164__tar.gz → 0.0.165__tar.gz

{rumdl-0.0.164 → rumdl-0.0.165}/.mise.toml

@@ -21,6 +21,7 @@ uv = "latest"
 "cargo:maturin" = "latest"
 "cargo:cargo-binstall" = "latest"
 "cargo:cargo-zigbuild" = "latest"  # For building static Linux binaries
+"cargo:git-cliff" = "latest"        # Changelog generator from conventional commits
 
 # Zig for cross-compilation (used by maturin)
 zig = "0.13"

{rumdl-0.0.164 → rumdl-0.0.165}/.pre-commit-config.yaml

@@ -1,12 +1,22 @@
 # Pre-commit hooks for rumdl
 # Install with:
-#   pre-commit install                    # Install commit hooks
-#   pre-commit install --hook-type pre-push  # Install push hooks
+#   pre-commit install                          # Install commit hooks
+#   pre-commit install --hook-type commit-msg   # Install commit-msg hooks
+#   pre-commit install --hook-type pre-push     # Install push hooks
 # Run manually:
-#   pre-commit run --all-files           # Run commit hooks
-#   pre-commit run --hook-stage push --all-files  # Run push hooks
+#   pre-commit run --all-files                         # Run commit hooks
+#   pre-commit run --hook-stage push --all-files       # Run push hooks
+#   pre-commit run --hook-stage commit-msg --commit-msg-filename .git/COMMIT_EDITMSG
 
 repos:
+  # Conventional Commits validation
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v3.6.0
+    hooks:
+      - id: conventional-pre-commit
+        stages: [commit-msg]
+        args: []  # Optional: add --strict for stricter validation
+
   # Rust formatting and linting
   - repo: local
     hooks:

{rumdl-0.0.164 → rumdl-0.0.165}/CHANGELOG.md

@@ -7,6 +7,36 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.165] - 2025-10-21
+
+### Fixed
+
+- **MD040: Always preserve indentation when adding language tags** (fixes #122)
+  - The MD040 rule was incorrectly removing indentation from code blocks when adding language tags
+  - This broke list structure when code blocks were part of list items
+  - Root cause: The fix logic had conditional behavior that would remove indentation for "standalone" code blocks
+  - Now always preserves original indentation regardless of context
+  - Removed 50+ lines of unnecessary `is_in_nested_context()` helper logic
+  - Added comprehensive tests for various indentation scenarios (0, 2, 4, 6 spaces)
+
+### Added
+
+- **Conventional Commits validation hook**: Git commit-msg hook validates commit message format
+  - Enforces Conventional Commits specification for all commits
+  - Provides helpful error messages for invalid formats
+  - Ensures consistent commit history for changelog generation
+
+- **Automated changelog generation with git-cliff**:
+  - Added `make changelog-draft` for previewing CHANGELOG updates
+  - Semi-automated workflow: generate draft, enhance with details, commit
+  - Conventional Commits integration for automatic categorization
+
+### Changed
+
+- **Pre-push hook optimization**: Use dev profile instead of full suite for faster testing
+  - Prevents pre-push hook from hanging on slower machines
+  - Maintains adequate test coverage while improving developer experience
+
 ## [0.0.164] - 2025-10-21
 
 ### Added

rumdl-0.0.165/CONTRIBUTING.md

@@ -0,0 +1,350 @@
+# Contributing to rumdl
+
+Thank you for your interest in contributing to rumdl! This document provides guidelines and instructions for contributing.
+
+## Table of Contents
+
+- [Development Setup](#development-setup)
+- [Commit Message Convention](#commit-message-convention)
+- [Changelog Workflow](#changelog-workflow)
+- [Testing](#testing)
+- [Code Style](#code-style)
+- [Pull Request Process](#pull-request-process)
+
+## Development Setup
+
+### Prerequisites
+
+- [Rust](https://rustup.rs/) 1.89.0 or later
+- [mise](https://mise.jdx.dev/) for development tool management (recommended)
+
+### Quick Start
+
+1. **Clone the repository**:
+
+   ```bash
+   git clone https://github.com/rvben/rumdl.git
+   cd rumdl
+   ```
+
+2. **Install development tools** (using mise - recommended):
+
+   ```bash
+   make dev-setup
+   ```
+
+   Or manually:
+
+   ```bash
+   cargo install cargo-nextest cargo-watch maturin
+   ```
+
+3. **Install pre-commit hooks**:
+
+   ```bash
+   pre-commit install                        # Code quality hooks
+   pre-commit install --hook-type commit-msg # Conventional commits validation
+   pre-commit install --hook-type pre-push   # Comprehensive validation
+   ```
+
+4. **Verify installation**:
+
+   ```bash
+   make dev-verify
+   ```
+
+5. **Run tests**:
+
+   ```bash
+   make test-dev    # Recommended: ~20s, skips slowest tests
+   make test-quick  # Faster: ~15s, skips slow/stress tests
+   make test        # Full suite with dev profile
+   ```
+
+## Commit Message Convention
+
+rumdl uses [Conventional Commits](https://www.conventionalcommits.org/) for automated changelog generation and semantic versioning.
+
+### Format
+
+```text
+<type>(<scope>): <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+### Types
+
+| Type | Section | Description | Example |
+|------|---------|-------------|---------|
+| `feat` | **Added** | New features | `feat(cache): add file-level caching` |
+| `fix` | **Fixed** | Bug fixes | `fix(MD013): enforce line length in sentence mode` |
+| `perf` | **Performance** | Performance improvements | `perf(fix): enable parallel file processing` |
+| `refactor` | **Changed** | Code refactoring | `refactor(cache): simplify cache key generation` |
+| `docs` | **Changed** | Documentation only | `docs(readme): update installation steps` |
+| `chore` | *(skipped)* | Maintenance tasks | `chore(deps): update dependencies` |
+| `test` | *(skipped)* | Adding/updating tests | `test(cache): add cache invalidation tests` |
+| `ci` | *(skipped)* | CI configuration | `ci: update GitHub Actions workflow` |
+| `style` | *(skipped)* | Code formatting | `style: run cargo fmt` |
+
+### Examples
+
+**Good commit messages**:
+
+```bash
+feat(cache): implement Ruff-style parallel caching with Arc<Mutex<>>
+fix(pre-push): use dev profile for test-push to avoid hanging
+perf(fix): enable parallel file processing for fix mode (4.8x speedup)
+docs(changelog): update v0.0.163 with HTML comments fix
+```
+
+**Breaking changes**:
+
+```bash
+feat(api)!: change linting API to return Result
+
+BREAKING CHANGE: The linting API now returns Result<Vec<Warning>, Error>
+instead of Vec<Warning>. Update your code to handle the new error type.
+```
+
+### Scope
+
+The scope should be a noun describing the section of the codebase:
+
+- `cache` - Caching infrastructure
+- `fix` - Fix mode/auto-fix functionality
+- `cli` - Command-line interface
+- `lsp` - Language Server Protocol
+- `rules` - Linting rules (or specific rule like `MD013`)
+- `ci` - Continuous integration
+- `docs` - Documentation
+
+## Changelog Workflow
+
+rumdl uses [git-cliff](https://git-cliff.org/) to automatically generate changelog drafts from conventional commits.
+
+### Generating Changelog Drafts
+
+```bash
+# Preview unreleased changes
+make changelog-draft
+
+# View latest release changelog
+make changelog-latest
+
+# Generate full changelog
+make changelog-all
+
+# Show available changelog commands
+make changelog-help
+```
+
+### Updating CHANGELOG.md
+
+**The changelog generation is semi-automated:**
+
+1. **Generate draft** from conventional commits:
+
+   ```bash
+   make changelog-draft > /tmp/draft.md
+   ```
+
+2. **Review and enhance** the generated content:
+   - Add detailed explanations
+   - Include sub-bullets for complex changes
+   - Add performance metrics if applicable
+   - Provide migration guidance for breaking changes
+
+3. **Update CHANGELOG.md** manually with enhanced content
+
+4. **Commit** the updated changelog:
+
+   ```bash
+   git add CHANGELOG.md
+   git commit -m "chore(changelog): update for v0.0.165"
+   ```
+
+### Best Practices
+
+- ✅ **Do write detailed commit messages** - they become changelog entries
+- ✅ **Do use scopes** - helps organize changelog sections
+- ✅ **Do enhance generated content** - add context and details
+- ❌ **Don't rely solely on generated text** - manual refinement is expected
+- ❌ **Don't skip commits** - unconventional commits won't appear in changelog
+
+### Example Workflow
+
+```bash
+# Make changes
+git add src/cache.rs
+
+# Commit with conventional format
+git commit -m "feat(cache): add Blake3-based content hashing"
+
+# Later, when preparing release
+make changelog-draft
+
+# Copy relevant section to CHANGELOG.md
+# Enhance with details:
+#
+# - **File-Level Caching**: Blake3-based content hashing for fast lookups
+#   - Automatic cache invalidation on content/config changes
+#   - Cache stored in `.rumdl-cache/{version}/{hash}.json`
+#   - Enabled by default for instant subsequent runs
+```
+
+## Testing
+
+### Test Profiles
+
+rumdl uses [cargo-nextest](https://nexte.st/) with optimized test profiles:
+
+| Command | Duration | Use Case |
+|---------|----------|----------|
+| `make test-pre-commit` | ~6s | Pre-commit hook (lib tests only) |
+| `make test-quick` | ~15s | Quick feedback (skips slow tests) |
+| `make test-dev` | ~20s | Development default (skips slowest) |
+| `make test` | ~30s | Full suite with dev profile |
+| `make test-ci` | varies | CI environment |
+
+**⚠️ Never use `cargo test` directly** - it's 30-100x slower!
+
+### Writing Tests
+
+```rust
+#[test]
+fn test_cache_invalidation() {
+    // Test implementation
+}
+
+// For slow tests, use ignore + filter
+#[test]
+#[ignore = "slow"]
+fn test_large_file_processing() {
+    // Slow test implementation
+}
+```
+
+### Running Specific Tests
+
+```bash
+# Run specific test
+cargo nextest run test_cache_invalidation
+
+# Run all cache tests
+cargo nextest run cache
+
+# Run with specific profile
+cargo nextest run --profile quick
+```
+
+## Code Style
+
+### Formatting
+
+```bash
+# Format code and run clippy fixes
+make fmt
+
+# Check without modifying
+make lint
+```
+
+### Guidelines
+
+- **No dead code** - Remove unused code instead of `#[allow(dead_code)]`
+- **Tests test excellence** - Write tests for correct behavior, not current broken behavior
+- **Prefer explicit over implicit** - Clear code over clever code
+- **Use inline format args** - `format!("{foo}")` instead of `format!("{}", foo)`
+
+## Pull Request Process
+
+### Before Submitting
+
+1. **Run tests**:
+
+   ```bash
+   make test-dev
+   ```
+
+2. **Format code**:
+
+   ```bash
+   make fmt
+   ```
+
+3. **Lint code**:
+
+   ```bash
+   make lint
+   ```
+
+4. **Update changelog** (if applicable):
+   - Generate draft: `make changelog-draft`
+   - Enhance and add to CHANGELOG.md
+
+### PR Guidelines
+
+- ✅ Use conventional commit format for all commits
+- ✅ Include tests for new features
+- ✅ Update documentation if needed
+- ✅ Keep PRs focused - one feature/fix per PR
+- ✅ Reference issues: `Closes #123` or `Fixes #456`
+- ❌ Don't include unrelated changes
+- ❌ Don't commit `CLAUDE.md` or temporary files
+
+### PR Template
+
+```markdown
+## Description
+Brief description of changes
+
+## Type of Change
+- [ ] Bug fix (non-breaking change fixing an issue)
+- [ ] New feature (non-breaking change adding functionality)
+- [ ] Breaking change (fix or feature causing existing functionality to change)
+- [ ] Documentation update
+
+## Testing
+- [ ] Tests added/updated
+- [ ] All tests passing (`make test-dev`)
+- [ ] Manual testing performed
+
+## Checklist
+- [ ] Code follows project style (`make fmt` && `make lint`)
+- [ ] Conventional commit messages used
+- [ ] Documentation updated (if needed)
+- [ ] CHANGELOG.md updated (if user-facing)
+```
+
+## Release Process
+
+The release process is automated and documented in `CLAUDE.md`. Key points:
+
+1. **Update version** in `Cargo.toml`
+2. **Update CHANGELOG.md** with release notes
+3. **Commit and tag**: Make targets handle this automatically
+4. **Push tag**: Triggers CI/CD to build and publish
+
+```bash
+# Create patch release (0.0.164 → 0.0.165)
+make version-patch
+
+# Push to trigger release
+make version-push
+
+# Or combined
+make release-patch
+```
+
+## Questions?
+
+- 📖 [Documentation](https://github.com/rvben/rumdl)
+- 🐛 [Issue Tracker](https://github.com/rvben/rumdl/issues)
+- 💬 [Discussions](https://github.com/rvben/rumdl/discussions)
+
+## License
+
+By contributing to rumdl, you agree that your contributions will be licensed under the [MIT License](LICENSE).

{rumdl-0.0.164 → rumdl-0.0.165}/Cargo.lock

@@ -1983,7 +1983,7 @@ dependencies = [
 
 [[package]]
 name = "rumdl"
-version = "0.0.164"
+version = "0.0.165"
 dependencies = [
  "anyhow",
  "assert_cmd",

{rumdl-0.0.164 → rumdl-0.0.165}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rumdl"
-version = "0.0.164"
+version = "0.0.165"
 edition = "2024"
 rust-version = "1.89.0"
 description = "A fast Markdown linter written in Rust (Ru(st) MarkDown Linter)"

{rumdl-0.0.164 → rumdl-0.0.165}/Makefile

@@ -1,4 +1,4 @@
-.PHONY: build test clean fmt check doc version-major version-minor version-patch build-python build-wheel dev-install setup-mise dev-setup dev-verify update-dependencies update-rust-version pre-release build-static-linux-x64 build-static-linux-arm64 build-static-all schema check-schema
+.PHONY: build test clean fmt check doc version-major version-minor version-patch build-python build-wheel dev-install setup-mise dev-setup dev-verify update-dependencies update-rust-version pre-release build-static-linux-x64 build-static-linux-arm64 build-static-all schema check-schema changelog-draft changelog-latest changelog-all changelog-help
 
 # Development environment setup
 setup-mise:
@@ -95,8 +95,8 @@ test-pre-commit:
 	cargo nextest run --profile pre-commit
 
 test-push:
-	@echo "Running full test suite (this may take a few minutes)..."
-	cargo nextest run
+	@echo "Running comprehensive test suite (~30s, excludes slow/performance tests)..."
+	cargo nextest run --profile dev
 
 test-ci:
 	cargo nextest run --profile ci
@@ -187,6 +187,36 @@ update-changelog:
 		echo "Warning: CHANGELOG.md not found"; \
 	fi
 
+# Changelog generation with git-cliff (from conventional commits)
+changelog-draft:
+	@echo "Generating changelog draft for unreleased commits..."
+	@mise exec -- git-cliff --unreleased
+
+changelog-latest:
+	@echo "Generating changelog for latest release..."
+	@mise exec -- git-cliff --latest
+
+changelog-all:
+	@echo "Generating full changelog..."
+	@mise exec -- git-cliff
+
+changelog-help:
+	@echo "Changelog generation targets:"
+	@echo "  make changelog-draft   - Preview unreleased changes (does not modify files)"
+	@echo "  make changelog-latest  - Show latest release changelog"
+	@echo "  make changelog-all     - Show full changelog"
+	@echo ""
+	@echo "Note: These targets generate drafts from conventional commits."
+	@echo "      Review and enhance with details before committing to CHANGELOG.md"
+	@echo ""
+	@echo "Conventional commit format:"
+	@echo "  feat(scope): description       -> Added section"
+	@echo "  fix(scope): description        -> Fixed section"
+	@echo "  perf(scope): description       -> Performance section"
+	@echo "  refactor(scope): description   -> Changed section"
+	@echo ""
+	@echo "Configuration: cliff.toml"
+
 version-major:
 	@echo "Creating new major version tag..."
 	$(eval CURRENT := $(shell git describe --tags --abbrev=0 2>/dev/null || echo v0.0.0))

{rumdl-0.0.164 → rumdl-0.0.165}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rumdl
-Version: 0.0.164
+Version: 0.0.165
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers

rumdl-0.0.165/cliff.toml

@@ -0,0 +1,115 @@
+# git-cliff configuration for rumdl
+# Generates changelog in Keep a Changelog format from conventional commits
+# https://git-cliff.org/docs/configuration
+# https://keepachangelog.com/en/1.1.0/
+
+[changelog]
+# Template that matches Keep a Changelog format
+header = """
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+"""
+# Template for each release
+body = """
+{% if version %}\
+    {% if version | trim_start_matches(pat="v") == "Unreleased" %}\
+        ## [Unreleased]
+    {% else %}\
+        ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+    {% endif %}\
+{% else %}\
+    ## [Unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | striptags | trim }}
+    {% for commit in commits
+       | filter(attribute="scope")
+       | unique(attribute="message") -%}
+        - {% if commit.scope %}**{{ commit.scope }}**: {% endif %}\
+          {{ commit.message | upper_first | trim }}\
+          {% if commit.breaking %} **[BREAKING]**{% endif %}
+    {% endfor -%}
+    {% for commit in commits -%}
+        {% if not commit.scope -%}
+            - {{ commit.message | upper_first | trim }}\
+              {% if commit.breaking %} **[BREAKING]**{% endif %}
+        {% endif -%}
+    {% endfor -%}
+{% endfor %}
+"""
+# Remove leading and trailing whitespaces
+trim = true
+# Changelog footer (empty for Keep a Changelog)
+footer = ""
+
+[git]
+# Parse commits according to conventional commits specification
+conventional_commits = true
+# Filter out commits that don't follow conventional commits
+filter_unconventional = true
+# Don't split multi-line commits
+split_commits = false
+
+# Preprocessors to clean up commit messages
+commit_preprocessors = [
+    # Remove issue/PR references from commit messages (they're in git history)
+    { pattern = '\s*\(#\d+\)', replace = "" },
+]
+
+# Protect breaking commits from being filtered
+protect_breaking_commits = true
+
+# Commit parsers - map conventional commit types to Keep a Changelog sections
+commit_parsers = [
+    # Features -> Added section
+    { message = "^feat", group = "Added" },
+
+    # Bug fixes -> Fixed section
+    { message = "^fix", group = "Fixed" },
+
+    # Performance improvements -> Performance section
+    { message = "^perf", group = "Performance" },
+
+    # Refactoring and improvements -> Changed section
+    { message = "^refactor", group = "Changed" },
+    { message = "^improvement", group = "Changed" },
+
+    # Documentation updates -> Changed section (or skip if not user-facing)
+    { message = "^docs?", group = "Changed" },
+
+    # Breaking changes -> Breaking section (also marked in commit message)
+    { body = ".*BREAKING[- ]CHANGE.*", group = "Breaking" },
+
+    # Skip non-user-facing commits
+    { message = "^chore\\(release\\)", skip = true },
+    { message = "^chore\\(deps", skip = true },
+    { message = "^chore\\(pr\\)", skip = true },
+    { message = "^chore\\(changelog\\)", skip = true },
+    { message = "^ci", skip = true },
+    { message = "^test", skip = true },
+    { message = "^style", skip = true },
+    { message = "^build", skip = true },
+
+    # Other chores can go to Changed if they're user-visible
+    { message = "^chore", group = "Changed" },
+]
+
+# Filter out commits that don't match any parser
+filter_commits = false
+
+# Topological ordering for consistent history
+topo_order = false
+
+# Sort commits within each group (oldest first matches manual style)
+sort_commits = "oldest"
+
+# Tag pattern (semantic versioning)
+tag_pattern = "v[0-9].*"
+
+# Ignore tags that don't match semantic versioning
+skip_tags = ".*-rc.*|.*-alpha.*|.*-beta.*"