script.js ➔ stickyMenubar - Code Metrics - Inspection of "Fix CSS in smiley dropdown" - cosmocode/dokuwiki-plugin-prosemirror - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 8b48b4...c26dfa )

unknown

created 2023-12-11 08:31 UTC

script.js ➔ stickyMenubar A

↳ Parent: script.js

Complexity

Conditions

Size

Total Lines	17
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	11
dl	0
loc	17
rs	9.85
c	0
b	0
f	0

/**
 * Hide Prosemirror and show the default editor
 *
 * @param {string} text the wiki syntax to be shown in the textarea
 */
function showDefaultEditor(text) {
    window.Prosemirror.destroyProsemirror();
    window.proseMirrorIsActive = false;
    dw_locktimer.init(dw_locktimer.timeout/1000, dw_locktimer.draft);

    jQuery('#wiki__text').val(text).show();
    jQuery('#size__ctl').show();
    jQuery('.editBox > .toolbar').show();
}

/**
 * Hide the default editor and start a new Prosemirror Editor
 *
 * @param {string} json the prosemirror document json
 */
function showProsemirror(json) {
    const $textArea = jQuery('#wiki__text');
    const $prosemirrorJsonInput = jQuery('#dw__editform').find('[name=prosemirror_json]').val(json);
    try {
        window.Prosemirror.enableProsemirror();
        stickyMenubar();
        disableNativeFirefoxTableControls();
    } catch (e) {
        console.error(e);
        let message = 'There was an error in the WYSIWYG editor. You will be redirected to the syntax editor in 5 seconds.';
        if (window.SentryPlugin) {
            SentryPlugin.logSentryException(e, {

                tags: {
                    plugin: 'prosemirror',
                    'id': JSINFO.id,

                },
                extra: {
                    'content': $textArea.val(),
                    'json': $prosemirrorJsonInput.val(),
                }
            });
            message += ' -- The error has been logged to Sentry.';
        }
        showErrorMessage(message);
        setTimeout(function() {
            jQuery('.plugin_prosemirror_useWYSIWYG').click();
        }, 5000);
    }
    window.proseMirrorIsActive = true;
    $textArea.hide();
    jQuery('#size__ctl').hide();
    jQuery('.editBox > .toolbar').hide();
    jQuery('div.ProseMirror').focus();

    if (dw_locktimer.addField) {

        // todo remove this guard after the next stable DokuWiki release after Greebo
        dw_locktimer.init(dw_locktimer.timeout/1000, dw_locktimer.draft, 'prosemirror__editor');
        dw_locktimer.addField('input[name=prosemirror_json]');
    } else {
        console.warn('Draft saving in WYSIWYG is not available. Please upgrade your wiki to the current development snapshot.')
    }
}

/**
 * Disables Firefox's controls for editable tables, they are incompatible with prosemirror
 *
 * See https://github.com/ProseMirror/prosemirror/issues/432 and https://github.com/ProseMirror/prosemirror-tables/issues/22
 */
function disableNativeFirefoxTableControls() {
    document.execCommand("enableObjectResizing", false, "false");
    document.execCommand("enableInlineTableEditing", false, "false");
}

/**
 * Initialize the prosemirror framework
 *
 * (This shouldn't do much until we actually use the editor, but we maybe shouldn't do this twice)
 */
function initializeProsemirror() {
    try {

        /* DOKUWIKI:include lib/bundle.js */
    } catch (e) {

        const $textArea = jQuery('#wiki__text');

        console.error(e);
        let message = 'There was an error initializing the WYSIWYG editor.';

        if (window.SentryPlugin) {
            SentryPlugin.logSentryException(e, {
                tags: {
                    plugin: 'prosemirror',
                    'id': JSINFO.id,
                },
                extra: {
                    'content': $textArea.val(),
                }
            });
            message += ' The error has been logged to sentry.';
        }

        showErrorMessage(message);

        DokuCookie.setValue('plugin_prosemirror_useWYSIWYG', '');
    }
}

/**
 * Add the error message above the editor
 *
 * @param {string} errorMsg
 */
function showErrorMessage(errorMsg) {
    jQuery('.editBox').before(
        jQuery('<div class="error"></div>').text(errorMsg)
    );
}

