Notes/src/transform_api_docs.js

78 lines
2.9 KiB
JavaScript
Raw Normal View History

2023-01-05 16:52:39 +01:00
const sanitizeHtml = require('sanitize-html');
function transform(content) {
2023-01-05 23:38:41 +01:00
const result = sanitizeHtml(content, {
2023-01-05 16:52:39 +01:00
allowedTags: [
2023-01-05 23:38:41 +01:00
'h4', 'h5', 'h6', 'blockquote', 'p', 'a', 'ul', 'ol',
2023-01-05 16:52:39 +01:00
'li', 'b', 'i', 'strong', 'em', 'strike', 's', 'del', 'abbr', 'code', 'hr', 'br', 'div',
'table', 'thead', 'caption', 'tbody', 'tr', 'th', 'td', 'pre', 'section', 'img',
'figure', 'figcaption', 'span', 'label', 'input',
],
2023-01-05 23:38:41 +01:00
nonTextTags: [ 'style', 'script', 'textarea', 'option', 'h1', 'h2', 'h3', 'nav' ],
2023-01-05 16:52:39 +01:00
allowedAttributes: {
'a': [ 'href', 'class', 'data-note-path' ],
'img': [ 'src' ],
'section': [ 'class', 'data-note-id' ],
'figure': [ 'class' ],
'span': [ 'class', 'style' ],
'label': [ 'class' ],
'input': [ 'class', 'type', 'disabled' ],
'code': [ 'class' ],
'ul': [ 'class' ],
'table': [ 'class' ],
'en-media': [ 'hash' ]
},
allowedSchemes: ['http', 'https', 'ftp', 'mailto', 'data', 'evernote'],
2023-01-05 23:38:41 +01:00
transformTags: {
// 'h5': sanitizeHtml.simpleTransform('strong', {}, false),
'table': sanitizeHtml.simpleTransform('table', {}, false)
},
2023-01-05 16:52:39 +01:00
});
2023-01-05 23:38:41 +01:00
return result.replace(/<table>/gi, '<figure class="table"><table>')
.replace(/<\/table>/gi, '</table></figure>')
.replace(/<div><\/div>/gi, '')
.replace(/<h5>/gi, '<p><strong>')
.replace(/<\/h5>/gi, '</strong></p>')
.replace(/<h4>/gi, '<h2>')
.replace(/<\/h4>/gi, '</h2>')
.replace(/<span class="signature-attributes">opt<\/span>/gi, '')
.replace(/<h2>.*new (BackendScriptApi|FrontendScriptApi).*<\/h2>/gi, '')
;
2023-01-05 16:52:39 +01:00
}
const fs = require("fs");
const path = require("path");
2023-01-05 23:38:41 +01:00
const html = require("html");
2023-01-05 16:52:39 +01:00
let sourceFiles = [];
const getFilesRecursively = (directory) => {
const filesInDirectory = fs.readdirSync(directory);
for (const file of filesInDirectory) {
const absolute = path.join(directory, file);
if (fs.statSync(absolute).isDirectory()) {
getFilesRecursively(absolute);
2023-01-05 23:38:41 +01:00
} else if (file.endsWith('.html')) {
2023-01-05 16:52:39 +01:00
sourceFiles.push(absolute);
}
}
};
2023-01-05 23:38:41 +01:00
getFilesRecursively('./tmp/api_docs');
2023-01-05 16:52:39 +01:00
for (const sourcePath of sourceFiles) {
2023-01-05 23:38:41 +01:00
const content = fs.readFileSync(sourcePath).toString();
2023-01-05 16:52:39 +01:00
const transformedContent = transform(content);
2023-01-05 23:38:41 +01:00
const prettifiedContent = html.prettyPrint(transformedContent, {indent_size: 2});
const filteredContent = prettifiedContent
.replace(/<br \/>Documentation generated by <a href="https:\/\/github.com\/jsdoc\/jsdoc">[^<]+<\/a>/gi, '')
.replace(/JSDoc: (Class|Module): [a-z]+/gi, '');
2023-01-05 16:52:39 +01:00
2023-01-05 23:38:41 +01:00
const destPath = sourcePath.replaceAll("tmp", "docs");
2023-01-05 16:52:39 +01:00
fs.mkdirSync(path.dirname(destPath), {recursive: true});
2023-01-05 23:38:41 +01:00
fs.writeFileSync(destPath, filteredContent.trim());
2023-01-05 16:52:39 +01:00
console.log(destPath);
2023-01-05 23:38:41 +01:00
}