pi-requesty-discover 3.0.1 → 3.0.2

package/README.adoc

@@ -87,13 +87,16 @@ On startup, the extension fetches `<baseUrl>/models` using the configured `apiKe
 === Discovery settings
 
 The discovery workflow reads optional settings from `requesty-discovery-settings.json5` in the Pi config directory (`PI_CODING_AGENT_DIR`).
-The file uses JSON5, so it supports comments. It is optional; missing settings default to empty.
+The file uses JSON5, so it supports comments.
+It is optional. When missing, it will be created including defaults.
 
 Example:
 
 [source,json5]
 ----
 {
+  "$schema": "https://raw.githubusercontent.com/enolive/pi-requesty-discover/main/docs/requesty-discovery-settings.schema.json",
+
   // override the default provider id
   providerId: "requesty-export",
   // configure the health check mode

package/README.md

@@ -76,12 +76,15 @@ On startup, the extension fetches `<baseUrl>/models` using the configured `apiKe
 ### Discovery settings
 
 The discovery workflow reads optional settings from `requesty-discovery-settings.json5` in the Pi config directory (`PI_CODING_AGENT_DIR`).
-The file uses JSON5, so it supports comments. It is optional; missing settings default to empty.
+The file uses JSON5, so it supports comments.
+It is optional. When missing, it will be created including defaults.
 
 Example:
 
 ```json5
 {
+  "$schema": "https://raw.githubusercontent.com/enolive/pi-requesty-discover/main/docs/requesty-discovery-settings.schema.json",
+
   // override the default provider id
   providerId: "requesty-export",
   // configure the health check mode

package/docs/requesty-discovery-settings.schema.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "bannedModels": {
+      "default": [],
+      "type": "array",
+      "items": {
+        "type": "string",
+        "minLength": 1
+      }
+    },
+    "healthCheckMode": {
+      "default": "full",
+      "type": "string",
+      "enum": [
+        "off",
+        "basic",
+        "full"
+      ]
+    },
+    "providerId": {
+      "default": "requesty-export",
+      "type": "string"
+    }
+  },
+  "required": [
+    "bannedModels",
+    "healthCheckMode",
+    "providerId"
+  ],
+  "additionalProperties": false,
+  "$id": "https://raw.githubusercontent.com/enolive/pi-requesty/main/docs/requesty-discovery-settings.schema.json",
+  "title": "Requesty discovery settings",
+  "description": "Settings for the pi-requesty discovery extension. The file uses JSON5, so comments are allowed."
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pi-requesty-discover",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "description": "Discover available Requesty models for the Pi Coding Agent",
   "repository": {
     "type": "git",
@@ -34,7 +34,10 @@
     "test:unit:coverage": "vitest run src --coverage",
     "test:integration": "vitest run test/integration.test.ts",
     "test:watch": "vitest",
-    "prepack": "downdoc README.adoc"
+    "prepack": "downdoc README.adoc",
+    "preversion": "npm run check && npm test",
+    "version": "npm run generate:schema && git add docs/requesty-discovery-settings.schema.json",
+    "generate:schema": "jiti scripts/generate-settings-schema.ts"
   },
   "license": "MIT",
   "peerDependencies": {

package/scripts/generate-settings-schema.ts

@@ -0,0 +1,17 @@
+import fs from 'node:fs'
+import path from 'node:path'
+import { z } from 'zod'
+import { DiscoverySettingsSchema } from '../src/settings'
+
+const OUT_PATH = path.resolve('docs/requesty-discovery-settings.schema.json')
+const SCHEMA_URL =
+  'https://raw.githubusercontent.com/enolive/pi-requesty/main/docs/requesty-discovery-settings.schema.json'
+
+const schema = z.toJSONSchema(DiscoverySettingsSchema, { target: 'draft-2020-12', io: 'output' })
+schema.$id = SCHEMA_URL
+schema.title = 'Requesty discovery settings'
+schema.description = 'Settings for the pi-requesty discovery extension. The file uses JSON5, so comments are allowed.'
+
+fs.mkdirSync(path.dirname(OUT_PATH), { recursive: true })
+fs.writeFileSync(OUT_PATH, `${JSON.stringify(schema, null, 2)}\n`, 'utf8')
+console.log(`wrote ${OUT_PATH}`)

package/src/settings.ts

@@ -1,4 +1,5 @@
 import fs from 'node:fs'
+import path from 'node:path'
 import { parse as JSON5Parse } from 'json5'
 import { prettifyError, z } from 'zod'
 import { type Env } from './env'
@@ -8,7 +9,7 @@ export const DEFAULT_PROVIDER_ID = 'requesty-export'
 
 const HealthCheckModeSchema = z.enum(['off', 'basic', 'full']).default('full')
 
-const DiscoverySettingsSchema = z
+export const DiscoverySettingsSchema = z
   .object({
     bannedModels: z.array(z.string().min(1)).default([]),
     healthCheckMode: HealthCheckModeSchema,
@@ -18,12 +19,17 @@ const DiscoverySettingsSchema = z
 
 export type DiscoverySettings = z.infer<typeof DiscoverySettingsSchema>
 
+const SCHEMA_URL =
+  'https://raw.githubusercontent.com/enolive/pi-requesty-discover/main/docs/requesty-discovery-settings.schema.json'
+
 /**
  * Reads the discovery settings file (JSON5, so it supports comments).
- * Returns defaults when the file does not exist; throws when it exists but is invalid.
+ * Writes a commented default file (including the $schema editor reference) when it does not
+ * exist yet; throws when it exists but is invalid.
  */
 export function readDiscoverySettings(envConfig: Env): DiscoverySettings {
   if (!fs.existsSync(envConfig.settings_path)) {
+    writeDefaultSettingsFile(envConfig)
     return {
       bannedModels: [],
       healthCheckMode: 'full',
@@ -45,3 +51,18 @@ export function readDiscoverySettings(envConfig: Env): DiscoverySettings {
   }
   return result.data
 }
+
+function writeDefaultSettingsFile(envConfig: Env): void {
+  const content = `{
+  $schema: "${SCHEMA_URL}",
+  // the provider id in models.json whose models are managed by this extension
+  providerId: "${DEFAULT_PROVIDER_ID}",
+  // health check mode: "full" (basic + reasoning/tool check), "basic", or "off"
+  healthCheckMode: "full",
+  // models excluded from discovery; useful for models that keep failing health checks
+  bannedModels: []
+}
+`
+  fs.mkdirSync(path.dirname(envConfig.settings_path), { recursive: true })
+  fs.writeFileSync(envConfig.settings_path, content, 'utf8')
+}