/**
 * Switch between WYSIWYG and Syntax editor
 */
function toggleEditor() {
    const $textArea = jQuery('#wiki__text');
    const $jsonField = jQuery('#dw__editform').find('[name=prosemirror_json]');
    jQuery.post(DOKU_BASE + 'lib/exe/ajax.php', {

        call: 'plugin_prosemirror_switch_editors',
        data: window.proseMirrorIsActive ? $jsonField.val() : $textArea.val(),
        getJSON: window.proseMirrorIsActive ? '0' : '1',
    }).done(function handleSwitchEditorResponse(data) {
        if (window.proseMirrorIsActive) {
            showDefaultEditor(data.text);
        } else {
            showProsemirror(data.json);
        }
    }).fail(function (jqXHR, textStatus, errorThrown) {
        console.error(jqXHR, textStatus, errorThrown); // FIXME: proper error handling
        if (jqXHR.responseJSON && jqXHR.responseJSON.error) {
            showErrorMessage(jqXHR.responseJSON.error);
        } else {
            let message = 'The request failed with an unexpected error.';
            if (window.SentryPlugin) {
                SentryPlugin.logSentryException(new Error(textStatus), {

                    tags: {
                        plugin: 'prosemirror',
                        'id': JSINFO.id,

                        status: jqXHR.status
                    },
                    extra: {
                        'content': $textArea.val(),
                        'responseText': jqXHR.responseText,
                    }
                });
                message += ' -- The error has been logged to Sentry.';
            }
            showErrorMessage(message);
        }
    });

    const $current = DokuCookie.getValue('plugin_prosemirror_useWYSIWYG');

    DokuCookie.setValue('plugin_prosemirror_useWYSIWYG', $current ? '' : '1');
}

/**
 * If the cookie is set, then show the WYSIWYG editor and add the switch-editor-event to the button
 */
function handleEditSession() {
    const $jsonField = jQuery('#dw__editform').find('[name=prosemirror_json]');
    if (DokuCookie.getValue('plugin_prosemirror_useWYSIWYG')) {

        showProsemirror($jsonField.val());
    }
    const $toggleEditorButton = jQuery('.plugin_prosemirror_useWYSIWYG');
    $toggleEditorButton.on('click', toggleEditor);
}

/**
 * when the editor switch button moves out of the view-port, the menubar gets a class
 * @see https://codepen.io/hey-nick/pen/mLpmMV
 * @see https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API
 */

function stickyMenubar() {
    const editorswitch = document.querySelector('button[name=prosemirror]');
    const menubar = document.querySelector('#prosemirror__editor div.menubar');

    const observer = new IntersectionObserver(

        ([e]) => {
            return menubar.classList.toggle('prosemirror-menubar-fixed', e.intersectionRatio !== 1);
        },
        {
            root: null,
            threshold: [0, 1]
        }
    );
    if (editorswitch && menubar) {
        observer.observe(editorswitch);
    }
}


jQuery(function () {
    initializeProsemirror();
    window.proseMirrorIsActive = false;

    if (jQuery('#dw__editform').find('[name=prosemirror_json]').length) {
        handleEditSession();
    }

    jQuery(window).on('fastwiki:afterSwitch', function(evt, viewMode, isSectionEdit, prevViewMode) {

        if (viewMode === 'edit' || isSectionEdit) {
            handleEditSession();
        }
    });
});


