rumdl 0.3.2__tar.gz → 0.3.4__tar.gz

rumdl-0.3.4/.config/nextest.toml

@@ -0,0 +1,148 @@
+# Nextest configuration
+# https://nexte.st/book/configuration
+
+[profile.default]
+# Detect flaky tests and retry them
+retries = { backoff = "exponential", count = 2, delay = "1s", max-delay = "10s" }
+
+# Run tests with 2x the number of CPUs
+test-threads = "num-cpus"
+
+# Fail fast on first failure in CI
+fail-fast = false
+
+# Show failed tests immediately
+failure-output = "immediate"
+
+# Show successful tests at the end
+success-output = "final"
+
+# Status output level
+status-level = "pass"
+
+[profile.ci]
+
+# Keep timing/resource-sensitive tests out of parallel CI, but do not mistake
+# in-memory configuration tests or small perf-fixture/Unicode checks for them.
+default-filter = '''
+    (not test(/^perf::/) and not test(/performance|benchmark|memory|linear_complexity|scaling/))
+    or test(/^config::(file_source::in_memory|tests::in_memory_chain)::/)
+    or test(/^perf::perf_fixtures::tests::test_(cache_path|raw_url)_generation$/)
+    or test(=perf::malformed_markdown_stress_tests::test_unicode_boundary_conditions)
+'''
+
+# More conservative in CI
+test-threads = "num-cpus"
+
+# Keep successful test output quiet, but name slow tests and report their
+# durations so a green summary with "N slow" is actionable.
+failure-output = "immediate"
+success-output = "never"
+status-level = "slow"
+final-status-level = "slow"
+
+# Kill a test that runs past three minutes instead of letting it hold the job
+# until the workflow timeout. Every CI test finishes well under one minute, so
+# a test still running at three is hung; terminating it fails the run with the
+# test named, where a hung subprocess otherwise reports only a cancelled job.
+slow-timeout = { period = "60s", terminate-after = 3 }
+
+# No retries in CI to catch flaky tests
+retries = 0
+
+# Fail fast on first failure to save CI time
+fail-fast = true
+
+# Keep this timing assertion in required CI, but measure it without competing
+# tests. Its small-input/large-input ratio is noisy under parallel execution.
+[[profile.ci.overrides]]
+filter = 'test(=lint_context::tests::test_definition_extents_are_read_in_linear_time)'
+threads-required = "num-test-threads"
+
+# Quick profile for development
+[profile.quick]
+
+# Skip slow tests and performance tests
+default-filter = 'not test(/memory/) and not test(/stress/) and not test(/large/) and not test(/error_propagation/) and not test(/performance/) and not test(/comprehensive/) and not test(/deeply_nested/)'
+
+# Even more parallel execution locally
+test-threads = "num-cpus"
+
+# Less verbose output
+status-level = "fail"
+
+# Development profile - balance between speed and coverage
+[profile.dev]
+
+# Skip the slowest tests but include integration tests
+# Perf module tests are excluded because timing-based assertions are inherently flaky
+# under parallel execution - they run in the performance profile
+default-filter = 'not test(/^perf::/) and not test(/error_propagation/) and not test(/deeply_nested/) and not test(/memory/) and not test(/stress/) and not test(/large/) and not test(/performance/) and not test(/linear_complexity/)'
+
+# Good parallelization for dev machines
+test-threads = "num-cpus"
+
+# Show failures immediately
+failure-output = "immediate"
+status-level = "fail"
+
+# No retries for faster feedback
+retries = 0
+
+# Ultra-fast profile for prek hooks
+[profile.prek]
+
+# Only run unit tests in lib, skip all integration tests and binaries
+default-filter = 'package(rumdl) and kind(lib) and not test(/slow|stress|large|integration|comprehensive|cli|config|advanced|commonmark|consistency|performance|benchmark|parity|error_propagation|deeply_nested|memory/)'
+
+# Maximum parallelism for speed
+test-threads = "num-cpus"
+
+# Minimal output for speed
+status-level = "fail"
+failure-output = "immediate"
+success-output = "never"
+
+# No retries to save time
+retries = 0
+
+# Fail fast on first failure
+fail-fast = true
+
+# Performance testing profile - for scheduled/manual runs
+[profile.performance]
+
+# Include the entire perf module plus timing/resource tests elsewhere. Without
+# these module/scaling selectors, several tests run in neither CI nor this job.
+# Explicitly ignored tests still require their documented manual invocation.
+default-filter = 'test(/^perf::/) or test(performance) or test(benchmark) or test(deeply_nested) or test(memory) or test(linear_complexity) or test(scaling)'
+
+# Run tests serially to reduce noise
+test-threads = 1
+
+# Show detailed output
+failure-output = "immediate"
+success-output = "immediate"
+status-level = "all"
+
+# Allow retries for flaky tests
+retries = { backoff = "exponential", count = 3, delay = "1s", max-delay = "10s" }
+
+# Don't fail fast - run all performance tests
+fail-fast = false
+
+# Smoke testing profile - lighter, stable test runs suitable for package managers
+[profile.smoke]
+# Run integration-style tests, excluding heavy/flaky ones
+# Note: exclusion patterns must not inadvertently match module names (e.g. "regression" would match "regressions::")
+default-filter = 'test(/^(cli|config|integration|formats|output|lsp|regressions|unicode)::/) and not test(/performance|benchmark|memory|linear_complexity|scaling|stress|large|comprehensive|deeply_nested|error_propagation|proptest|property_based|perf_/)'
+
+test-threads = "num-cpus"
+failure-output = "immediate"
+success-output = "final"
+status-level = "pass"
+retries = 0
+
+# Don't fail fast to see all failed results
+# Useful as Nix requires rebuilds for checkPhase failures, and these tests are light
+fail-fast = false

