correctly 0.0.0 → 0.1.0

package/package.json

@@ -1,61 +1,70 @@
 {
-	"name": "correctly",
-	"version": "0.0.0",
-	"description": "Shared JSON Schema validation for CI and editors",
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/jeremybanka/correctly.git",
-		"directory": "packages/correctly"
-	},
-	"license": "MPL-2.0",
-	"type": "module",
-	"exports": {
-		".": {
-			"types": "./dist/core.d.mts",
-			"import": "./dist/core.mjs"
-		},
-		"./config.schema.json": "./src/core/config.schema.json"
-	},
-	"bin": {
-		"correctly": "./dist/cli.mjs",
-		"correctly-lsp": "./dist/lsp.mjs"
-	},
-	"files": [
-		"dist",
-		"src",
-		"docs",
-		"LICENSE",
-		"README.md",
-		"AGENTS.md",
-		"examples"
-	],
-	"scripts": {
-		"build": "vp pack",
-		"build:vsix": "node src/cli/vsix.ts",
-		"test": "vp test",
-		"test:public": "vp test tests/public",
-		"test:private": "vp test tests/private",
-		"test:watch": "vp test watch"
-	},
-	"dependencies": {
-		"ajv": "8.20.0",
-		"ajv-formats": "3.0.1",
-		"jsonc-parser": "3.3.1",
-		"picomatch": "4.0.7",
-		"tinyglobby": "0.2.17",
-		"vscode-json-languageservice": "5.7.2",
-		"vscode-languageserver": "10.1.2",
-		"vscode-languageserver-textdocument": "1.0.15"
-	},
-	"devDependencies": {
-		"@types/node": "26.6.3",
-		"@types/picomatch": "4.0.3",
-		"@types/vscode": "1.138.0",
-		"@vscode/vsce": "4.0.0",
-		"rolldown": "1.2.11",
-		"vscode-languageclient": "10.1.2"
-	},
-	"engines": {
-		"node": ">=22.18.0"
-	}
-}
+  "name": "correctly",
+  "version": "0.1.0",
+  "description": "Shared JSON Schema validation for CI and editors",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jeremybanka/correctly.git",
+    "directory": "packages/correctly"
+  },
+  "license": "MPL-2.0",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/core.d.mts",
+      "import": "./dist/core.mjs"
+    },
+    "./validators/ajv": {
+      "types": "./dist/ajv.d.mts",
+      "import": "./dist/ajv.mjs"
+    },
+    "./extensions/renovate": {
+      "types": "./dist/renovate.d.mts",
+      "import": "./dist/renovate.mjs"
+    }
+  },
+  "bin": {
+    "correctly": "./dist/cli.mjs",
+    "correctly-lsp": "./dist/lsp.mjs"
+  },
+  "files": [
+    "dist",
+    "src",
+    "docs",
+    "LICENSE",
+    "README.md",
+    "AGENTS.md",
+    "examples"
+  ],
+  "dependencies": {
+    "ajv": "8.20.0",
+    "ajv-formats": "3.0.1",
+    "comline": "0.9.0",
+    "jsonc-parser": "3.3.1",
+    "picomatch": "4.0.7",
+    "tinyglobby": "0.2.17",
+    "vscode-json-languageservice": "5.7.2",
+    "vscode-languageserver": "10.1.2",
+    "vscode-languageserver-textdocument": "1.0.15"
+  },
+  "devDependencies": {
+    "@types/node": "26.6.4",
+    "@types/picomatch": "4.0.3",
+    "@types/vscode": "1.140.0",
+    "@vscode/vsce": "4.0.0",
+    "rolldown": "1.2.12",
+    "vscode-languageclient": "10.1.2"
+  },
+  "engines": {
+    "node": ">=22.18.0"
+  },
+  "scripts": {
+    "build": "vp pack",
+    "build:vsix": "node src/cli/vsix.ts",
+    "test": "vp test",
+    "test:public": "vp test tests/public",
+    "test:private": "vp test tests/private",
+    "test:watch": "vp test watch",
+    "test:distribution": "vp test tests/private/distribution.test.ts"
+  }
+}

package/src/cli/check.ts

@@ -1,12 +1,8 @@
 import { readFile } from "node:fs/promises"
 import path from "node:path"
 import { glob } from "tinyglobby"
