import shim from '@joplin/lib/shim'; import * as os from 'os'; import { readFile } from 'fs/promises'; import { filename } from '@joplin/lib/path-utils'; import { dirname } from 'path'; import HtmlToMd, { ParseOptions } from '@joplin/lib/HtmlToMd'; import MdToHtml from '@joplin/renderer/MdToHtml'; describe('HtmlToMd', () => { it('should convert from Html to Markdown', (async () => { const basePath = `${__dirname}/html_to_md`; const files = await shim.fsDriver().readDirStats(basePath); const htmlToMd = new HtmlToMd(); for (let i = 0; i < files.length; i++) { const htmlFilename = files[i].path; if (htmlFilename.indexOf('.html') < 0) continue; const htmlPath = `${basePath}/${htmlFilename}`; const mdPath = `${basePath}/${filename(htmlFilename)}.md`; // if (htmlFilename !== 'anchor_same_title_and_url.html') continue; // if (htmlFilename.indexOf('image_preserve_size') !== 0) continue; const htmlToMdOptions: ParseOptions = {}; if (htmlFilename === 'anchor_local.html') { // Normally the list of anchor names in the document are retrieved from the HTML code // This is straightforward when the document is still in DOM format, as with the clipper, // but otherwise it would need to be somehow parsed out from the HTML. Here we just // hard code the anchors that we know are in the file. htmlToMdOptions.anchorNames = ['first', 'second', 'fourth']; } if (htmlFilename.indexOf('image_preserve_size') === 0) { htmlToMdOptions.preserveImageTagsWithSize = true; } if (htmlFilename.indexOf('preserve_nested_tables') === 0) { htmlToMdOptions.preserveNestedTables = true; } if (htmlFilename.indexOf('text_color') === 0) { htmlToMdOptions.preserveColorStyles = true; } if (htmlFilename.indexOf('table_with') === 0 || htmlFilename.indexOf('table_default') === 0) { htmlToMdOptions.preserveTableStyles = true; } const html = await readFile(htmlPath, 'utf8'); let expectedMd = await readFile(mdPath, 'utf8'); let actualMd = await htmlToMd.parse(`
Item 1
Item 2
Item 3
First
Second
'; // Without collapseMultipleBlankLines, multiple blank lines are preserved const looseResult = htmlToMd.parse(html, { collapseMultipleBlankLines: false }); expect(looseResult).toContain('\n\n \n'); // With collapseMultipleBlankLines, multiple blank lines are collapsed into one const collapsedResult = htmlToMd.parse(html, { collapseMultipleBlankLines: true }); expect(collapsedResult).not.toContain('\n\n\n'); expect(collapsedResult).not.toContain('\n\n \n'); // Verify that a single blank line is preserved (not fully removed) expect(collapsedResult).toContain('\n\n'); }); it('should not re-read the rows of a table for every row', async () => { // Under domino, each access to `table.rows` walks the whole table, so reading it once per row made // converting large tables quadratic: https://github.com/laurent22/joplin/issues/16894 const resolveFrom = (moduleName: string, fromPath: string) => require.resolve(moduleName, { paths: [dirname(fromPath)] }); const domino: { createDocument: (html: string)=> Document } = require(resolveFrom('@mixmark-io/domino', resolveFrom('@joplin/turndown', require.resolve('@joplin/lib/HtmlToMd')))); const rowCount = 100; const rows = Array.from({ length: rowCount }, (_, i) => `| A | B | C |
|---|
a
b', 'a\n\nb'], ['line 1\n\n\nline 2', '```\nline 1\n\n\nline 2\n```'],
])('should join the Markdown of child elements: %j', (html, expected) => {
expect(new HtmlToMd().parse(html)).toBe(expected);
});
it.each([
['inline code ending with a space at the end of a heading', 'npm install a