fix: Add $schema field to the cspell-tools config (#4708)

Author: Jason3S

packages/cspell-tools/cspell-tools.config.schema.json

@@ -195,6 +195,11 @@
     }
   },
   "properties": {
+    "$schema": {
+      "default": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/packages/cspell-tools/cspell-tools.config.schema.json",
+      "description": "Url to JSON Schema",
+      "type": "string"
+    },
     "allowedSplitWords": {
       "anyOf": [
         {

packages/cspell-tools/package.json

@@ -63,9 +63,7 @@
   },
   "devDependencies": {
     "@types/glob": "^8.1.0",
-    "@types/jest": "^29.5.3",
     "@types/shelljs": "^0.8.12",
-    "jest": "^29.6.2",
     "lorem-ipsum": "^2.0.8",
     "shelljs": "^0.8.5",
     "ts-json-schema-generator": "^1.2.0"

packages/cspell-tools/src/compile.test.ts

@@ -3,6 +3,7 @@ import { writeFile } from 'node:fs/promises';
 import { describe, expect, test, vi } from 'vitest';
 
 import { configFileHeader, processCompileAction } from './compile.js';
+import { configFileSchemaURL } from './config/config.js';
 
 vi.mock('node:fs/promises', () => ({
     writeFile: vi.fn().mockImplementation(() => Promise.resolve(undefined)),
@@ -25,6 +26,7 @@ describe('compile', () => {
         const expected =
             configFileHeader +
             `\
+$schema: ${configFileSchemaURL}
 targets:
   - name: public-licenses
     targetDirectory: .
@@ -53,6 +55,7 @@ targets:
         const expected =
             configFileHeader +
             `\
+$schema: ${configFileSchemaURL}
 targets:
   - name: nl-nl
     targetDirectory: .

packages/cspell-tools/src/compile.ts

@@ -6,7 +6,7 @@ import YAML from 'yaml';
 import type { CompileCommonAppOptions } from './AppOptions.js';
 import { compile } from './compiler/compile.js';
 import { createCompileRequest } from './compiler/createCompileRequest.js';
-import type { CompileRequest } from './config/config.js';
+import { configFileSchemaURL, type RunConfig } from './config/config.js';
 import type { FeatureFlags } from './FeatureFlags/index.js';
 import { getSystemFeatureFlags, parseFlags } from './FeatureFlags/index.js';
 import { globP } from './util/globP.js';
@@ -15,8 +15,7 @@ getSystemFeatureFlags().register('compound', 'Enable compound dictionary sources
 
 const defaultConfigFile = 'cspell-tools.config.yaml';
 
-export const configFileHeader =
-    '# yaml-language-server: $schema=https://raw.githubusercontent.com/streetsidesoftware/cspell/main/packages/cspell-tools/cspell-tools.config.schema.json\n\n';
+export const configFileHeader = `# yaml-language-server: $schema=${configFileSchemaURL}\n\n`;
 
 export async function processCompileAction(
     src: string[],
@@ -52,8 +51,10 @@ async function useCompile(src: string[], options: CompileCommonAppOptions): Prom
     return options.init ? initConfig(request) : compile(request);
 }
 
-async function initConfig(request: CompileRequest): Promise<void> {
-    const content = configFileHeader + YAML.stringify(request, null, 2);
+async function initConfig(runConfig: RunConfig): Promise<void> {
+    const { $schema = configFileSchemaURL, ...cfg } = runConfig;
+    const config = { $schema, ...cfg };
+    const content = configFileHeader + YAML.stringify(config, null, 2);
     console.log('Writing config file: %s', defaultConfigFile);
     await writeFile(defaultConfigFile, content);
 

packages/cspell-tools/src/config/config.ts

@@ -1,4 +1,10 @@
 export interface RunConfig extends Partial<CompileRequest> {
+    /**
+     * Url to JSON Schema
+     * @default "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/packages/cspell-tools/cspell-tools.config.schema.json"
+     */
+    $schema?: string;
+
     /**
      * Optional Target Dictionaries to create.
      */
@@ -144,3 +150,6 @@ export interface CompileSourceOptions {
 
     allowedSplitWords?: FilePath | FilePath[] | undefined;
 }
+
+export const configFileSchemaURL =
+    'https://raw.githubusercontent.com/streetsidesoftware/cspell/main/packages/cspell-tools/cspell-tools.config.schema.json';