Skip to content

Linting + Rules Improvements#9

Merged
ryansann merged 1 commit into
mainfrom
prefixed-rules
Jun 26, 2026
Merged

Linting + Rules Improvements#9
ryansann merged 1 commit into
mainfrom
prefixed-rules

Conversation

@ryansann

@ryansann ryansann commented Jun 26, 2026

Copy link
Copy Markdown
Owner

Summary

This prepares okftool for v0.2.0 with a richer diagnostics/rule model for downstream consumers like okfview.

Key changes:

  • Adds canonical namespaced rule IDs, e.g. frontmatter/require-description, topology/no-orphan-concepts
  • Keeps old flat rule IDs working as aliases in config, overrides, inline disables, and okftool explain
  • Expands rule metadata with category, category name, aliases, rationale, help text, docs path, default severity, and fixability
  • Enriches diagnostics with rule/category metadata so UIs can group and explain findings more effectively
  • Exposes rule descriptors through the wasm API
  • Updates CLI rules, explain, and SARIF output to use the richer rule metadata
  • Updates presets, docs, fixtures, and tests to use canonical rule IDs
  • Bumps workspace/crates to 0.2.0

Testing

  • cargo fmt --all --check
  • cargo test
  • cargo package -p okftool-core --allow-dirty
  • cargo publish -p okftool-core --dry-run --allow-dirty
  • npm package dry-run/build checks for the wasm package

@ryansann
ryansann marked this pull request as ready for review June 26, 2026 00:07
@ryansann ryansann changed the title More Robust Linting + Rules Improvements Jun 26, 2026
@ryansann
ryansann merged commit 2a1ff5d into main Jun 26, 2026
2 checks passed
@ryansann
ryansann deleted the prefixed-rules branch June 26, 2026 00:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant