|
| 1 | +/* |
| 2 | + * SPDX-FileCopyrightText: 2025 SAP Spartacus team <[email protected]> |
| 3 | + * |
| 4 | + * SPDX-License-Identifier: Apache-2.0 |
| 5 | + */ |
| 6 | + |
| 7 | +import * as fs from 'fs-extra'; |
| 8 | + |
| 9 | +const MAX_FILE_SIZE = 50 * 1024; // 50 KB limit |
| 10 | +const BANNED_KEYS = [ |
| 11 | + '<script', |
| 12 | + 'onerror', |
| 13 | + 'onload', |
| 14 | + 'onclick', |
| 15 | + 'javascript:', |
| 16 | + '__proto__', |
| 17 | + 'constructor', |
| 18 | + 'eval', |
| 19 | +]; |
| 20 | +const NOT_ALLOWED_VALUE_REGEX = |
| 21 | + /^[{\[](?:[,:{}\[\]0-9.\-+Eaeflnr-u \n\r\t]|"(?:[^"\\]|\\.)*")*[}\]]$/u; |
| 22 | + |
| 23 | +export function validateJson(filePath: string) { |
| 24 | + const fileSize = fs.statSync(filePath).size; |
| 25 | + |
| 26 | + if (fileSize > MAX_FILE_SIZE) { |
| 27 | + throw new Error(`File ${filePath} exceeds size limit (${fileSize} bytes).`); |
| 28 | + } |
| 29 | + |
| 30 | + const content = fs.readFileSync(filePath, 'utf8'); |
| 31 | + |
| 32 | + let parsedJson; |
| 33 | + try { |
| 34 | + parsedJson = JSON.parse(content); |
| 35 | + } catch (error) { |
| 36 | + throw new Error(`Invalid JSON format in ${filePath}`); |
| 37 | + } |
| 38 | + |
| 39 | + const traverse = (jsonData: any) => { |
| 40 | + for (const key in jsonData) { |
| 41 | + if (typeof jsonData[key] === 'object' && jsonData[key] !== null) { |
| 42 | + traverse(jsonData[key]); |
| 43 | + } else { |
| 44 | + const translation = jsonData[key]; |
| 45 | + |
| 46 | + if (typeof translation !== 'string') { |
| 47 | + throw new Error(`Translation entry is not a string.`); |
| 48 | + } |
| 49 | + |
| 50 | + if ( |
| 51 | + NOT_ALLOWED_VALUE_REGEX.test(translation) || |
| 52 | + NOT_ALLOWED_VALUE_REGEX.test(key) |
| 53 | + ) { |
| 54 | + throw new Error( |
| 55 | + `Unallowed char in ${filePath}: ${key} '${translation}'.` |
| 56 | + ); |
| 57 | + } |
| 58 | + |
| 59 | + if ( |
| 60 | + BANNED_KEYS.some( |
| 61 | + (bannedKey) => |
| 62 | + translation.includes(bannedKey) || key.includes(bannedKey) |
| 63 | + ) |
| 64 | + ) { |
| 65 | + throw new Error( |
| 66 | + `Forbidden char in ${filePath}: ${key} '${translation}'.` |
| 67 | + ); |
| 68 | + } |
| 69 | + } |
| 70 | + } |
| 71 | + }; |
| 72 | + traverse(parsedJson); |
| 73 | +} |
| 74 | + |
| 75 | +function getJsonFiles(dir: any) { |
| 76 | + let results: any[] = []; |
| 77 | + const list = fs.readdirSync(dir); |
| 78 | + |
| 79 | + list.forEach((file) => { |
| 80 | + const filePath = `${dir}/${file}`; |
| 81 | + const stat = fs.statSync(filePath); |
| 82 | + |
| 83 | + if (stat && stat.isDirectory()) { |
| 84 | + results = results.concat(getJsonFiles(filePath)); |
| 85 | + } else if (filePath.includes('translations') && file.endsWith('.json')) { |
| 86 | + results.push(filePath); |
| 87 | + } |
| 88 | + }); |
| 89 | + |
| 90 | + return results; |
| 91 | +} |
| 92 | + |
| 93 | +function validateAllTranslations() { |
| 94 | + /* eslint-disable-next-line no-console */ |
| 95 | + console.log('Validating translation files...'); |
| 96 | + |
| 97 | + const basePaths: string[] = ['feature-libs', 'integration-libs', 'projects']; |
| 98 | + |
| 99 | + basePaths.forEach((basePath: string) => { |
| 100 | + const jsonFilePaths = getJsonFiles(basePath); |
| 101 | + |
| 102 | + jsonFilePaths.forEach((path: string) => { |
| 103 | + validateJson(path); |
| 104 | + }); |
| 105 | + }); |
| 106 | + |
| 107 | + /* eslint-disable-next-line no-console */ |
| 108 | + console.log('✅ All translations passed validation!'); |
| 109 | +} |
| 110 | + |
| 111 | +try { |
| 112 | + validateAllTranslations(); |
| 113 | +} catch (error) { |
| 114 | + /* eslint-disable-next-line no-console */ |
| 115 | + console.error('❌ Validation failed: ', error); |
| 116 | + process.exit(1); // Exit with error status to stop the build |
| 117 | +} |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments