self-hosted/joplin
1
0
Fork 0
mirror of https://github.com/laurent22/joplin.git synced 2025-07-16 00:14:34 +02:00
Code Issues Releases Activity

Desktop: Refactored command system

Browse Source 
The goal is to make the command system more modular, so each command can
be defined as a single object that includes a declaration (name, label,
etc.) and a runtime (to execute the command, test if it should be
enabled, etc.)

Utility methods are provided to convert a command to a menu item or a
toolbar button, thus reducing duplicated and boiler plate code across the
codebase (often the menu item logic was duplicated in the toolbar
button logic and vice versa).

The goal is to make it easier to add new commands (and associated menu
item and toolbar buttons) and to call them from
anywhere. This is also useful for plugins, which can also easily define
new commands.

Could also allow creating a command palette.
This commit is contained in:
Laurent Cozic
2020-07-03 22:32:39 +01:00
parent 6046f40e45
commit c63c6370b5
67 changed files with 2214 additions and 1774 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
ElectronClient/gui/NoteEditor/NoteEditor.tsx
View File

@ -18,6 +18,7 @@ import useFormNote, { OnLoadEvent } from './utils/useFormNote';
import styles_ from './styles';
import { NoteEditorProps, FormNote, ScrollOptions, ScrollOptionTypes, OnChangeEvent, NoteBodyEditorProps } from './utils/types';
import ResourceEditWatcher from '../../lib/services/ResourceEditWatcher';
import CommandService from '../../lib/services/CommandService';
const { themeStyle } = require('lib/theme');
const NoteSearchBar = require('../NoteSearchBar.min.js');
@ -30,10 +31,14 @@ const { _ } = require('lib/locale');
const Note = require('lib/models/Note.js');
const { bridge } = require('electron').remote.require('./bridge');
const ExternalEditWatcher = require('lib/services/ExternalEditWatcher');
const eventManager = require('../../eventManager');
const eventManager = require('lib/eventManager');
const NoteRevisionViewer = require('../NoteRevisionViewer.min');
const TagList = require('../TagList.min.js');
const commands = [
require('./commands/showRevisions'),
];
function NoteEditor(props: NoteEditorProps) {
const [showRevisions, setShowRevisions] = useState(false);
const [titleHasBeenManuallyChanged, setTitleHasBeenManuallyChanged] = useState(false);
@ -222,7 +227,7 @@ function NoteEditor(props: NoteEditorProps) {
}
}, [handleProvisionalFlag, formNote, isNewNote, titleHasBeenManuallyChanged]);
useWindowCommandHandler({ windowCommand: props.windowCommand, dispatch: props.dispatch, formNote, setShowLocalSearch, noteSearchBarRef, editorRef, titleInputRef, saveNoteAndWait });
useWindowCommandHandler({ dispatch: props.dispatch, formNote, setShowLocalSearch, noteSearchBarRef, editorRef, titleInputRef, saveNoteAndWait });
const onDrop = useDropHandler({ editorRef });
@ -238,17 +243,9 @@ function NoteEditor(props: NoteEditorProps) {
event.preventDefault();
if (event.shiftKey) {
props.dispatch({
type: 'WINDOW_COMMAND',
name: 'focusElement',
target: 'noteList',
});
CommandService.instance().execute('focusElement', { target: 'noteList' });
} else {
props.dispatch({
type: 'WINDOW_COMMAND',
name: 'focusElement',
target: 'noteBody',
});
CommandService.instance().execute('focusElement', { target: 'noteBody' });
}
}
}, [props.dispatch]);
@ -314,52 +311,17 @@ function NoteEditor(props: NoteEditorProps) {
};
}, [externalEditWatcher_noteChange, onNotePropertyChange]);
const noteToolbar_buttonClick = useCallback((event: any) => {
const cases: any = {
'startExternalEditing': async () => {
props.dispatch({
type: 'WINDOW_COMMAND',
name: 'commandStartExternalEditing',
});
},
'stopExternalEditing': () => {
props.dispatch({
type: 'WINDOW_COMMAND',
name: 'commandStopExternalEditing',
});
},
'setTags': async () => {
await saveNoteAndWait(formNote);
props.dispatch({
type: 'WINDOW_COMMAND',
name: 'setTags',
noteIds: [formNote.id],
});
},
'setAlarm': async () => {
await saveNoteAndWait(formNote);
props.dispatch({
type: 'WINDOW_COMMAND',
name: 'editAlarm',
noteId: formNote.id,
});
},
'showRevisions': () => {
setShowRevisions(true);
},
useEffect(() => {
const dependencies = {
setShowRevisions,
};
if (!cases[event.name]) throw new Error(`Unsupported event: ${event.name}`);
CommandService.instance().componentRegisterCommands(dependencies, commands);
cases[event.name]();
}, [formNote]);
return () => {
CommandService.instance().componentUnregisterCommands(commands);
};
}, [setShowRevisions]);
const onScroll = useCallback((event: any) => {
props.dispatch({
@ -389,7 +351,6 @@ function NoteEditor(props: NoteEditorProps) {
theme={props.theme}
note={formNote}
style={toolbarStyle}
onButtonClick={noteToolbar_buttonClick}
/>;
}
@ -474,7 +435,6 @@ function NoteEditor(props: NoteEditorProps) {
padding: theme.margin,
verticalAlign: 'top',
boxSizing: 'border-box',
};
return (
@ -560,7 +520,6 @@ const mapStateToProps = (state: any) => {
syncStarted: state.syncStarted,
theme: state.settings.theme,
watchedNoteFiles: state.watchedNoteFiles,
windowCommand: state.windowCommand,
notesParentType: state.notesParentType,
selectedNoteTags: state.selectedNoteTags,
lastEditorScrollPercents: state.lastEditorScrollPercents,