@sybelblue/prairielearn-navigator 1.1.2 → 1.2.0

package/dist/core/rules/registry.d.ts

@@ -1,32 +0,0 @@
-import { RefRuleId } from "../references/specs";
-import { RuleEntry } from "./types";
-/**
- * Rules that are not about file references, by id. Each entry is
- * `[plVersionRange, courseRelativeGlob, impl]`, and for a given file the
- * first entry whose range and glob both match is the one that runs.
- *
- * To change a rule for newer PL versions, add an entry with a narrower
- * range above the existing one, e.g.
- *   [">=2026-01-01", courseFiles.question, newImpl],
- *   ["*",            courseFiles.question, oldImpl],
- */
-declare const otherRules: {
-    readonly "json-syntax": (readonly ["*", "infoCourse.json" | "courseInstances/**/infoCourseInstance.json" | "courseInstances/**/assessments/**/infoAssessment.json" | "questions/**/info.json" | "elements/*/info.json" | "elementExtensions/*/*/info.json", import("./types").RuleImpl])[];
-    readonly schema: readonly [readonly ["*", "infoCourse.json", import("./types").RuleImpl], readonly ["*", "courseInstances/**/infoCourseInstance.json", import("./types").RuleImpl], readonly ["*", "courseInstances/**/assessments/**/infoAssessment.json", import("./types").RuleImpl], readonly ["*", "questions/**/info.json", import("./types").RuleImpl], readonly ["*", "elements/*/info.json", import("./types").RuleImpl], readonly ["*", "elementExtensions/*/*/info.json", import("./types").RuleImpl]];
-    readonly "duplicate-question-id": readonly [readonly ["*", "courseInstances/**/assessments/**/infoAssessment.json", import("./types").RuleImpl]];
-    readonly "unused-question": readonly [readonly ["*", "questions/**/info.json", import("./types").RuleImpl]];
-    readonly "unused-tag": readonly [readonly ["*", "infoCourse.json", import("./types").RuleImpl]];
-    readonly "unused-assessment-set": readonly [readonly ["*", "infoCourse.json", import("./types").RuleImpl]];
-    readonly "question-info-missing": readonly [];
-};
-/**
- * Every validation rule, by id. Ids appear in diagnostic codes as
- * `prairielearn-navigator/<id>` and are the keys of the `rules` setting.
- */
-export declare const rules: Record<RuleId, readonly RuleEntry[]>;
-export type RuleId = keyof typeof otherRules | RefRuleId;
-/** Rules that read the reference index; without one they report nothing. */
-export declare const indexedRules: readonly RuleId[];
-export declare function isRuleId(id: string): id is RuleId;
-export declare function ruleDiagnosticCode(id: RuleId): string;
-export {};

package/dist/core/rules/run.d.ts

@@ -1,25 +0,0 @@
-import { NavigatorConfig } from "../config";
-import { Diagnostic } from "../diagnostic";
-import { IsoDate } from "../plVersion";
-import { ReferenceIndex } from "../referenceIndex";
-import { SchemaStore } from "../schemas";
-import { RuleId } from "./registry";
-import { RuleImpl, RuleTable } from "./types";
-/** The implementation of each rule that applies to `relPath` at `plDate`. */
-export declare function selectRules<Id extends string = RuleId>(relPath: string, plDate: IsoDate, table?: RuleTable): [Id, RuleImpl][];
-/** Globs, relative to a course root, of every file some rule applies to. */
-export declare function checkableGlobs(): string[];
-/** Whether any rule applies to this course-relative path, at any version. */
-export declare function isCheckable(relPath: string): boolean;
-/** Runs every applicable, enabled rule on one file of a course. */
-export declare function runRules(filePath: string, text: string, options: {
-    courseRoot: string;
-    config: NavigatorConfig;
-    schemas: SchemaStore;
-    references?: ReferenceIndex;
-}): Promise<Diagnostic[]>;
-/**
- * Runs the rules that look at a course as a whole rather than one file.
- * Returns diagnostics by the absolute path of the file each is shown on.
- */
-export declare function runCourseRules(courseRoot: string, config: NavigatorConfig): Map<string, Diagnostic[]>;

