3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-15 10:07:33 +02:00
Code Issues Projects Releases Packages Wiki Activity

refactor: capitalize comments (#7188)

Browse source 
* refactor: capitalize comments

* revert...
This commit is contained in:
Joshua Chen 2022-04-17 16:39:11 +08:00 • committed by GitHub
parent 200009008b
commit fa1ce230ea
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
99 changed files with 241 additions and 350 deletions
Download patch file Download diff file Expand all files Collapse all files

11
packages/docusaurus-theme-common/src/utils/codeBlockUtils.ts
View file

@ -30,14 +30,14 @@ const magicCommentDirectives = [
];
function getCommentPattern(languages: CommentType[]) {
// to be more reliable, the opening and closing comment must match
// To be more reliable, the opening and closing comment must match
const commentPattern = languages
.map((lang) => {
const {start, end} = commentPatterns[lang];
return `(?:${start}\\s*(${magicCommentDirectives.join('|')})\\s*${end})`;
})
.join('|');
// white space is allowed, but otherwise it should be on it's own line
// White space is allowed, but otherwise it should be on it's own line
return new RegExp(`^\\s*(?:${commentPattern})\\s*$`);
}
@ -70,7 +70,7 @@ function getAllMagicCommentDirectiveStyles(lang: string) {
return getCommentPattern(['html', 'jsx', 'bash']);
default:
// all comment types
// All comment types
return getCommentPattern(Object.keys(commentPatterns) as CommentType[]);
}
}
@ -139,16 +139,15 @@ export function parseLines(
return {highlightLines: [], code};
}
const directiveRegex = getAllMagicCommentDirectiveStyles(language);
// go through line by line
// Go through line by line
const lines = code.split('\n');
let highlightBlockStart: number;
let highlightRange = '';
// loop through lines
for (let lineNumber = 0; lineNumber < lines.length; ) {
const line = lines[lineNumber]!;
const match = line.match(directiveRegex);
if (!match) {
// lines without directives are unchanged
// Lines without directives are unchanged
lineNumber += 1;
continue;
}