Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 | /**
* Scaffold Model Service
*
* Service for scaffolding content model configurations from existing data files.
* Analyzes file structure and infers field types to generate model definitions.
*/
import path from 'path';
import fs from 'fs-extra';
import { SCAFFOLD_SUPPORTED_EXTENSIONS } from './types.js';
import { inferFieldsFromData } from './field-inferrer.js';
/**
* ScaffoldModelService creates content model configurations by analyzing
* existing data files and inferring their field structure.
*/
export class ScaffoldModelService {
workspacePath;
deps;
constructor(workspacePath, deps) {
this.workspacePath = workspacePath;
this.deps = deps;
}
/**
* Scaffold a single model from a selected file
*
* Opens a file dialog for the user to select a data file, parses it,
* infers field types, and creates a single model configuration.
*/
async scaffoldSingleFromFile(dataType = 'data') {
try {
// Open file dialog
const filePaths = await this.deps.dialogAdapter.showOpenDialog({
title: 'Select a data file to scaffold',
defaultPath: this.workspacePath,
buttonLabel: 'Scaffold Single',
filters: [
{
name: 'Data Files',
extensions: [...SCAFFOLD_SUPPORTED_EXTENSIONS],
},
],
properties: ['openFile'],
});
if (!filePaths || filePaths.length === 0) {
return { success: false, error: 'No file selected' };
}
const filePath = filePaths[0];
return await this.createSingleFromFile(filePath, dataType);
}
catch (error) {
const errorMessage = error instanceof Error ? error.message : String(error);
await this.showErrorDialog('Scaffold Error', errorMessage);
return { success: false, error: errorMessage };
}
}
/**
* Scaffold a collection model from a selected file
*
* Opens a file dialog for the user to select a data file from a collection folder,
* parses it, infers field types, and creates a collection model configuration.
*/
async scaffoldCollectionFromFile(dataType = 'content') {
try {
// Open file dialog
const filePaths = await this.deps.dialogAdapter.showOpenDialog({
title: 'Select a file from the collection folder',
defaultPath: this.workspacePath,
buttonLabel: 'Scaffold Collection',
filters: [
{
name: 'Data Files',
extensions: [...SCAFFOLD_SUPPORTED_EXTENSIONS],
},
],
properties: ['openFile'],
});
if (!filePaths || filePaths.length === 0) {
return { success: false, error: 'No file selected' };
}
const filePath = filePaths[0];
return await this.createCollectionFromFile(filePath, dataType);
}
catch (error) {
const errorMessage = error instanceof Error ? error.message : String(error);
await this.showErrorDialog('Scaffold Error', errorMessage);
return { success: false, error: errorMessage };
}
}
/**
* Create a single model configuration from a file path
*/
async createSingleFromFile(filePath, dataType) {
const parsed = await this.parseFile(filePath);
if (!parsed.success) {
return parsed;
}
const ext = path.extname(filePath).slice(1).toLowerCase();
const relativePath = path.relative(this.workspacePath, filePath);
const baseName = path.basename(filePath, path.extname(filePath));
const modelKey = this.generateModelKey(baseName);
// Infer fields from parsed data
const fields = inferFieldsFromData(parsed.data);
// Create single model config
const singleConfig = {
key: modelKey,
title: this.titleCase(baseName),
file: relativePath,
dataformat: this.normalizeDataFormat(ext),
fields,
};
// Write model file
const modelPath = await this.writeSingleModel(singleConfig, dataType);
// Add to menu
await this.addToMenu(modelKey, 'single', dataType);
return {
success: true,
modelKey,
modelPath,
};
}
/**
* Create a collection model configuration from a file path
*/
async createCollectionFromFile(filePath, dataType) {
const parsed = await this.parseFile(filePath);
if (!parsed.success) {
return parsed;
}
const ext = path.extname(filePath).slice(1).toLowerCase();
const folderPath = path.dirname(filePath);
const relativeFolder = path.relative(this.workspacePath, folderPath);
const folderName = path.basename(folderPath);
const modelKey = this.generateModelKey(folderName);
// Infer fields from parsed data
const fields = inferFieldsFromData(parsed.data);
// Create collection model config
const collectionConfig = {
key: modelKey,
title: this.titleCase(folderName),
folder: relativeFolder,
extension: ext,
dataformat: this.normalizeDataFormat(ext),
itemtitle: 'title',
fields,
};
// Write model file
const modelPath = await this.writeCollectionModel(collectionConfig, dataType);
// Add to menu
await this.addToMenu(modelKey, 'collection', dataType);
return {
success: true,
modelKey,
modelPath,
};
}
/**
* Parse a file and extract its data content
*/
async parseFile(filePath) {
if (!fs.existsSync(filePath)) {
return { success: false, error: `File not found: ${filePath}` };
}
const ext = path.extname(filePath).slice(1).toLowerCase();
const content = await fs.readFile(filePath, 'utf-8');
if (!content.trim()) {
return { success: false, error: 'File is empty' };
}
try {
// Handle markdown files with frontmatter
if (['md', 'markdown', 'qmd'].includes(ext)) {
return this.parseFrontmatter(content);
}
// Handle data files (yaml, toml, json)
const formatProvider = this.deps.formatResolver.resolveForExtension(ext);
if (!formatProvider) {
return { success: false, error: `Unsupported file format: ${ext}` };
}
const data = formatProvider.parse(content);
if (typeof data !== 'object' || data === null) {
return { success: false, error: 'File does not contain valid object data' };
}
return { success: true, data: data };
}
catch (error) {
const errorMessage = error instanceof Error ? error.message : String(error);
return { success: false, error: `Parse error: ${errorMessage}` };
}
}
/**
* Parse frontmatter from markdown content
*/
parseFrontmatter(content) {
const lines = content.split('\n');
const firstLine = lines[0]?.trim();
// Detect frontmatter delimiter and format
let delimiterPattern = null;
let formatProvider = this.deps.formatResolver.resolveForMdFirstLine(firstLine);
if (firstLine === '---') {
delimiterPattern = /^---\s*$/;
formatProvider = formatProvider || this.deps.formatResolver.resolveForExtension('yaml');
}
else if (firstLine === '+++') {
delimiterPattern = /^\+\+\+\s*$/;
formatProvider = this.deps.formatResolver.resolveForExtension('toml');
}
else if (firstLine === '{') {
// JSON frontmatter
formatProvider = this.deps.formatResolver.resolveForExtension('json');
}
else {
return { success: false, error: 'No frontmatter found in markdown file' };
}
if (!formatProvider) {
return { success: false, error: 'Could not determine frontmatter format' };
}
// Extract frontmatter content
let frontmatterEnd = -1;
for (let i = 1; i < lines.length; i++) {
if (delimiterPattern && delimiterPattern.test(lines[i].trim())) {
frontmatterEnd = i;
break;
}
}
if (frontmatterEnd === -1) {
// Try parsing the whole content as the format (for JSON frontmatter)
if (firstLine === '{') {
try {
// Find matching closing brace
let braceCount = 0;
let jsonEnd = -1;
for (let i = 0; i < lines.length; i++) {
for (const char of lines[i]) {
if (char === '{')
braceCount++;
if (char === '}')
braceCount--;
if (braceCount === 0) {
jsonEnd = i;
break;
}
}
if (jsonEnd !== -1)
break;
}
if (jsonEnd !== -1) {
const jsonContent = lines.slice(0, jsonEnd + 1).join('\n');
const data = formatProvider.parse(jsonContent);
return { success: true, data: data };
}
}
catch {
// Fall through to error
}
}
return { success: false, error: 'Could not find end of frontmatter' };
}
const frontmatterContent = lines.slice(1, frontmatterEnd).join('\n');
try {
const data = formatProvider.parse(frontmatterContent);
if (typeof data !== 'object' || data === null) {
return { success: false, error: 'Frontmatter does not contain valid object data' };
}
return { success: true, data: data };
}
catch (error) {
const errorMessage = error instanceof Error ? error.message : String(error);
return { success: false, error: `Frontmatter parse error: ${errorMessage}` };
}
}
/**
* Write a single model configuration file
*/
async writeSingleModel(config, dataType) {
const modelDir = path.join(this.workspacePath, 'quiqr', 'model', 'includes', 'singles');
await fs.ensureDir(modelDir);
const modelPath = path.join(modelDir, `${config.key}.yaml`);
const yamlProvider = this.deps.formatResolver.resolveForExtension('yaml');
if (!yamlProvider) {
throw new Error('YAML format provider not available');
}
const yamlContent = yamlProvider.dump(config);
await fs.writeFile(modelPath, yamlContent, 'utf-8');
return modelPath;
}
/**
* Write a collection model configuration file
*/
async writeCollectionModel(config, dataType) {
const modelDir = path.join(this.workspacePath, 'quiqr', 'model', 'includes', 'collections');
await fs.ensureDir(modelDir);
const modelPath = path.join(modelDir, `${config.key}.yaml`);
const yamlProvider = this.deps.formatResolver.resolveForExtension('yaml');
if (!yamlProvider) {
throw new Error('YAML format provider not available');
}
const yamlContent = yamlProvider.dump(config);
await fs.writeFile(modelPath, yamlContent, 'utf-8');
return modelPath;
}
/**
* Add a scaffolded model to the menu.yaml in quiqr/model/includes/
* The menu.yaml in includes/ stores items directly at root level (no 'menu:' wrapper)
*/
async addToMenu(modelKey, modelType, dataType) {
const menuPath = path.join(this.workspacePath, 'quiqr', 'model', 'includes', 'menu.yaml');
let menuItems = [];
const yamlProvider = this.deps.formatResolver.resolveForExtension('yaml');
if (!yamlProvider) {
throw new Error('YAML format provider not available');
}
// Read existing menu if it exists
if (fs.existsSync(menuPath)) {
const content = await fs.readFile(menuPath, 'utf-8');
if (content.trim()) {
const parsed = yamlProvider.parse(content);
// Menu items are stored directly as an array at root level
if (Array.isArray(parsed)) {
menuItems = parsed;
}
}
}
// Find or create the data type group
let group = menuItems.find((item) => item.key === dataType);
if (!group) {
group = {
key: dataType,
title: this.titleCase(dataType),
menuItems: [],
};
menuItems.push(group);
}
// Ensure menuItems array exists in the group
if (!Array.isArray(group.menuItems)) {
group.menuItems = [];
}
const groupMenuItems = group.menuItems;
// Check if item already exists
const existingItem = groupMenuItems.find((item) => item.key === modelKey);
if (!existingItem) {
groupMenuItems.push({
key: modelKey,
[modelType]: modelKey,
});
}
// Write updated menu - items directly at root level (no wrapper)
await fs.ensureDir(path.dirname(menuPath));
const yamlContent = yamlProvider.dump(menuItems);
await fs.writeFile(menuPath, yamlContent, 'utf-8');
}
/**
* Transform inferred fields to YAML-compatible format
*/
transformFieldsForYaml(fields) {
return fields.map((field) => {
const result = {
key: field.key,
type: field.type,
};
if (field.groupdata) {
result.groupdata = true;
}
if (field.fields && field.fields.length > 0) {
result.fields = this.transformFieldsForYaml(field.fields);
}
return result;
});
}
/**
* Generate a unique model key from a base name
*/
generateModelKey(baseName) {
// Convert to lowercase, replace spaces/special chars with hyphens
return baseName
.toLowerCase()
.replace(/[^a-z0-9]+/g, '-')
.replace(/^-+|-+$/g, '');
}
/**
* Convert string to title case
*/
titleCase(str) {
return str
.replace(/[-_]/g, ' ')
.replace(/\b\w/g, (char) => char.toUpperCase());
}
/**
* Normalize data format extension
*/
normalizeDataFormat(ext) {
if (ext === 'yml')
return 'yaml';
if (['md', 'markdown', 'qmd'].includes(ext))
return 'yaml'; // Default frontmatter format
return ext;
}
/**
* Show an error dialog to the user
*/
async showErrorDialog(title, message) {
await this.deps.dialogAdapter.showMessageBox({
type: 'error',
buttons: ['OK'],
title,
message,
detail: message,
});
}
}
/**
* Factory function to create a ScaffoldModelService instance
*/
export function createScaffoldModelService(workspacePath, deps) {
return new ScaffoldModelService(workspacePath, deps);
}
|