misskey/test/mfm.ts

/*
 * Tests of MFM
 */

import * as assert from 'assert';

import analyze from '../src/mfm/parse';
import toHtml from '../src/mfm/html';
import syntaxhighlighter from '../src/mfm/parse/core/syntax-highlighter';

describe('Text', () => {
	it('can be analyzed', () => {
		const tokens = analyze('@himawari @hima_sub@namori.net お腹ペコい :cat: #yryr');
		assert.deepEqual([
			{ type: 'mention', content: '@himawari', canonical: '@himawari', username: 'himawari', host: null },
			{ type: 'text', content: ' ' },
			{ type: 'mention', content: '@hima_sub@namori.net', canonical: '@hima_sub@namori.net', username: 'hima_sub', host: 'namori.net' },
			{ type: 'text', content: ' お腹ペコい ' },
			{ type: 'emoji', content: ':cat:', name: 'cat' },
			{ type: 'text', content: ' ' },
			{ type: 'hashtag', content: '#yryr', hashtag: 'yryr' }
		], tokens);
	});

	it('can be inverted', () => {
		const text = '@himawari @hima_sub@namori.net お腹ペコい :cat: #yryr';
		assert.equal(analyze(text).map(x => x.content).join(''), text);
	});

	describe('elements', () => {
		it('bold', () => {
			const tokens = analyze('**Strawberry** Pasta');
			assert.deepEqual([
				{ type: 'bold', content: '**Strawberry**', bold: 'Strawberry' },
				{ type: 'text', content: ' Pasta' }
			], tokens);
		});

		it('big', () => {
			const tokens = analyze('***Strawberry*** Pasta');
			assert.deepEqual([
				{ type: 'big', content: '***Strawberry***', big: 'Strawberry' },
				{ type: 'text', content: ' Pasta' }
			], tokens);
		});

		it('motion', () => {
			const tokens1 = analyze('(((Strawberry))) Pasta');
			assert.deepEqual([
				{ type: 'motion', content: '(((Strawberry)))', motion: 'Strawberry' },
				{ type: 'text', content: ' Pasta' }
			], tokens1);

			const tokens2 = analyze('<motion>Strawberry</motion> Pasta');
			assert.deepEqual([
				{ type: 'motion', content: '<motion>Strawberry</motion>', motion: 'Strawberry' },
				{ type: 'text', content: ' Pasta' }
			], tokens2);
		});

		describe('mention', () => {
			it('local', () => {
				const tokens = analyze('@himawari お腹ペコい');
				assert.deepEqual([
					{ type: 'mention', content: '@himawari', canonical: '@himawari', username: 'himawari', host: null },
					{ type: 'text', content: ' お腹ペコい' }
				], tokens);
			});

			it('remote', () => {
				const tokens = analyze('@hima_sub@namori.net お腹ペコい');
				assert.deepEqual([
					{ type: 'mention', content: '@hima_sub@namori.net', canonical: '@hima_sub@namori.net', username: 'hima_sub', host: 'namori.net' },
					{ type: 'text', content: ' お腹ペコい' }
				], tokens);
			});

			it('remote punycode', () => {
				const tokens = analyze('@hima_sub@xn--q9j5bya.xn--zckzah お腹ペコい');
				assert.deepEqual([
					{ type: 'mention', content: '@hima_sub@xn--q9j5bya.xn--zckzah', canonical: '@hima_sub@なもり.テスト', username: 'hima_sub', host: 'xn--q9j5bya.xn--zckzah' },
					{ type: 'text', content: ' お腹ペコい' }
				], tokens);
			});

			it('ignore', () => {
				const tokens = analyze('idolm@ster');
				assert.deepEqual([
					{ type: 'text', content: 'idolm@ster' }
				], tokens);

				const tokens2 = analyze('@a\n@b\n@c');
				assert.deepEqual([
					{ type: 'mention', content: '@a', canonical: '@a', username: 'a', host: null },
					{ type: 'text', content: '\n' },
					{ type: 'mention', content: '@b', canonical: '@b', username: 'b', host: null },
					{ type: 'text', content: '\n' },
					{ type: 'mention', content: '@c', canonical: '@c', username: 'c', host: null }
				], tokens2);

				const tokens3 = analyze('**x**@a');
				assert.deepEqual([
					{ type: 'bold', content: '**x**', bold: 'x' },
					{ type: 'mention', content: '@a', canonical: '@a', username: 'a', host: null }
				], tokens3);
			});
		});

		it('hashtag', () => {
			const tokens1 = analyze('Strawberry Pasta #alice');
			assert.deepEqual([
				{ type: 'text', content: 'Strawberry Pasta ' },
				{ type: 'hashtag', content: '#alice', hashtag: 'alice' }
			], tokens1);

			const tokens2 = analyze('Foo #bar, baz #piyo.');
			assert.deepEqual([
				{ type: 'text', content: 'Foo ' },
				{ type: 'hashtag', content: '#bar', hashtag: 'bar' },
				{ type: 'text', content: ', baz ' },
				{ type: 'hashtag', content: '#piyo', hashtag: 'piyo' },
				{ type: 'text', content: '.' }
			], tokens2);

			const tokens3 = analyze('#Foo!');
			assert.deepEqual([
				{ type: 'hashtag', content: '#Foo', hashtag: 'Foo' },
				{ type: 'text', content: '!' },
			], tokens3);
		});

		it('quote', () => {
			const tokens1 = analyze('> foo\nbar\nbaz');
			assert.deepEqual([
				{ type: 'quote', content: '> foo\nbar\nbaz', quote: 'foo\nbar\nbaz' }
			], tokens1);

			const tokens2 = analyze('before\n> foo\nbar\nbaz\n\nafter');
			assert.deepEqual([
				{ type: 'text', content: 'before' },
				{ type: 'quote', content: '\n> foo\nbar\nbaz\n\n', quote: 'foo\nbar\nbaz' },
				{ type: 'text', content: 'after' }
			], tokens2);

			const tokens3 = analyze('piyo> foo\nbar\nbaz');
			assert.deepEqual([
				{ type: 'text', content: 'piyo> foo\nbar\nbaz' }
			], tokens3);

			const tokens4 = analyze('> foo\n> bar\n> baz');
			assert.deepEqual([
				{ type: 'quote', content: '> foo\n> bar\n> baz', quote: 'foo\nbar\nbaz' }
			], tokens4);

			const tokens5 = analyze('"\nfoo\nbar\nbaz\n"');
			assert.deepEqual([
				{ type: 'quote', content: '"\nfoo\nbar\nbaz\n"', quote: 'foo\nbar\nbaz' }
			], tokens5);
		});

		describe('url', () => {
			it('simple', () => {
				const tokens = analyze('https://example.com');
				assert.deepEqual([{
					type: 'url',
					content: 'https://example.com',
					url: 'https://example.com'
				}], tokens);
			});

			it('ignore trailing period', () => {
				const tokens = analyze('https://example.com.');
				assert.deepEqual([{
					type: 'url',
					content: 'https://example.com',
					url: 'https://example.com'
				}, {
					type: 'text', content: '.'
				}], tokens);
			});

			it('with comma', () => {
				const tokens = analyze('https://example.com/foo?bar=a,b');
				assert.deepEqual([{
					type: 'url',
					content: 'https://example.com/foo?bar=a,b',
					url: 'https://example.com/foo?bar=a,b'
				}], tokens);
			});

			it('ignore trailing comma', () => {
				const tokens = analyze('https://example.com/foo, bar');
				assert.deepEqual([{
					type: 'url',
					content: 'https://example.com/foo',
					url: 'https://example.com/foo'
				}, {
					type: 'text', content: ', bar'
				}], tokens);
			});

			it('with brackets', () => {
				const tokens = analyze('https://example.com/foo(bar)');
				assert.deepEqual([{
					type: 'url',
					content: 'https://example.com/foo(bar)',
					url: 'https://example.com/foo(bar)'
				}], tokens);
			});

			it('ignore parent brackets', () => {
				const tokens = analyze('(https://example.com/foo)');
				assert.deepEqual([{
					type: 'text', content: '('
				}, {
					type: 'url',
					content: 'https://example.com/foo',
					url: 'https://example.com/foo'
				}, {
					type: 'text', content: ')'
				}], tokens);
			});

			it('ignore parent brackets with internal brackets', () => {
				const tokens = analyze('(https://example.com/foo(bar))');
				assert.deepEqual([{
					type: 'text', content: '('
				}, {
					type: 'url',
					content: 'https://example.com/foo(bar)',
					url: 'https://example.com/foo(bar)'
				}, {
					type: 'text', content: ')'
				}], tokens);
			});
		});

		it('link', () => {
			const tokens = analyze('[ひまさく](https://himasaku.net)');
			assert.deepEqual([{
				type: 'link',
				content: '[ひまさく](https://himasaku.net)',
				title: 'ひまさく',
				url: 'https://himasaku.net',
				silent: false
			}], tokens);
		});

		it('emoji', () => {
			const tokens1 = analyze(':cat:');
			assert.deepEqual([
				{ type: 'emoji', content: ':cat:', name: 'cat' }
			], tokens1);

			const tokens2 = analyze(':cat::cat::cat:');
			assert.deepEqual([
				{ type: 'emoji', content: ':cat:', name: 'cat' },
				{ type: 'emoji', content: ':cat:', name: 'cat' },
				{ type: 'emoji', content: ':cat:', name: 'cat' }
			], tokens2);

			const tokens3 = analyze('🍎');
			assert.deepEqual([
				{ type: 'emoji', content: '🍎', emoji: '🍎' }
			], tokens3);
		});

		it('block code', () => {
			const tokens = analyze('```\nvar x = "Strawberry Pasta";\n```');
			assert.equal(tokens[0].type, 'code');
			assert.equal(tokens[0].content, '```\nvar x = "Strawberry Pasta";\n```');
		});

		it('inline code', () => {
			const tokens = analyze('`var x = "Strawberry Pasta";`');
			assert.equal(tokens[0].type, 'inline-code');
			assert.equal(tokens[0].content, '`var x = "Strawberry Pasta";`');
		});

		it('math', () => {
			const fomula = 'x = {-b \\pm \\sqrt{b^2-4ac} \\over 2a}';
			const text = `\\(${fomula}\\)`;
			const tokens = analyze(text);
			assert.deepEqual([
				{ type: 'math', content: text, formula: fomula }
			], tokens);
		});

		it('search', () => {
			const tokens1 = analyze('a b c 検索');
			assert.deepEqual([
				{ type: 'search', content: 'a b c 検索', query: 'a b c' }
			], tokens1);

			const tokens2 = analyze('a b c Search');
			assert.deepEqual([
				{ type: 'search', content: 'a b c Search', query: 'a b c' }
			], tokens2);

			const tokens3 = analyze('a b c search');
			assert.deepEqual([
				{ type: 'search', content: 'a b c search', query: 'a b c' }
			], tokens3);

			const tokens4 = analyze('a b c SEARCH');
			assert.deepEqual([
				{ type: 'search', content: 'a b c SEARCH', query: 'a b c' }
			], tokens4);
		});

		it('title', () => {
			const tokens1 = analyze('【yee】\nhaw');
			assert.deepEqual(
				{ type: 'title', content: '【yee】\n', title: 'yee' }
				, tokens1[0]);

			const tokens2 = analyze('[yee]\nhaw');
			assert.deepEqual(
				{ type: 'title', content: '[yee]\n', title: 'yee' }
				, tokens2[0]);

			const tokens3 = analyze('a [a]\nb [b]\nc [c]');
			assert.deepEqual(
				{ type: 'text', content: 'a [a]\nb [b]\nc [c]' }
				, tokens3[0]);

			const tokens4 = analyze('foo\n【bar】\nbuzz');
			assert.deepEqual([
				{ type: 'text', content: 'foo' },
				{ type: 'title', content: '\n【bar】\n', title: 'bar' },
				{ type: 'text', content: 'buzz' },
			], tokens4);
		});
	});

	describe('syntax highlighting', () => {
		it('comment', () => {
			const html1 = syntaxhighlighter('// Strawberry pasta');
			assert.equal(html1, '<span class="comment">// Strawberry pasta</span>');

			const html2 = syntaxhighlighter('x // x\ny // y');
			assert.equal(html2, 'x <span class="comment">// x\n</span>y <span class="comment">// y</span>');
		});

		it('regexp', () => {
			const html = syntaxhighlighter('/.*/');
			assert.equal(html, '<span class="regexp">/.*/</span>');
		});

		it('slash', () => {
			const html = syntaxhighlighter('/');
			assert.equal(html, '<span class="symbol">/</span>');
		});
	});

	describe('toHtml', () => {
		it('br', () => {
			const input = 'foo\nbar\nbaz';
			const output = '<p>foo<br>bar<br>baz</p>';
			assert.equal(toHtml(analyze(input)), output);
		});
	});
});