validate-manifest.jsā¢6.32 kB
#!/usr/bin/env node
/**
* Foundry VTT Module Manifest Validator
* Validates module.json against Foundry VTT requirements
*/
const fs = require('fs');
const path = require('path');
const manifestPath = path.join(__dirname, 'packages', 'foundry-module', 'module.json');
console.log('š Validating Foundry Module Manifest...\n');
// Required fields according to Foundry VTT documentation
const requiredFields = [
'id', 'title', 'description', 'version', 'compatibility', 'authors'
];
const recommendedFields = [
'url', 'bugs', 'changelog', 'readme', 'license', 'manifest', 'download'
];
const unsupportedFields = [
'keywords' // Not supported in Foundry VTT manifests
];
try {
// Read and parse manifest
const manifestContent = fs.readFileSync(manifestPath, 'utf8');
const manifest = JSON.parse(manifestContent);
console.log(`š Module: ${manifest.title} (${manifest.id})`);
console.log(`š¦ Version: ${manifest.version}`);
console.log(`šÆ Compatibility: ${manifest.compatibility.minimum}-${manifest.compatibility.maximum}\n`);
let errors = [];
let warnings = [];
// Check required fields
console.log('ā
Required Fields:');
requiredFields.forEach(field => {
if (manifest[field] === undefined) {
errors.push(`Missing required field: ${field}`);
console.log(` ā ${field}: MISSING`);
} else {
console.log(` ā
${field}: OK`);
}
});
console.log('\nš Recommended Fields:');
recommendedFields.forEach(field => {
if (manifest[field] === undefined) {
warnings.push(`Missing recommended field: ${field}`);
console.log(` ā ļø ${field}: MISSING`);
} else {
console.log(` ā
${field}: OK`);
}
});
// Validate specific field formats
console.log('\nš Field Validation:');
// ID validation
if (manifest.id && !/^[a-z0-9-]+$/.test(manifest.id)) {
errors.push('ID should only contain lowercase letters, numbers, and hyphens');
console.log(' ā id: Invalid format (should be lowercase, alphanumeric, hyphens only)');
} else {
console.log(' ā
id: Valid format');
}
// Version validation
if (manifest.version && !/^\d+\.\d+\.\d+/.test(manifest.version)) {
warnings.push('Version should follow semantic versioning (x.y.z)');
console.log(' ā ļø version: Should follow semantic versioning');
} else {
console.log(' ā
version: Valid format');
}
// Compatibility validation
if (manifest.compatibility) {
const { minimum, verified, maximum } = manifest.compatibility;
if (!minimum || !verified) {
errors.push('Compatibility must include minimum and verified versions');
console.log(' ā compatibility: Missing minimum or verified versions');
} else {
console.log(' ā
compatibility: Valid');
}
}
// URL validation
const urlFields = ['url', 'bugs', 'changelog', 'readme', 'license', 'manifest', 'download'];
urlFields.forEach(field => {
if (manifest[field] && !manifest[field].startsWith('http')) {
warnings.push(`${field} should be a valid HTTP/HTTPS URL`);
console.log(` ā ļø ${field}: Should be HTTP/HTTPS URL`);
} else if (manifest[field]) {
console.log(` ā
${field}: Valid URL`);
}
});
// File existence validation
console.log('\nš File Existence:');
if (manifest.esmodules) {
manifest.esmodules.forEach(file => {
const filePath = path.join(__dirname, 'packages', 'foundry-module', file);
if (fs.existsSync(filePath)) {
console.log(` ā
${file}: EXISTS`);
} else {
errors.push(`Missing esmodule file: ${file}`);
console.log(` ā ${file}: MISSING`);
}
});
}
if (manifest.styles) {
manifest.styles.forEach(file => {
const filePath = path.join(__dirname, 'packages', 'foundry-module', file);
if (fs.existsSync(filePath)) {
console.log(` ā
${file}: EXISTS`);
} else {
errors.push(`Missing style file: ${file}`);
console.log(` ā ${file}: MISSING`);
}
});
}
if (manifest.languages) {
manifest.languages.forEach(lang => {
const filePath = path.join(__dirname, 'packages', 'foundry-module', lang.path);
if (fs.existsSync(filePath)) {
console.log(` ā
${lang.path}: EXISTS`);
} else {
errors.push(`Missing language file: ${lang.path}`);
console.log(` ā ${lang.path}: MISSING`);
}
});
}
// Check for unsupported fields
console.log('\nš« Unsupported Fields:');
const manifestKeys = Object.keys(manifest);
let hasUnsupported = false;
unsupportedFields.forEach(field => {
if (manifestKeys.includes(field)) {
errors.push(`Unsupported field (will cause Foundry warnings): ${field}`);
console.log(` ā ${field}: UNSUPPORTED (remove this field)`);
hasUnsupported = true;
}
});
if (!hasUnsupported) {
console.log(' ā
No unsupported fields detected');
}
// Summary
console.log('\nš Validation Summary:');
console.log(` ā
Errors: ${errors.length}`);
console.log(` ā ļø Warnings: ${warnings.length}`);
if (errors.length > 0) {
console.log('\nā ERRORS:');
errors.forEach(error => console.log(` ā¢ ${error}`));
}
if (warnings.length > 0) {
console.log('\nā ļø WARNINGS:');
warnings.forEach(warning => console.log(` ā¢ ${warning}`));
}
if (errors.length === 0) {
console.log('\nš Manifest validation PASSED! Ready for Foundry VTT.');
} else {
console.log('\nš„ Manifest validation FAILED! Fix errors before release.');
process.exit(1);
}
} catch (error) {
console.error('ā Failed to validate manifest:', error.message);
process.exit(1);
}