package/dist/core/rules/types.d.ts

@@ -1,35 +0,0 @@
-import { Diagnostic } from "../diagnostic";
-import { JsonDoc } from "../json";
-import { IsoDate, PlVersion, VersionRange } from "../plVersion";
-import { ReferenceIndex } from "../referenceIndex";
-import { SchemaStore } from "../schemas";
-/** Everything a rule may inspect about the file being checked. */
-export interface RuleContext {
-    courseRoot: string;
-    filePath: string;
-    /** Posix path relative to the course root, as matched by rule globs. */
-    relPath: string;
-    text: string;
-    doc: JsonDoc;
-    plVersion: PlVersion;
-    /** The date `plVersion` stands for, used to select version-ranged rules. */
-    plDate: IsoDate;
-    schemas: SchemaStore;
-    /**
-     * The course's reference index, when the caller has built one; cross-file
-     * rules report nothing without it.
-     */
-    references?: ReferenceIndex;
-}
-export type RuleImpl = (ctx: RuleContext) => Diagnostic[] | Promise<Diagnostic[]>;
-/**
- * One implementation of a rule for PL versions in `range` and files matching
- * `files` (a glob relative to the course root).
- */
-export type RuleEntry = readonly [range: VersionRange, files: string, impl: RuleImpl];
-/**
- * Rule id -> ordered entries. For each rule, the first entry whose range and
- * glob both match the file is the one that runs; put newer-version entries
- * above older ones.
- */
-export type RuleTable = Record<string, readonly RuleEntry[]>;

package/dist/core/schemas.d.ts

@@ -1,51 +0,0 @@
-import { ValidateFunction } from "ajv";
-import { PlVersion } from "./plVersion";
-export type SchemaName = "infoCourse" | "infoCourseInstance" | "infoAssessment" | "infoQuestion" | "infoElementCourse" | "infoElementExtension";
-export interface LoadedSchema {
-    validate: ValidateFunction;
-    label: string;
-}
-type Fetch = (url: string, init?: {
-    headers?: Record<string, string>;
-}) => Promise<{
-    ok: boolean;
-    status: number;
-    text(): Promise<string>;
-    json(): Promise<unknown>;
-}>;
-export interface SchemaStoreOptions {
-    cacheDir: string;
-    /** Injected for tests; defaults to the global fetch. */
-    fetch?: Fetch;
-    /** Raises the GitHub API rate limit for date versions. */
-    githubToken?: string;
-}
-/**
- * Fetches PrairieLearn's JSON schemas for a given PL version and caches them
- * on disk as `<cacheDir>/<sha | master-YYYY-MM-DD>/<name>.json`.
- *
- * Failures never throw: `get` resolves to undefined and the reason is
- * recorded once in `problems`, so callers can report it a single time.
- */
-export declare class SchemaStore {
-    private readonly options;
-    readonly problems: Set<string>;
-    private readonly fetch;
-    private readonly loading;
-    private readonly resolving;
-    constructor(options: SchemaStoreOptions);
-    get cacheDir(): string;
-    get(name: SchemaName, version: PlVersion): Promise<LoadedSchema | undefined>;
-    private load;
-    private resolve;
-    private resolveUncached;
-    /** Last commit on master at or before the end of `date` (UTC). */
-    private lookupSha;
-    private schemaText;
-    private writeCache;
-    private pruneStaleLatest;
-    private get refsFile();
-    private readRefs;
-    private writeRefs;
-}
-export {};

package/dist/library.d.ts

@@ -1 +0,0 @@
-export { createQuestionFileResolver, type QuestionFileDescriptor, type QuestionFileProvenance, type QuestionFileResolution, type QuestionFileResolutionUpdate, type QuestionFileResolver, type QuestionFileResolverOptions, type ResolvedQuestionFile, } from "./core/questionFileResolver";