@sybelblue/prairielearn-navigator 1.1.0 → 1.1.2

package/README.md

@@ -20,6 +20,10 @@ npx -y @sybelblue/prairielearn-navigator check [options] [paths...]
 | `--pl-version <version>` | PrairieLearn version to check against (overrides the config) |
 | `--schema-cache <dir>` | Where downloaded schemas are cached (overrides the config) |
 | `--exclude <glob>` | Skip matching files, relative to the current directory. Repeatable; adds to the config's `excludes`. |
+| `--unused-questions <level>` | Severity for questions no assessment uses: `ignored`, `info` (default), `warning`, or `error` (overrides the config) |
+| `--unused-tags <level>` | Severity for `infoCourse.json` tags no question uses: `ignored`, `info`, `warning` (default), or `error` (overrides the config) |
+| `--unused-assessment-sets <level>` | Severity for `infoCourse.json` assessment sets no assessment uses: `ignored`, `info`, `warning` (default), or `error` (overrides the config) |
+| `--missing-question-info <level>` | Severity for directories in `questions/` with files but no `info.json`: `ignored`, `info`, `warning`, or `error` (default) (overrides the config) |
 
 ## Rules
 
@@ -30,6 +34,10 @@ Each diagnostic ends with its rule id, e.g. `[schema]`.
 | `json-syntax` | all | JSON syntax errors, including comments and trailing commas, which PrairieLearn's `JSON.parse` rejects |
 | `schema` | all | Violations of PrairieLearn's own JSON schema for the selected version. Unknown properties are warnings. |
 | `duplicate-question-id` | `infoAssessment.json` | Question ids used more than once (warning) |
+| `unused-question` | question `info.json` | Questions no assessment uses, on their `title` (info). Set with `unusedQuestions`. |
+| `unused-tag` | `infoCourse.json` | Tags no question lists in its `tags`, on their `name` (warning). Set with `unusedTags`. |
+| `unused-assessment-set` | `infoCourse.json` | Assessment sets no assessment names as its `set`, on their `name` (warning). Set with `unusedAssessmentSets`. |
+| `question-info-missing` | directories in `questions/` | Directories with files but no `info.json` and no question below them, which PrairieLearn fails to load from disk. Shown at the start of the directory's `question.html`, or else its first file. Set with `missingQuestionInfo`. |
 | `question-exists` | `infoAssessment.json`, question `info.json` (`template`) | Question ids with no directory, `info.json`, or `question.html` |
 | `client-files-course-exist` | question, element, and element extension `info.json` | `clientFilesCourseStyles`/`Scripts` missing from `clientFilesCourse/` |
 | `client-files-question-exist` | question `info.json` | `clientFilesQuestionStyles`/`Scripts` missing from `clientFilesQuestion/`; deprecated `clientFiles` (warning) |
@@ -53,8 +61,15 @@ Put a `.pl-navigator.jsonc` (JSON with comments) next to `infoCourse.json`:
   // Relative to this file. Default: $XDG_CACHE_HOME/prairielearn-navigator/schemas
   // or ~/.cache/prairielearn-navigator/schemas
   "schemaCacheDir": ".cache/pl-schemas",
-  // Turn rules off or change their severity
+  // Turn rules off or change their severity: "off", "info", "warning", or "error"
   "rules": { "duplicate-question-id": "error" },
+  // Questions no assessment uses: "ignored", "info" (default), "warning", or "error"
+  "unusedQuestions": "warning",
+  // Tags and assessment sets no question or assessment uses (default "warning")
+  "unusedTags": "info",
+  "unusedAssessmentSets": "error",
+  // Directories in questions/ with files but no info.json (default "error")
+  "missingQuestionInfo": "warning",
   // Files never checked, relative to this file
   "excludes": ["courseInstances/Archive/**", "questions/drafts/**"]
 }