self-hosted/joplin
1
0
Fork 0
mirror of https://github.com/laurent22/joplin.git synced 2025-01-02 12:47:41 +02:00
Code Issues Releases Activity

Chore: Mobile: Tests: Markdown math tests: Fix code formatting (#7387)

Browse Source
This commit is contained in:
Henry Heino 2022-12-07 12:10:02 -08:00 committed by GitHub
parent 33038e621b
commit da01dc882b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
packages/app-mobile/components/NoteEditor/CodeMirror/markdownMathParser.test.ts
View File

@ -1,13 +1,13 @@
import { markdown } from '@codemirror/lang-markdown';
import { ensureSyntaxTree } from '@codemirror/language'; import { ensureSyntaxTree } from '@codemirror/language';
import { SyntaxNode } from '@lezer/common'; import { SyntaxNode } from '@lezer/common';
import { EditorState } from '@codemirror/state'; import { EditorState } from '@codemirror/state';
import { blockMathTagName, inlineMathContentTagName, inlineMathTagName, MarkdownMathExtension } from './markdownMathParser'; import { blockMathTagName, inlineMathContentTagName, inlineMathTagName, MarkdownMathExtension } from './markdownMathParser';
import { GFM as GithubFlavoredMarkdownExt } from '@lezer/markdown'; import { GFM as GithubFlavoredMarkdownExt } from '@lezer/markdown';
import { markdown } from '@codemirror/lang-markdown';
const syntaxTreeCreateTimeout = 100; // ms const syntaxTreeCreateTimeout = 100; // ms
/** Create an EditorState with markdown extensions */ // Creates an EditorState with math and markdown extensions
const createEditorState = (initialText: string): EditorState => { const createEditorState = (initialText: string): EditorState => {
return EditorState.create({ return EditorState.create({
doc: initialText, doc: initialText,
@ -19,10 +19,8 @@ const createEditorState = (initialText: string): EditorState => {
}); });
}; };
/** // Returns a list of all nodes with the given name in the given editor's syntax tree.
* Returns a list of all nodes with the given name in the given editor's syntax tree. // Attempts to create the syntax tree if it doesn't exist.
* Attempts to create the syntax tree if it doesn't exist.
*/
const findNodesWithName = (editor: EditorState, nodeName: string) => { const findNodesWithName = (editor: EditorState, nodeName: string) => {
const result: SyntaxNode[] = []; const result: SyntaxNode[] = [];
ensureSyntaxTree(editor, syntaxTreeCreateTimeout)?.iterate({ ensureSyntaxTree(editor, syntaxTreeCreateTimeout)?.iterate({
@ -36,8 +34,8 @@ const findNodesWithName = (editor: EditorState, nodeName: string) => {
return result; return result;
}; };
describe('Inline parsing', () => { describe('markdownMathParser', () => {
it('Document with just a math region', () => { it('should parse inline math that contains space characters, numbers, and symbols', () => {
const documentText = '$3 + 3$'; const documentText = '$3 + 3$';
const editor = createEditorState(documentText); const editor = createEditorState(documentText);
const inlineMathNodes = findNodesWithName(editor, inlineMathTagName); const inlineMathNodes = findNodesWithName(editor, inlineMathTagName);
@ -53,7 +51,7 @@ describe('Inline parsing', () => {
expect(inlineMathContentNodes.length).toBe(0); expect(inlineMathContentNodes.length).toBe(0);
}); });
it('Inline math mixed with text', () => { it('should parse comment within multi-word inline math', () => {
const beforeMath = '# Testing!\n\nThis is a test of '; const beforeMath = '# Testing!\n\nThis is a test of ';
const mathRegion = '$\\TeX % TeX Comment!$'; const mathRegion = '$\\TeX % TeX Comment!$';
const afterMath = ' formatting.'; const afterMath = ' formatting.';
@ -72,7 +70,7 @@ describe('Inline parsing', () => {
expect(inlineMathNodes[0].to).toBe(beforeMath.length + mathRegion.length); expect(inlineMathNodes[0].to).toBe(beforeMath.length + mathRegion.length);
}); });
it('Inline math with no ending $ in a block', () => { it('shouldn\'t start inline math if there is no ending $', () => {
const documentText = 'This is a $test\n\nof inline math$...'; const documentText = 'This is a $test\n\nof inline math$...';
const editor = createEditorState(documentText); const editor = createEditorState(documentText);
const inlineMathNodes = findNodesWithName(editor, inlineMathTagName); const inlineMathNodes = findNodesWithName(editor, inlineMathTagName);
@ -81,21 +79,19 @@ describe('Inline parsing', () => {
expect(inlineMathNodes.length).toBe(0); expect(inlineMathNodes.length).toBe(0);
}); });
it('Shouldn\'t start if block would have spaces just inside', () => { it('shouldn\'t start if math would have a space just after the $', () => {
const documentText = 'This is a $ test of inline math$...\n\n$Testing... $...'; const documentText = 'This is a $ test of inline math$...\n\n$Testing... $...';
const editor = createEditorState(documentText); const editor = createEditorState(documentText);
expect(findNodesWithName(editor, inlineMathTagName).length).toBe(0); expect(findNodesWithName(editor, inlineMathTagName).length).toBe(0);
}); });
it('Shouldn\'t start if $ is escaped', () => { it('shouldn\'t start inline math if $ is escaped', () => {
const documentText = 'This is a \\$test of inline math$...'; const documentText = 'This is a \\$test of inline math$...';
const editor = createEditorState(documentText); const editor = createEditorState(documentText);
expect(findNodesWithName(editor, inlineMathTagName).length).toBe(0); expect(findNodesWithName(editor, inlineMathTagName).length).toBe(0);
}); });
});
describe('Block math tests', () => { it('should correctly parse document containing just block math', () => {
it('Document with just block math', () => {
const documentText = '$$\n\t\\{ 1, 1, 2, 3, 5, ... \\}\n$$'; const documentText = '$$\n\t\\{ 1, 1, 2, 3, 5, ... \\}\n$$';
const editor = createEditorState(documentText); const editor = createEditorState(documentText);
const inlineMathNodes = findNodesWithName(editor, inlineMathTagName); const inlineMathNodes = findNodesWithName(editor, inlineMathTagName);
@ -108,7 +104,7 @@ describe('Block math tests', () => {
expect(blockMathNodes[0].to).toBe(documentText.length); expect(blockMathNodes[0].to).toBe(documentText.length);
}); });
it('Block math with comment', () => { it('should correctly parse comment in block math', () => {
const startingText = '$$ % Testing...\n\t\\text{Test.}\n$$'; const startingText = '$$ % Testing...\n\t\\text{Test.}\n$$';
const afterMath = '\nTest.'; const afterMath = '\nTest.';
const editor = createEditorState(startingText + afterMath); const editor = createEditorState(startingText + afterMath);
@ -129,7 +125,7 @@ describe('Block math tests', () => {
}); });
}); });
it('Block math without an ending tag', () => { it('should extend block math without ending tag to end of document', () => {
const beforeMath = '# Testing...\n\n'; const beforeMath = '# Testing...\n\n';
const documentText = `${beforeMath}$$\n\t\\text{Testing...}\n\n\t3 + 3 = 6`; const documentText = `${beforeMath}$$\n\t\\text{Testing...}\n\n\t3 + 3 = 6`;
const editor = createEditorState(documentText); const editor = createEditorState(documentText);
@ -140,7 +136,7 @@ describe('Block math tests', () => {
expect(blockMathNodes[0].to).toBe(documentText.length); expect(blockMathNodes[0].to).toBe(documentText.length);
}); });
it('Single-line declaration of block math', () => { it('should parse block math declared on a single line', () => {
const documentText = '$$ Test. $$'; const documentText = '$$ Test. $$';
const editor = createEditorState(documentText); const editor = createEditorState(documentText);
const blockMathNodes = findNodesWithName(editor, blockMathTagName); const blockMathNodes = findNodesWithName(editor, blockMathTagName);