Skip to content

Commit d0e4066

Browse files
committed
add TODO
1 parent 5a64d40 commit d0e4066

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

TODO.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,27 @@
77
an identifier capture. This inference may be too broad. Consider requiring
88
an explicit kind for cross-position reuse, improving the diagnostic, or
99
adding a storage-path metavariable kind.
10+
11+
- Correct the commands in the embedded rule-writing guides. They currently
12+
recommend `moon run . -- scan ...`, which only runs moongrep when invoked
13+
from the moongrep module. Document the installed `moongrep scan ...` and
14+
Mooncakes/Wasm `moonx moonbit-community/moongrep -- scan ...` forms, and
15+
keep `moon run .` in a contributor-only section if it is still needed.
16+
17+
- Define and document the contract for `#moongrep.skip`. It is currently
18+
recognized on functions, impls, top-level lets, tests, and views; ignores
19+
any payload, including `false`; and suppresses structural rules but not
20+
taint analysis. If it remains public, cover those semantics in the user and
21+
e2e documentation. Otherwise, make it internal or remove it.
22+
23+
- Clarify constant matching in the RuleSpec overview. Constants are compared
24+
using the parser AST constant kind and preserved source spelling, so
25+
equivalent values such as `1000` and `1_000` do not necessarily match.
26+
Update the English and Chinese summaries so they do not imply that all
27+
formatting is ignored.
28+
29+
- Make the Chinese rule documentation available through the `docs` command,
30+
or document that only English documents are embedded. `docs/export.mbt`
31+
currently registers only `RuleSpec` and `WritingRules`; consider adding
32+
`RuleSpec_CN` and `WritingRules_CN`, or linking to accessible Chinese
33+
documents from `SKILL_CN.md`.

0 commit comments

Comments
 (0)