rumdl-0.3.4/.mise.toml

@@ -0,0 +1,53 @@
+# mise configuration for rumdl development environment
+# This file manages development tools and their versions
+
+[env]
+# Environment variables for the project
+RUST_BACKTRACE = "1"
+
+[tools]
+# Rust toolchain - version matches rust-toolchain.toml
+rust = "1.96.0"
+
+# Python for maturin/python bindings
+python = "3.12"
+
+# UV - Fast Python package and tool manager
+uv = "latest"
+
+# maturin - Python/Rust build backend. Installed as a prebuilt PyPI wheel via
+# the pipx backend (uv tool install) instead of a cargo: tool, which would
+# compile maturin from source on every CI build job (~5-7 minutes each).
+"pipx:maturin" = "latest"
+
+# Zensical builds the documentation site. Pinned because its output is what the
+# docs checks read: a new release can change the generated HTML, and the site
+# checks then fail on main with no change in this repository. The pre-push docs
+# hook runs it through `mise exec`, and the Documentation workflow installs it
+# and puts it on PATH.
+"pipx:zensical" = "0.0.74"
+
+"github:jdx/jactionlint" = "2.1.0"
+
+# Development tools installed via cargo
+"cargo:cargo-nextest" = "latest"
+"cargo:cargo-codspeed" = "5.0.2"  # Keep in step with codspeed-criterion-compat in Cargo.toml
+"cargo:cargo-binstall" = "latest"
+"cargo:cargo-zigbuild" = "latest"  # For building static Linux binaries
+
+# Zig for cross-compilation (used by maturin)
+zig = "0.13"
+
+# Link checker for markdown files (`make check-links`)
+"cargo:lychee" = "latest"
+
+[settings]
+# Experimental features
+experimental = true
+
+# Enable idiomatic version files (like rust-toolchain.toml)
+idiomatic_version_file_enable_tools = ["rust"]
+
+[settings.cargo]
+# Use cargo-binstall when available for faster installations
+binstall = true

rumdl-0.3.4/.pre-commit-config.yaml