1			/**
2			* Hide Prosemirror and show the default editor
3			*
4			* @param {string} text the wiki syntax to be shown in the textarea
5			*/
6			function showDefaultEditor(text) {
7			window.Prosemirror.destroyProsemirror();
8			window.proseMirrorIsActive = false;
9			dw_locktimer.init(dw_locktimer.timeout/1000, dw_locktimer.draft);
			0 ignored issues – show Bug introduced 2018-07-03 13:09 UTC by Report Bug Copy Issue Report The variable `dw_locktimer` seems to be never declared. If this is a global, consider adding a `/** global: dw_locktimer */` comment. This checks looks for references to variables that have not been declared. This is most likey a typographical error or a variable has been renamed. To learn more about declaring variables in Javascript, see the MDN. Loading history...
10			jQuery('#wiki__text').val(text).show();
11			jQuery('#size__ctl').show();
12			jQuery('.editBox > .toolbar').show();
13			}
14
15			/**
16			* Hide the default editor and start a new Prosemirror Editor
17			*
18			* @param {string} json the prosemirror document json
19			*/
20			function showProsemirror(json) {
21			const $textArea = jQuery('#wiki__text');
22			const $prosemirrorJsonInput = jQuery('#dw__editform').find('[name=prosemirror_json]').val(json);
23			try {
24			window.Prosemirror.enableProsemirror();
25			stickyMenubar();
26			disableNativeFirefoxTableControls();
27			} catch (e) {
28			console.error(e);
29			let message = 'There was an error in the WYSIWYG editor. You will be redirected to the syntax editor in 5 seconds.';
30			if (window.SentryPlugin) {
31			SentryPlugin.logSentryException(e, {
			0 ignored issues – show Bug introduced 2018-07-03 13:09 UTC by Report Bug Copy Issue Report The variable `SentryPlugin` seems to be never declared. If this is a global, consider adding a `/** global: SentryPlugin */` comment. This checks looks for references to variables that have not been declared. This is most likey a typographical error or a variable has been renamed. To learn more about declaring variables in Javascript, see the MDN. Loading history...
32			tags: {
33			plugin: 'prosemirror',
34			'id': JSINFO.id,
			0 ignored issues – show Bug introduced 2018-07-03 13:09 UTC by Report Bug Copy Issue Report The variable `JSINFO` seems to be never declared. If this is a global, consider adding a `/** global: JSINFO */` comment. This checks looks for references to variables that have not been declared. This is most likey a typographical error or a variable has been renamed. To learn more about declaring variables in Javascript, see the MDN. Loading history...
35			},
36			extra: {
37			'content': $textArea.val(),
38			'json': $prosemirrorJsonInput.val(),
39			}
40			});
41			message += ' -- The error has been logged to Sentry.';
42			}
43			showErrorMessage(message);
44			setTimeout(function() {
45			jQuery('.plugin_prosemirror_useWYSIWYG').click();
46			}, 5000);
47			}
48			window.proseMirrorIsActive = true;
49			$textArea.hide();
50			jQuery('#size__ctl').hide();
51			jQuery('.editBox > .toolbar').hide();
52			jQuery('div.ProseMirror').focus();
53
54			if (dw_locktimer.addField) {
			0 ignored issues – show Bug introduced 2018-06-14 08:16 UTC by Report Bug Copy Issue Report The variable `dw_locktimer` seems to be never declared. If this is a global, consider adding a `/** global: dw_locktimer */` comment. This checks looks for references to variables that have not been declared. This is most likey a typographical error or a variable has been renamed. To learn more about declaring variables in Javascript, see the MDN. Loading history...
55			// todo remove this guard after the next stable DokuWiki release after Greebo
56			dw_locktimer.init(dw_locktimer.timeout/1000, dw_locktimer.draft, 'prosemirror__editor');
57			dw_locktimer.addField('input[name=prosemirror_json]');
58			} else {
59			console.warn('Draft saving in WYSIWYG is not available. Please upgrade your wiki to the current development snapshot.')
60			}
61			}
62
63			/**
64			* Disables Firefox's controls for editable tables, they are incompatible with prosemirror
65			*
66			* See https://github.com/ProseMirror/prosemirror/issues/432 and https://github.com/ProseMirror/prosemirror-tables/issues/22
67			*/
68			function disableNativeFirefoxTableControls() {
69			document.execCommand("enableObjectResizing", false, "false");
70			document.execCommand("enableInlineTableEditing", false, "false");
71			}
72
73			/**
74			* Initialize the prosemirror framework
75			*
76			* (This shouldn't do much until we actually use the editor, but we maybe shouldn't do this twice)
77			*/
78			function initializeProsemirror() {
79			try {
			0 ignored issues – show Comprehensibility Documentation Best Practice introduced 2018-07-03 13:09 UTC by Report Bug Copy Issue Report This code block is empty. Consider removing it or adding a comment to explain. Loading history... Unused Code introduced 2018-07-03 13:09 UTC by Report Bug Copy Issue Report Empty try statement found. This statement can be removed. Loading history...
80			/* DOKUWIKI:include lib/bundle.js */
81			} catch (e) {
			0 ignored issues – show introduced 2018-06-04 16:10 UTC by Report Bug Copy Issue Report This code is unreachable and can thus be removed without consequences. Loading history...
82			const $textArea = jQuery('#wiki__text');
			0 ignored issues – show Bug introduced 2018-06-04 16:10 UTC by Report Bug Copy Issue Report The variable `$textArea` seems to be never declared. Assigning variables without defining them first makes them global. If this was intended, consider making it explicit like using `window.$textArea`. Loading history...
83			console.error(e);
84			let message = 'There was an error initializing the WYSIWYG editor.';
			0 ignored issues – show Bug introduced 2018-07-03 13:09 UTC by Report Bug Copy Issue Report The variable `message` seems to be never declared. Assigning variables without defining them first makes them global. If this was intended, consider making it explicit like using `window.message`. Loading history...
85			if (window.SentryPlugin) {
86			SentryPlugin.logSentryException(e, {
87			tags: {
88			plugin: 'prosemirror',
89			'id': JSINFO.id,
90			},
91			extra: {
92			'content': $textArea.val(),
93			}
94			});
95			message += ' The error has been logged to sentry.';
96			}
97
98			showErrorMessage(message);
99
100			DokuCookie.setValue('plugin_prosemirror_useWYSIWYG', '');
101			}
102			}
103
104			/**
105			* Add the error message above the editor
106			*
107			* @param {string} errorMsg
108			*/
109			function showErrorMessage(errorMsg) {
110			jQuery('.editBox').before(
111			jQuery('<div class="error"></div>').text(errorMsg)
112			);
113			}
114
115			/**
116			* Switch between WYSIWYG and Syntax editor
117			*/
118			function toggleEditor() {
119			const $textArea = jQuery('#wiki__text');
120			const $jsonField = jQuery('#dw__editform').find('[name=prosemirror_json]');
121			jQuery.post(DOKU_BASE + 'lib/exe/ajax.php', {
			0 ignored issues – show Bug introduced 2018-07-03 13:09 UTC by Report Bug Copy Issue Report The variable `DOKU_BASE` seems to be never declared. If this is a global, consider adding a `/** global: DOKU_BASE */` comment. This checks looks for references to variables that have not been declared. This is most likey a typographical error or a variable has been renamed. To learn more about declaring variables in Javascript, see the MDN. Loading history...
122			call: 'plugin_prosemirror_switch_editors',
123			data: window.proseMirrorIsActive ? $jsonField.val() : $textArea.val(),
124			getJSON: window.proseMirrorIsActive ? '0' : '1',
125			}).done(function handleSwitchEditorResponse(data) {
126			if (window.proseMirrorIsActive) {
127			showDefaultEditor(data.text);
128			} else {
129			showProsemirror(data.json);
130			}
131			}).fail(function (jqXHR, textStatus, errorThrown) {
132			console.error(jqXHR, textStatus, errorThrown); // FIXME: proper error handling
133			if (jqXHR.responseJSON && jqXHR.responseJSON.error) {
134			showErrorMessage(jqXHR.responseJSON.error);
135			} else {
136			let message = 'The request failed with an unexpected error.';
137			if (window.SentryPlugin) {
138			SentryPlugin.logSentryException(new Error(textStatus), {
			0 ignored issues – show Bug introduced 2018-07-03 13:09 UTC by Report Bug Copy Issue Report The variable `SentryPlugin` seems to be never declared. If this is a global, consider adding a `/** global: SentryPlugin */` comment. This checks looks for references to variables that have not been declared. This is most likey a typographical error or a variable has been renamed. To learn more about declaring variables in Javascript, see the MDN. Loading history...
139			tags: {
140			plugin: 'prosemirror',
141			'id': JSINFO.id,
			0 ignored issues – show Bug introduced 2018-07-03 13:09 UTC by Report Bug Copy Issue Report The variable `JSINFO` seems to be never declared. If this is a global, consider adding a `/** global: JSINFO */` comment. This checks looks for references to variables that have not been declared. This is most likey a typographical error or a variable has been renamed. To learn more about declaring variables in Javascript, see the MDN. Loading history...
142			status: jqXHR.status
143			},
144			extra: {
145			'content': $textArea.val(),
146			'responseText': jqXHR.responseText,
147			}
148			});
149			message += ' -- The error has been logged to Sentry.';
150			}
151			showErrorMessage(message);
152			}
153			});
154
155			const $current = DokuCookie.getValue('plugin_prosemirror_useWYSIWYG');
			0 ignored issues – show Bug introduced 2018-06-04 16:10 UTC by Report Bug Copy Issue Report The variable `DokuCookie` seems to be never declared. If this is a global, consider adding a `/** global: DokuCookie */` comment. This checks looks for references to variables that have not been declared. This is most likey a typographical error or a variable has been renamed. To learn more about declaring variables in Javascript, see the MDN. Loading history...
156			DokuCookie.setValue('plugin_prosemirror_useWYSIWYG', $current ? '' : '1');
157			}
158
159			/**
160			* If the cookie is set, then show the WYSIWYG editor and add the switch-editor-event to the button
161			*/
162			function handleEditSession() {
163			const $jsonField = jQuery('#dw__editform').find('[name=prosemirror_json]');
164			if (DokuCookie.getValue('plugin_prosemirror_useWYSIWYG')) {
			0 ignored issues – show Bug introduced 2018-07-03 13:09 UTC by Report Bug Copy Issue Report The variable `DokuCookie` seems to be never declared. If this is a global, consider adding a `/** global: DokuCookie */` comment. This checks looks for references to variables that have not been declared. This is most likey a typographical error or a variable has been renamed. To learn more about declaring variables in Javascript, see the MDN. Loading history...
165			showProsemirror($jsonField.val());
166			}
167			const $toggleEditorButton = jQuery('.plugin_prosemirror_useWYSIWYG');
168			$toggleEditorButton.on('click', toggleEditor);
169			}
170
171			/**
172			* when the editor switch button moves out of the view-port, the menubar gets a class
173			* @see https://codepen.io/hey-nick/pen/mLpmMV
174			* @see https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API
175			*/
176
177			function stickyMenubar() {
178			const editorswitch = document.querySelector('button[name=prosemirror]');
179			const menubar = document.querySelector('#prosemirror__editor div.menubar');
180
181			const observer = new IntersectionObserver(
			0 ignored issues – show Bug introduced 2023-08-14 18:29 UTC by Report Bug Copy Issue Report The variable `IntersectionObserver` seems to be never declared. If this is a global, consider adding a `/** global: IntersectionObserver */` comment. This checks looks for references to variables that have not been declared. This is most likey a typographical error or a variable has been renamed. To learn more about declaring variables in Javascript, see the MDN. Loading history...
182			([e]) => {
183			return menubar.classList.toggle('prosemirror-menubar-fixed', e.intersectionRatio !== 1);
184			},
185			{
186			root: null,
187			threshold: [0, 1]
188			}
189			);
190			if (editorswitch && menubar) {
191			observer.observe(editorswitch);
192			}
193			}
194
195
196			jQuery(function () {
197			initializeProsemirror();
198			window.proseMirrorIsActive = false;
199
200			if (jQuery('#dw__editform').find('[name=prosemirror_json]').length) {
201			handleEditSession();
202			}
203
204			jQuery(window).on('fastwiki:afterSwitch', function(evt, viewMode, isSectionEdit, prevViewMode) {
			0 ignored issues – show Unused Code introduced 2018-07-03 14:32 UTC by Report Bug Copy Issue Report The parameter `prevViewMode` is not used and could be removed. This check looks for parameters in functions that are not used in the function body and are not followed by other parameters which are used inside the function. Loading history...
205			if (viewMode === 'edit' \|\| isSectionEdit) {
206			handleEditSession();
207			}
208			});
209			});
210

cosmocode / dokuwiki-plugin-prosemirror

Push — master ( 8b48b4...c26dfa )

script.js ➔ stickyMenubar A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like