docs: Update README and examples

Author: YDX-2147483647

README.md

@@ -1,5 +1,41 @@
 # Typst rules based on [ast-grep](https://ast-grep.github.io)
 
+## Usage
+
+```shell
+$ just scan glossarium/0.5.8
+ast-grep scan …/preview/glossarium/0.5.8
+warning[show-function]:
+     ┌─ …/preview/glossarium/0.5.8/themes/default.typ:1361:5
+     │
+1361 │     show ref: refrule.with(update: false)
+     │     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+warning[show-function]:
+    ┌─ …/preview/glossarium/0.5.8/themes/default.typ:901:3
+    │
+901 │ ╭     show figure.where(kind: __glossarium_figure): it => {
+    │ │ ╭─────────────────────────────────────────────────'
+902 │ │ │     align(start, it.body)
+903 │ │ │   }
+    │ ╰─│───^
+    │   ╰───'
+
+note[context]:
+    ┌─ …/preview/glossarium/0.5.8\themes\default.typ:568:35
+    │
+568 │ #let style-entries(attr, style) = context _style-entries(attr, style)
+    │                                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+note[stateful]:
+   ┌─ …/preview/glossarium/0.5.8/themes/default.typ:18:27
+   │
+18 │ #let __glossary_entries = state("__glossary_entries", (:))
+   │                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+…
+```
+
 ## Development
 
 ### Online
@@ -33,7 +69,6 @@ Download `tree-sitter-typst.{so,dll}` and put it at the root directory of this p
 After that, you can use `ast-grep`. Please refer to [Quick Start | ast-grep](https://ast-grep.github.io/guide/quick-start.html) for more information.
 
 ```shell
-ast-grep test --skip-snapshot-tests
-ast-grep test --update-all
 ast-grep test
+# Or just add-test
 ```

justfile

@@ -4,15 +4,18 @@ typst_preview := replace(cache_directory(), '\', '/') + "/typst/packages/preview
 @list:
     just --list
 
-# Scan code by rules, e.g., `just scan headcount`, `just scan i-figured/0.2.4 --off=hard-coded-str`, `just scan tidy/0.3.0 --filter=eval`
+# Scan code by rules, e.g., `just scan headcount`, `just scan tidy/0.3.0 --filter=eval`, `just scan physica/0.9.5 --hint=hard-coded-str --filter=hard-coded-str`
 scan PREVIEW_PACKAGE_PATH *OPTIONS:
     ast-grep scan {{ OPTIONS }} {{ typst_preview }}/{{ PREVIEW_PACKAGE_PATH }}
 
 # Normal procedure after adding new tests; see also https://ast-grep.github.io/guide/test-rule.html
-add-test:
+add-test: && test
     ast-grep test --skip-snapshot-tests
     ast-grep test --interactive
-    ast-grep test
+
+[private]
+test:
+    ast-grep test --include-off
 
 # Check rule files match their IDs and tests
 check:

rules/hard-coded-str.yml

@@ -1,6 +1,6 @@
 id: hard-coded-str
 language: typst
-severity: hint # Low severity because too common
+severity: "off" # Low severity because too common
 rule:
   kind: string
   regex: >-