-import {
-	discoverConfig,
-	exclusions,
-	isIncluded,
-	loadProject,
-} from "../core/config.ts"
+import { discoverConfig, exclusions, isIncluded } from "../core/config.ts"
+import { ProjectSession } from "../runtime/session.ts"
 import { Engine } from "../core/engine.ts"
 import { failure, type Report } from "../core/types.ts"
 
@@ -17,14 +13,15 @@ export type CheckOptions = {
 	files?: string[]
 	onRead?: (file: string, text: string) => void
 }
-export async function check(options: CheckOptions = {}): Promise<Report> {
+function emptyReport(): Report {
 	const report: Report = {
-		reportVersion: 1,
+		reportVersion: 2,
 		config: null,
 		files: [],
 		failures: [],
 		summary: {
 			checked: 0,
+			validated: 0,
 			schemaCovered: 0,
 			syntaxOnly: 0,
 			invalid: 0,
@@ -32,17 +29,47 @@ export async function check(options: CheckOptions = {}): Promise<Report> {
 		},
 		exitCode: 0,
 	}
+	return report
+}
+export async function check(options: CheckOptions = {}): Promise<Report> {
+	const report = emptyReport()
+	let session: ProjectSession | undefined
 	try {
 		const cwd = path.resolve(options.cwd ?? process.cwd())
 		const configPath = options.config
 			? path.resolve(cwd, options.config)
 			: await discoverConfig(cwd)
 		report.config = configPath
-		const project = await loadProject(configPath)
-		const engine = new Engine(
-			project,
+		session = new ProjectSession(
+			configPath,
 			options.offline === undefined ? {} : { offline: options.offline },
 		)
+		const result = await session.check({
+			cwd,
+			...(options.files ? { files: options.files } : {}),
+			sources: Boolean(options.onRead),
+		})
+		for (const [file, text] of result.sources) options.onRead?.(file, text)
+		return result.report
+	} catch (error) {
+		report.failures.push(failure(error))
+		report.summary.failures = 1
+		report.exitCode = 2
+		return report
+	} finally {
+		await session?.dispose()
+	}
+}
+export async function checkProject(
+	engine: Engine,
+	options: CheckOptions,
+): Promise<Report> {
+	const report = emptyReport()
+	const project = engine.project
+	report.config = project.configPath
+
+	try {
+		const cwd = path.resolve(options.cwd ?? process.cwd())
 		await engine.prepare()
 		const files = options.files?.length
 			? options.files.map((f) => path.resolve(cwd, f))
@@ -69,6 +96,9 @@ export async function check(options: CheckOptions = {}): Promise<Report> {
 	const checked = report.files.filter((f) => f.coverage !== "excluded")
 	report.summary = {
 		checked: checked.length,
+		validated: checked.filter(
+			(f) => f.coverage === "schema" || f.coverage === "validated",
+		).length,
 		schemaCovered: checked.filter((f) => f.coverage === "schema").length,
 		syntaxOnly: checked.filter((f) => f.coverage === "syntax-only").length,
 		invalid: checked.filter((f) => f.diagnostics.length > 0).length,

package/src/cli/main.ts

@@ -6,7 +6,7 @@ import { failure, type Report } from "../core/types.ts"
 const HELP = `correctly check [files...] [--config path] [--offline] [--format readable|json]
 correctly-lsp --stdio
 
-Validate JSON/JSONC using associations in correctly.config.json.
+Validate JSON/JSONC using associations in correctly.config.ts.
 Exit 0: valid; 1: document errors; 2: configuration, schema, or execution errors.
 Formatting does not affect validation. See the package guide for configuration.
 `
@@ -59,12 +59,13 @@ export async function run(
 		}
 	} catch (error) {
 		const report: Report = {
-			reportVersion: 1,
+			reportVersion: 2,
 			config: null,
 			files: [],
 			failures: [failure(error)],
 			summary: {
 				checked: 0,
+				validated: 0,
 				schemaCovered: 0,
 				syntaxOnly: 0,
 				invalid: 0,

package/src/cli/readable.ts

@@ -117,6 +117,19 @@ function excerpt(
 	return { lines: output, width }
 }
 
+function renderFailure(
+	error: Failure,
+	styler: Styler,
+	prefix = "",
+	continuation = "",
+): string {
+	const [title, ...details] = error.message.split("\n")
+	return [
+		`${prefix}${styler.bad(error.code)}: ${title}`,
+		...details.map((line) => `${styler.dim(continuation + "│")} ${line}`),
+	].join("\n")
+}
+
 type FileGroup = { file: string; result?: FileResult; failures: Failure[] }
 
 function renderDiagnostic(
@@ -201,7 +214,9 @@ function fileSection(
 				? format
 				: schema
 					? `${format} against ${association.name} (${displaySchema(cwd, schema)})`
-					: `${format} syntax only (${association ? `association: ${association.name}` : "no schema association"})`
+					: association?.validator
+						? `${format} validated by ${association.validator}`
+						: `${format} syntax only (${association ? `association: ${association.name}` : "no schema association"})`
 		header += `  ${styler.dim(`·  ${description}`)}`
 	}
 	const output = [header]
@@ -230,7 +245,12 @@ function fileSection(
 			)
 		} else
 			output.push(
-				`${styler.dim(branch)} ${styler.bad(issue.code)}: ${issue.message}`,
+				renderFailure(
+					issue,
+					styler,
+					`${styler.dim(branch)} `,
+					last ? "   " : "│  ",
+				),
 			)
 		if (!last) output.push(styler.dim("│"))
 	}
@@ -265,8 +285,7 @@ export function readableReport(
 	const output = [...groups.values()]
 		.toSorted((a, b) => (a.file < b.file ? -1 : a.file > b.file ? 1 : 0))
 		.map((group) => fileSection(group, options, styler))
-	for (const error of globalFailures)
-		output.push(`${styler.bad(error.code)}: ${error.message}`)
+	for (const error of globalFailures) output.push(renderFailure(error, styler))
 	const errors = report.files.reduce(
 		(count, file) => count + diagnosticViews(file.diagnostics).length,
 		0,
@@ -288,7 +307,7 @@ export function readableReport(
 					? styler.warning
 					: styler.success)(status),
 			"",
-			`${s.checked} checked, ${s.schemaCovered} schema-covered, ${s.syntaxOnly} syntax-only, ${s.invalid} invalid, ${s.failures} failures`,
+			`${s.checked} checked, ${s.validated} validated, ${s.schemaCovered} schema-covered, ${s.syntaxOnly} syntax-only, ${s.invalid} invalid, ${s.failures} failures`,
 		].join("\n"),
 	)
 	return output.join("\n\n")

package/src/cli/vsix.ts

@@ -15,6 +15,7 @@ export async function buildVsix(
 	for (const [entry, outfile] of [
 		["vscode/extension", "extension"],
 		["lsp/server", "server"],
+		["runtime/worker", "worker"],
 	]) {
 		const bundle = await rolldown({
 			input: path.join(packageRoot, `src/${entry}.ts`),

package/src/core/adapters.ts

@@ -0,0 +1,54 @@
+import type { Diagnostic } from "./types.ts"
+import type { ParsedDocument } from "./parse.ts"
+import type { ReadText, RemoteOptions } from "./config.ts"
+
+export type Parser = {
+	id: string
+	/** The parsed value representation, not the source file extension. */
+	valueModel: string
+	editorLanguage?: "json" | "jsonc"
+	parse(
+		text: string,
+		context: { file: string; signal?: AbortSignal },
+	): ParsedDocument | Promise<ParsedDocument>
+}
+export type ValidationContext = {
+	root: string
+	configPath: string
+	remote?: RemoteOptions
+	read: ReadText
+	fetch?: typeof fetch
+	signal?: AbortSignal
+	/** Project-scoped services; use a versioned Symbol.for key for cross-package sharing. */
+	services: Map<symbol, unknown>
+	/** Register a file or URI which affects this adapter's prepared state. */
+	watch(uri: string): void
+}
+export type ValidationInput = {
+	file: string
+	text: string
+	parsed: ParsedDocument
+	signal?: AbortSignal
+}
+export type JsonSchemaEditorSupport = {
+	kind: "json-schema"
+	uri: string
+	readSchema(uri: string): Promise<string>
+}
+export type PreparedValidator = {
+	validate(input: ValidationInput): Diagnostic[] | Promise<Diagnostic[]>
+	editor?: JsonSchemaEditorSupport
+	dispose?(): void | Promise<void>
+}
+export type Validator = {
+	id: string
+	accepts: readonly string[]
+	/** Optional JSON Schema location for coverage reporting. */
+	schema?: string
+	extensions?: readonly { readonly id: string }[]
+	/** Register resources before any association is prepared (e.g. schema IDs). */
+	register?(context: ValidationContext): void | Promise<void>
+	prepare(
+		context: ValidationContext,
+	): PreparedValidator | Promise<PreparedValidator>
+}