@@ -0,0 +1,189 @@
+# Pre-commit hooks for rumdl (using prek - https://prek.j178.dev)
+# Install with:
+#   prek install                          # Installs all hook stages
+# Run manually:
+#   prek run --all-files                         # Run commit hooks
+#   prek run --hook-stage pre-push --all-files   # Run push hooks
+
+fail_fast: true
+
+repos:
+  # Secret detection
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: v8.30.0
+    hooks:
+      - id: gitleaks
+
+  # Shell script linting
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.10.0.1
+    hooks:
+      - id: shellcheck
+
+  # 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
+
+  # Rule names in a commit scope reach CHANGELOG.md verbatim, so they must be
+  # uppercase: fix(MD077), not fix(md077). Non-rule scopes stay lowercase.
+  - repo: local
+    hooks:
+      - id: commit-scope-case
+        name: uppercase rule names in commit scope
+        entry: scripts/check-commit-scope.sh
+        language: script
+        stages: [commit-msg]
+        always_run: true
+
+  # Rust formatting and linting
+  - repo: local
+    hooks:
+      - id: cargo-fmt
+        name: cargo fmt
+        entry: mise exec -- cargo fmt --all --
+        language: system
+        types: [rust]
+        pass_filenames: false
+
+      - id: cargo-lock-check
+        name: check Cargo.lock is up-to-date
+        entry: mise exec -- sh -c 'cargo metadata --locked --format-version 1 --no-deps >/dev/null'
+        language: system
+        files: ^Cargo\.(toml|lock)$
+        pass_filenames: false
+        stages: [pre-commit]
+
+  - repo: https://github.com/jdx/jactionlint
+    rev: v2.1.0
+    hooks:
+      - id: jactionlint-system
+        entry: bash scripts/lint-actions.sh
+        pass_filenames: false
+        files: ^(\.github/.*\.(yml|yaml|json)|action\.ya?ml|scripts/lint-actions\.sh)$
+
+  # General file quality checks (prek built-in Rust implementations)
+  - repo: builtin
+    hooks:
+      - id: trailing-whitespace
+        exclude: \.md$|tests/inline_config_test\.rs$|tests/output_format_integration_tests\.rs$|tests/lsp_editor_integration_tests\.rs$|tests/utils_markdown_edge_cases\.rs$
+      - id: end-of-file-fixer
+        exclude: \.md$|rumdl\.schema\.json$
+      - id: check-yaml
+      - id: check-toml
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-case-conflict
+      - id: mixed-line-ending
+        args: [--fix=lf]
+
+  # YAML linting
+  - repo: https://github.com/owenlamont/ryl-pre-commit
+    rev: v0.4.0
+    hooks:
+      - id: ryl
+
+  # Markdown linting using rumdl itself (cargo run)
+  - repo: local
+    hooks:
+      - id: rumdl
+        name: rumdl check
+        entry: mise exec -- cargo run --quiet -- check
+        language: system
+        files: \.md$
+        exclude: ^(test_tmp|benchmark/test-data|docs/temp|__tests__|CHANGELOG\.md|tests/regressions/idempotency)
+        pass_filenames: true
+        require_serial: true
+
+  # Link checking
+  - repo: local
+    hooks:
+      - id: check-links
+        name: check links
+        entry: make check-links
+        language: system
+        files: \.md$
+        pass_filenames: false
+        stages: [pre-push]
+
+  # Pre-push hooks for comprehensive validation
+  - repo: local
+    hooks:
+      - id: cargo-test-full
+        name: cargo test (full suite)
+        entry: mise exec -- make test-push
+        language: system
+        types: [rust]
+        pass_filenames: false
+        stages: [pre-push]
+
+      - id: cargo-lint-full
+        name: cargo clippy (all targets)
+        entry: mise exec -- make lint
+        language: system
+        types: [rust]
+        pass_filenames: false
+        stages: [pre-push]
+
+      - id: cargo-doc-check
+        name: cargo doc (check)
+        entry: mise exec -- make doc-check
+        language: system
+        types: [rust]
+        pass_filenames: false
+        stages: [pre-push]
+
+      - id: cargo-lock-check-push
+        name: verify Cargo.lock is committed and up-to-date
+        entry: mise exec -- sh -c 'cargo metadata --locked --format-version 1 --no-deps >/dev/null'
+        language: system
+        files: ^Cargo\.(toml|lock)$
+        pass_filenames: false
+        stages: [pre-push]
+
+      - id: complexity-check
+        name: check for O(n²) regressions
+        entry: mise exec -- make test-complexity
+        language: system
+        types: [rust]
+        pass_filenames: false
+        stages: [pre-push]
+
+      - id: schema-check
+        name: check JSON schema is up-to-date
+        entry: mise exec -- make check-schema
+        language: system
+        types: [rust]
+        pass_filenames: false
+        stages: [pre-push]
+
+      - id: rule-docs-check
+        name: check rule-count docs in sync with registry
+        entry: mise exec -- make check-rule-docs
+        language: system
+        files: \.(rs|md)$
+        pass_filenames: false
+        stages: [pre-push]
+
+      - id: code-block-tools-check
+        name: check built-in tools docs in sync with registry
+        entry: mise exec -- make check-code-block-tools
+        language: system
+        files: \.(rs|md)$
+        pass_filenames: false
+        stages: [pre-push]
+
+      # The Documentation workflow's build and checks, so a docs failure is
+      # caught before it reaches main. Runs when documentation sources change,
+      # and when .mise.toml does, since it pins the Zensical that builds the
+      # site; changes to src/ and other build inputs stay covered by CI.
+      - id: docs-site-check
+        name: build and check the documentation site
+        entry: mise exec -- make docs-site
+        language: system
+        files: ^(docs/|overrides/|functions/|web/playground/|zensical\.toml$|\.mise\.toml$|wrangler\.toml$|assets/benchmark\.svg$|scripts/(docs_|complete_docs_sitemap|sanitize_docs_site|benchmark_docs_test|generate_benchmark_chart))
+        pass_filenames: false
+        stages: [pre-push]