@sybelblue/prairielearn-navigator 1.1.2 → 1.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -0
- package/dist/cli.cjs +3 -3
- package/dist/core/config.d.ts +14 -0
- package/dist/core/diagnostic.d.ts +2 -0
- package/dist/core/rules/run.d.ts +2 -0
- package/dist/index.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -63,6 +63,12 @@ Put a `.pl-navigator.jsonc` (JSON with comments) next to `infoCourse.json`:
|
|
|
63
63
|
"schemaCacheDir": ".cache/pl-schemas",
|
|
64
64
|
// Turn rules off or change their severity: "off", "info", "warning", or "error"
|
|
65
65
|
"rules": { "duplicate-question-id": "error" },
|
|
66
|
+
// Exact occurrences suppressed by VS Code's "Ignore this violation" quick fix
|
|
67
|
+
"ignoredDiagnostics": [{
|
|
68
|
+
"file": "questions/draft/info.json",
|
|
69
|
+
"rule": "unused-question",
|
|
70
|
+
"identifier": "draft"
|
|
71
|
+
}],
|
|
66
72
|
// Questions no assessment uses: "ignored", "info" (default), "warning", or "error"
|
|
67
73
|
"unusedQuestions": "warning",
|
|
68
74
|
// Tags and assessment sets no question or assessment uses (default "warning")
|
|
@@ -75,6 +81,12 @@ Put a `.pl-navigator.jsonc` (JSON with comments) next to `infoCourse.json`:
|
|
|
75
81
|
}
|
|
76
82
|
```
|
|
77
83
|
|
|
84
|
+
An ignored diagnostic is matched by its course-relative file and rule. When a
|
|
85
|
+
rule has stable semantic context, the quick fix adds an `identifier`, such as a
|
|
86
|
+
question id, tag name, or assessment-set name. Other rules fall back to an
|
|
87
|
+
exact `message` and 1-based `occurrence` among matching diagnostics in that
|
|
88
|
+
file. Existing message/occurrence suppressions remain supported.
|
|
89
|
+
|
|
78
90
|
PrairieLearn has no numbered releases; it deploys continuously from its
|
|
79
91
|
`master` branch. So a version is one of:
|
|
80
92
|
|