The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
import fs from 'fs';
import path from 'path';
import {
DEFAULT_LANGUAGE,
SUPPORTED_LANGUAGES,
} from '../navigation/supported-languages';
// Crowdin parses `<foo>` in prose as a tag and mangles it in translations; `{foo}` survives.
const DOCS_ROOT = path.resolve(__dirname, '..');
const IGNORED_DIRECTORIES = ['node_modules', 'images', 'scripts'];
// Translated pages are Crowdin output; their placeholders are fixed at the source.
const TRANSLATED_DIRECTORIES = SUPPORTED_LANGUAGES.filter(
(language) => language !== DEFAULT_LANGUAGE,
).map((language) => path.join(DOCS_ROOT, language));
const HTML_ELEMENTS = [
'abbr',
'article',
'aside',
'blockquote',
'br',
'button',
'cite',
'code',
'dd',
'del',
'details',
'div',
'dl',
'dt',
'em',
'figcaption',
'figure',
'footer',
'form',
'h1',
'h2',
'h3',
'h4',
'h5',
'h6',
'header',
'hr',
'iframe',
'img',
'input',
'ins',
'kbd',
'label',
'li',
'main',
'mark',
'nav',
'ol',
'option',
'picture',
'pre',
'samp',
'section',
'select',
'small',
'source',
'span',
'strong',
'sub',
'summary',
'sup',
'table',
'tbody',
'td',
'textarea',
'tfoot',
'th',
'thead',
'tr',
'ul',
'var',
'video',
];
const PLACEHOLDER_PATTERN = /<([a-z][a-z0-9_-]+)>/g;
const URL_PREFIX_PATTERN = /https?:\/\/$/;
export type MdxViolation = {
line: number;
column: number;
text: string;
name: string;
};
type Range = {
start: number;
end: number;
};
const FENCE_LINE_PATTERN = /^\s*(`{3,})/;
// A fence closes only on a run at least as long as its opener (CommonMark).
const getFencedCodeRanges = (text: string): Range[] => {
const ranges: Range[] = [];
const lines = text.split('\n');
let lineStart = 0;
let openStart: number | null = null;
let openLength = 0;
for (const line of lines) {
const fence = FENCE_LINE_PATTERN.exec(line);
if (openStart === null) {
if (fence) {
openStart = lineStart;
openLength = fence[1].length;
}
} else if (
fence &&
fence[1].length >= openLength &&
line.slice(fence[0].length).trim() === ''
) {
ranges.push({ start: openStart, end: lineStart + line.length });
openStart = null;
}
lineStart += line.length + 1;
}
return ranges;
};
const isInsideRange = (position: number, ranges: Range[]) =>
ranges.some((range) => position >= range.start && position < range.end);
// Paired per line: a running counter would let one unpaired backtick suppress every later finding.
const getInlineCodeRanges = (text: string, fencedRanges: Range[]): Range[] => {
const ranges: Range[] = [];
let lineStart = 0;
for (const line of text.split('\n')) {
const runs: { start: number; length: number }[] = [];
for (const match of line.matchAll(/`+/g)) {
const start = lineStart + match.index;
if (!isInsideRange(start, fencedRanges)) {
runs.push({ start, length: match[0].length });
}
}
const unclosed: typeof runs = [];
for (const run of runs) {
const openerIndex = unclosed.findIndex(
(candidate) => candidate.length === run.length,
);
if (openerIndex === -1) {
unclosed.push(run);
continue;
}
ranges.push({
start: unclosed[openerIndex].start,
end: run.start + run.length,
});
unclosed.splice(0, openerIndex + 1);
}
lineStart += line.length + 1;
}
return ranges;
};
const getLineAndColumn = (text: string, position: number) => {
const precedingText = text.slice(0, position);
const lines = precedingText.split('\n');
return {
line: lines.length,
column: lines[lines.length - 1].length + 1,
};
};
export const findAngleBracketPlaceholders = (text: string): MdxViolation[] => {
const fencedRanges = getFencedCodeRanges(text);
const inlineCodeRanges = getInlineCodeRanges(text, fencedRanges);
const violations: MdxViolation[] = [];
for (const match of text.matchAll(PLACEHOLDER_PATTERN)) {
const name = match[1];
const position = match.index;
const isUrlPlaceholder = URL_PREFIX_PATTERN.test(text.slice(0, position));
if (HTML_ELEMENTS.includes(name) && !isUrlPlaceholder) {
continue;
}
if (
isInsideRange(position, fencedRanges) ||
isInsideRange(position, inlineCodeRanges)
) {
continue;
}
violations.push({
...getLineAndColumn(text, position),
text: match[0],
name,
});
}
return violations;
};
const collectMdxFiles = (directory: string, collected: string[] = []) => {
for (const entry of fs.readdirSync(directory, { withFileTypes: true })) {
const entryPath = path.join(directory, entry.name);
if (
IGNORED_DIRECTORIES.includes(entry.name) ||
TRANSLATED_DIRECTORIES.includes(entryPath)
) {
continue;
}
if (entry.isDirectory()) {
collectMdxFiles(entryPath, collected);
} else if (entry.name.endsWith('.mdx')) {
collected.push(entryPath);
}
}
return collected;
};
const main = () => {
const files = collectMdxFiles(DOCS_ROOT);
let violationCount = 0;
for (const file of files) {
const violations = findAngleBracketPlaceholders(
fs.readFileSync(file, 'utf8'),
);
for (const violation of violations) {
const relativePath = path.relative(DOCS_ROOT, file);
console.error(
`${relativePath}:${violation.line}:${violation.column} ${violation.text} reads as a tag in Crowdin, use {${violation.name}} instead`,
);
}
violationCount += violations.length;
}
if (violationCount > 0) {
console.error(
`\n${violationCount} angle bracket placeholder(s) found in ${files.length} MDX files.`,
);
process.exit(1);
}
console.log(`No angle bracket placeholders in ${files.length} MDX files.`);
};
if (require.main === module) {
main();
}