docs: refresh README — accurate Status, drop m-tools refs, current perf#7
Open
rafael5 wants to merge 1 commit into
Open
docs: refresh README — accurate Status, drop m-tools refs, current perf#7rafael5 wants to merge 1 commit into
rafael5 wants to merge 1 commit into
Conversation
…ent perf numbers
The README's Status section was frozen at Step 2.1 (m fmt + 36-rule
xindex profile) while the project has shipped m fmt, m lint (35 M-MOD
+ 34 xindex + 8 vista, 7 profiles, path-sensitive flow analysis),
m test, m coverage, m watch, m lsp (Phase B), m doc, m doctor / new /
run / build / ci init, and the Track D 6a plugin system.
Changes:
- Header description and "Built on" rewritten to list every shipped
subcommand and reference m-test-engine as the default test engine
(vista-meta SSH path remains via M_CLI_ENGINE=ssh, but is no longer
the documented default).
- Status table replaced with a per-subcommand row reflecting actual
shipped state, including m plugins / m-cli-extras pointer.
- "../m-tools/docs/m-tooling-tier1.md" strategy-doc link removed
(m-tools is not in the m-dev-tools org).
- "VistA round-trip gate" example replaced with `make vista
CORPUS=...` showing the in-org m-modern-corpus default plus the
override pattern landed in Track B.
- "Naming convention" no longer references the deleted ../m-tools/bin/
shell prototypes.
- Layout block updated to match reality: pyproject.toml URL-pinned
(Track C2) instead of "tree-sitter-m as editable dep"; full module
layout (lint/, test/, coverage/, watch/, lsp/, doc/, plugins.py,
engine.py, workspace/) instead of the fmt-only stub.
- Roadmap rewritten — Tier 1 + Tier 2 are shipped; live status is in
TODO.md / the m-dev-tools sprint plan.
- "Step 2.1" labels removed from the Linter subsection ("Rules
shipped in Step 2.1" → "XINDEX-derived rules"; "VistA-corpus
baseline (Step 2.1)" → "VistA-corpus baseline").
- Linter performance note refreshed: was "1458 s, 12× over budget";
now reflects the NodeIndex single-pass + multiprocessing wins
(22.6 s on 16 cores, 5.3× under budget, 64.5× faster).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The README's Status section was frozen at Step 2.1 (m fmt + 36-rule xindex) while the project has long since shipped `m lint` (35 M-MOD + 34 xindex + 8 vista rules, 7 profiles, path-sensitive flow analysis), `m test`, `m coverage`, `m watch`, `m lsp` (through Phase B — go-to-def, find-refs, workspace symbol, code lens, signature help), `m doc`, the Phase 3a orientation helpers (`m doctor`, `m new`, `m run`, `m build`, `m ci init`), and the Track D 6a plugin system.
This PR is a documentation-only refresh:
No code changes.
Test plan
🤖 Generated with Claude Code