Desktop: Resolves #2059: Add option to transform HTML notes into Markdown (#12730)

Co-authored-by: Laurent Cozic <laurent22@users.noreply.github.com>

packages/app-desktop/commands/convertNoteToMarkdown.test.ts

@@ -0,0 +1,96 @@
+import * as convertHtmlToMarkdown from './convertNoteToMarkdown';
+import { AppState, createAppDefaultState } from '../app.reducer';
+import Note from '@joplin/lib/models/Note';
+import { MarkupLanguage } from '@joplin/renderer';
+import { setupDatabaseAndSynchronizer, switchClient } from '@joplin/lib/testing/test-utils';
+import Folder from '@joplin/lib/models/Folder';
+import { NoteEntity } from '@joplin/lib/services/database/types';
+
+describe('convertNoteToMarkdown', () => {
+	let state: AppState = undefined;
+
+	beforeEach(async () => {
+		state = createAppDefaultState({});
+		await setupDatabaseAndSynchronizer(1);
+		await switchClient(1);
+	});
+
+	it('should set the original note to be trashed', async () => {
+		const folder = await Folder.save({ title: 'test_folder' });
+		const htmlNote = await Note.save({ title: 'test', body: '<p>Hello</p>', parent_id: folder.id, markup_language: MarkupLanguage.Html });
+		state.selectedNoteIds = [htmlNote.id];
+
+		await convertHtmlToMarkdown.runtime().execute({ state, dispatch: () => {} });
+
+		const refreshedNote = await Note.load(htmlNote.id);
+
+		expect(htmlNote.deleted_time).toBe(0);
+		expect(refreshedNote.deleted_time).not.toBe(0);
+	});
+
+	it('should recreate a new note that is a clone of the original', async () => {
+		let noteConvertedToMarkdownId = '';
+		const dispatchFn = jest.fn()
+			.mockImplementationOnce(() => {})
+			.mockImplementationOnce(action => {
+				noteConvertedToMarkdownId = action.id;
+			});
+
+		const folder = await Folder.save({ title: 'test_folder' });
+		const htmlNoteProperties = {
+			title: 'test',
+			body: '<p>Hello</p>',
+			parent_id: folder.id,
+			markup_language: MarkupLanguage.Html,
+			author: 'test-author',
+			is_todo: 1,
+			todo_completed: 1,
+		};
+		const htmlNote = await Note.save(htmlNoteProperties);
+		state.selectedNoteIds = [htmlNote.id];
+
+		await convertHtmlToMarkdown.runtime().execute({ state, dispatch: dispatchFn });
+
+		expect(dispatchFn).toHaveBeenCalledTimes(2);
+		expect(noteConvertedToMarkdownId).not.toBe('');
+
+		const markdownNote = await Note.load(noteConvertedToMarkdownId);
+
+		const fields: (keyof NoteEntity)[] = ['parent_id', 'title', 'author', 'is_todo', 'todo_completed'];
+		for (const field of fields) {
+			expect(htmlNote[field]).toEqual(markdownNote[field]);
+		}
+	});
+
+	it('should generate action to trigger notification', async () => {
+		let originalHtmlNoteId = '';
+		let actionType = '';
+		const dispatchFn = jest.fn()
+			.mockImplementationOnce(action => {
+				originalHtmlNoteId = action.value;
+				actionType = action.type;
+			})
+			.mockImplementationOnce(() => {});
+
+		const folder = await Folder.save({ title: 'test_folder' });
+		const htmlNoteProperties = {
+			title: 'test',
+			body: '<p>Hello</p>',
+			parent_id: folder.id,
+			markup_language: MarkupLanguage.Html,
+			author: 'test-author',
+			is_todo: 1,
+			todo_completed: 1,
+		};
+		const htmlNote = await Note.save(htmlNoteProperties);
+		state.selectedNoteIds = [htmlNote.id];
+
+		await convertHtmlToMarkdown.runtime().execute({ state, dispatch: dispatchFn });
+
+		expect(dispatchFn).toHaveBeenCalledTimes(2);
+
+		expect(originalHtmlNoteId).toBe(htmlNote.id);
+		expect(actionType).toBe('NOTE_HTML_TO_MARKDOWN_DONE');
+	});
+
+});

packages/app-desktop/commands/convertNoteToMarkdown.ts

@@ -0,0 +1,52 @@
+import { _ } from '@joplin/lib/locale';
+import Note from '@joplin/lib/models/Note';
+import { stateUtils } from '@joplin/lib/reducer';
+import { CommandRuntime, CommandDeclaration, CommandContext } from '@joplin/lib/services/CommandService';
+import { MarkupLanguage } from '@joplin/renderer';
+import { runtime as convertHtmlToMarkdown } from '@joplin/lib/commands/convertHtmlToMarkdown';
+import bridge from '../services/bridge';
+
+export const declaration: CommandDeclaration = {
+	name: 'convertNoteToMarkdown',
+	label: () => _('Convert note to Markdown'),
+};
+
+export const runtime = (): CommandRuntime => {
+	return {
+		execute: async (context: CommandContext, noteId: string = null) => {
+			noteId = noteId || stateUtils.selectedNoteId(context.state);
+
+			const note = await Note.load(noteId);
+
+			if (!note) return;
+
+			try {
+				const markdownBody = await convertHtmlToMarkdown().execute(context, note.body);
+
+				const newNote = await Note.duplicate(note.id);
+
+				newNote.body = markdownBody;
+				newNote.markup_language = MarkupLanguage.Markdown;
+
+				await Note.save(newNote);
+
+				await Note.delete(note.id, { toTrash: true });
+
+				context.dispatch({
+					type: 'NOTE_HTML_TO_MARKDOWN_DONE',
+					value: note.id,
+				});
+
+				context.dispatch({
+					type: 'NOTE_SELECT',
+					id: newNote.id,
+				});
+			} catch (error) {
+				bridge().showErrorMessageBox(_('Could not convert note to Markdown: %s', error.message));
+			}
+
+
+		},
+		enabledCondition: 'oneNoteSelected && noteIsHtml && !noteIsReadOnly',
+	};
+};

packages/app-desktop/commands/index.ts

@@ -1,4 +1,5 @@
 // AUTO-GENERATED using `gulp buildScriptIndexes`
+import * as convertNoteToMarkdown from './convertNoteToMarkdown';
 import * as copyDevCommand from './copyDevCommand';
 import * as copyToClipboard from './copyToClipboard';
 import * as editProfileConfig from './editProfileConfig';
@@ -24,6 +25,7 @@ import * as toggleSafeMode from './toggleSafeMode';
 import * as toggleTabMovesFocus from './toggleTabMovesFocus';
 
 const index: any[] = [
+	convertNoteToMarkdown,
 	copyDevCommand,
 	copyToClipboard,
 	editProfileConfig,