Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

chore: lint code snippet languages (#24381)

Browse source 
Follow-up to https://github.com/microsoft/playwright/pull/24367.
This commit is contained in:
Max Schmitt 2023-07-25 00:32:46 +02:00 committed by GitHub
parent 4c8912f74e
commit c4ecdcfc22
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
utils/doclint/cli.js
View file

@ -125,7 +125,7 @@ async function run() {
writeAssumeNoop(devicesDescriptorsSourceFile, JSON.stringify(devicesDescriptors, null, 2), dirtyFiles); writeAssumeNoop(devicesDescriptorsSourceFile, JSON.stringify(devicesDescriptors, null, 2), dirtyFiles);
} }
// Validate links // Validate links/code snippet langs
{ {
const langs = ['js', 'java', 'python', 'csharp']; const langs = ['js', 'java', 'python', 'csharp'];
const documentationRoot = path.join(PROJECT_DIR, 'docs', 'src'); const documentationRoot = path.join(PROJECT_DIR, 'docs', 'src');
@ -174,6 +174,34 @@ async function run() {
// Validate links. // Validate links.
{ {
md.visitAll(rootNode, node => { md.visitAll(rootNode, node => {
{
if (node.type === 'code') {
const allowedCodeLangs = new Set([
'csharp',
'java',
'js',
'ts',
'python',
'py',
'java',
'powershell',
'batch',
'ini',
'txt',
'html',
'xml',
'yml',
'yaml',
'json',
'groovy',
'html',
'bash',
'sh',
]);
if (!allowedCodeLangs.has(node.codeLang.split(' ')[0]))
throw new Error(`${path.relative(PROJECT_DIR, filePath)} contains code block with invalid code block language ${node.codeLang}`);
}
}
if (!node.text) if (!node.text)
return; return;
for (const [, mdLinkName, mdLink] of node.text.matchAll(/\[([\w\s\d]+)\]\((.*?)\)/g)) { for (const [, mdLinkName, mdLink] of node.text.matchAll(/\[([\w\s\d]+)\]\((.*?)\)/g)) {