Skip to content

fix: validation of counter in scg configs #837

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vetlek merged 4 commits into from
Sep 24, 2025
Merged

fix: validation of counter in scg configs #837

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f432dd6
Fix validation of counter in scg configs
vetlek Sep 19, 2025
e73dd8b
Use ajv for validating data schemas
vetlek Sep 19, 2025
279a85e
Fix import path and improve error message
vetlek Sep 22, 2025
34f6f11
Allow additional properties in scg validation
vetlek Sep 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 16 additions & 67 deletions client/src/scg.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
import * as yaml from 'js-yaml';
import * as path from 'path';
import * as vscode from 'vscode';
import Ajv from 'ajv';

import * as scgSchema from '../../schemas/scg_config.schema.json';

const ajv = new Ajv();
const validate_scg = ajv.compile<ScgConfigSchema>(scgSchema);

export interface ScgConfigSchema {
outputfile?: string;
Expand Down Expand Up @@ -153,89 +159,32 @@ export async function readScgConfig(filePath: string): Promise<ScgConfigSchema |
const uri = vscode.Uri.file(filePath);
const document = await vscode.workspace.openTextDocument(uri);
const fileContents = document.getText();
const data = yaml.load(fileContents) as ScgConfigSchema;
if (!validateScgConfig(data)) {
return undefined;
const data = yaml.load(fileContents);

if (validate_scg(data)) {
return data;
}
return data;
let errorMessage = `Error validating ${filePath} against the SCG schema:\n`;
errorMessage += validate_scg.errors.map(error => `SCG config validation error at ${error.instancePath}: ${error.message}`).join('\n');
vscode.window.showErrorMessage(errorMessage);
return undefined;
} catch {
return undefined;
}
}

export function validateScgConfig(data: ScgConfigSchema): boolean {
if (!data.templatepath || typeof data.templatepath !== 'string') return false;
if (data.adjustspacing && typeof data.adjustspacing !== 'boolean') return false;
if (data.verifycontent && typeof data.verifycontent !== 'boolean') return false;

// Validate optional fields
if (data.outputfile && typeof data.outputfile !== 'string') return false;

// Validate counters
if (data.counters) {
for (const counter of data.counters) {
if (typeof counter.name !== 'string' || typeof counter.value !== 'number') return false;
}
}

// Validate sources
for (const source of data.sources) {
if (typeof source.filename !== 'string' || typeof source.id !== 'string') return false;
if (source.sheet && typeof source.sheet !== 'string') return false;
if (source.delimiter && typeof source.delimiter !== 'string') return false;
}

// Validate layout
for (const layout of data.layout) {
if (typeof layout.name !== 'string') return false;
if (layout.source && typeof layout.source !== 'string') return false;
if (layout.include && typeof layout.include !== 'object') return false;
}

return true;
}

export async function isScgConfig(filePath: string): Promise<boolean> {
try {
const uri = vscode.Uri.file(filePath);
const document = await vscode.workspace.openTextDocument(uri);
const fileContents = document.getText();
const data = yaml.load(fileContents) as ScgConfigSchema;
return validateScgConfig(data);
const data = yaml.load(fileContents);
return validate_scg(data);
} catch {
return false;
}
}

export async function findScgConfigFiles(): Promise<vscode.Uri[]> {
try {
const activeEditor = vscode.window.activeTextEditor;
if (!activeEditor) {
return [];
}
let currentFolder = vscode.Uri.file(activeEditor.document.uri.fsPath).with({ path: vscode.Uri.file(activeEditor.document.uri.fsPath).path.replace(/\/[^/]+$/, '') });
const workspaceFolder = vscode.workspace.workspaceFolders?.[0].uri.fsPath;

while (currentFolder.fsPath.startsWith(workspaceFolder || '') && currentFolder.fsPath !== workspaceFolder) {
const files = await vscode.workspace.findFiles(new vscode.RelativePattern(currentFolder, '*.yaml'));
const scgConfigFiles: vscode.Uri[] = [];
for (const file of files) {
if (await isScgConfig(file.fsPath)) {
scgConfigFiles.push(file);
}
}
if (scgConfigFiles.length > 0) {
return scgConfigFiles;
}
currentFolder = vscode.Uri.file(currentFolder.fsPath).with({ path: vscode.Uri.file(currentFolder.fsPath).path.replace(/\/[^/]+$/, '') });
}
return [];
} catch (error) {
console.error('Error finding SCG config files:', error);
return [];
}
}


export class ScgSource {
id: string;
Expand Down
3 changes: 2 additions & 1 deletion client/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
"sourceMap": true,
"jsx": "react",
"jsxFactory": "vscpp",
"jsxFragmentFactory": "vscppf"
"jsxFragmentFactory": "vscppf",
"resolveJsonModule": true
},
"include": [
"src",
Expand Down
Loading