mediawiki-extensions-CodeMi.../resources/codemirror.mediawiki.init.js

const CodeMirror = require( 'ext.CodeMirror.v6' );
const mediaWikiLang = require( 'ext.CodeMirror.v6.mode.mediawiki' );

const textarea = document.getElementById( 'wpTextbox1' );
const cm = new CodeMirror( textarea );
// TODO: remove URL feature flag once bidi isolation is more stable.
const urlParams = new URLSearchParams( window.location.search );
cm.initialize( [
	cm.defaultExtensions,
	mediaWikiLang( {
		bidiIsolation: urlParams.get( 'cm6bidi' )
	} )
] );
Isolate build step to CM6 library and restructure files to work with RL CodeMirror 6 requires the use of NPM, but we can still bundle all CM packages into one file, and then everything else (i.e. our code) is managed by ResourceLoader as per usual. This makes contribution considerably easier as we no longer need a build step for each change. CM5 files are now under resources/legacy, and the CM6 files are moved to the root of the resources/ directory. Only one file, codemirror.bundle.js, is managed by Rollup, while everything else is RL. The Rollup output for now is put under resources/lib/ alongside the CM5 upstream files. This patch is mostly renames of files, along with changing ECMAScript Module (ESM) syntax into the CommonJS style that ResourceLoader prefers. We also remove more modern JS syntax (i.e. private class methods) that we were able to use before because we had a build step with Babel. This patch should effectively make no user-facing changes, or to the ResourceLoader modules we offer in Extension:CodeMirror. Finally, bump version in extension.json to 6, to match the upstream lib, and add Bhsd as an author :-) Bug: T368053 Change-Id: Ie258e49f5df8db23a7344ac3c4c9300aaa991042 2024-06-21 03:21:09 +00:00			`const CodeMirror = require( 'ext.CodeMirror.v6' );`
			`const mediaWikiLang = require( 'ext.CodeMirror.v6.mode.mediawiki' );`
CM6: Add syntax highlighting preference for users without WikiEditor This adds the `ext.CodeMirror.v6.init` ResourceLoader module which allows use of CodeMirror on `#wpTextbox1` without the use of WikiEditor (the 'usebetatoolbar' preference). In order for users to opt-in to using CodeMirror, we make the existing 'usecodemirror' option into a visible preference. In addition, with two preferences related to CodeMirror, we group them under a new heading 'Syntax highlighting'. More preferences may be added later to this section following T359498. When WikiEditor is not enabled, the layout of the action=edit page has the textarea as a sibling to other visible content, like `.editOptions`. Because of this, we can't simply append the CodeMirror DOM to the parent like we were before, as that would put the visible editor beneath the edit summary, Publish button, etc. Instead we rework the CodeMirror to first add a wrapper around the textarea and use that as the parent. This way, `.cm-editor` is always in the same place in the DOM as the native textarea. Line wrapping and focus/blur events are also moved to CodeMirror, as these are needed when not using WikiEditor. Bug: T190108 Change-Id: I4bc069e0d398aa7088e4f50bbd0ddda458b289c3 2024-03-26 20:40:13 +00:00
			`const textarea = document.getElementById( 'wpTextbox1' );`
			`const cm = new CodeMirror( textarea );`
CodeMirrorModeMediaWiki: put bidi isolation behind URL feature flag Bidi isolation is still not exactly 'stable'. Instead of removing it, we look for the URL query param `cm6bidi=1`. This allows users to test out bidi isolation and give feedback as we iterate on it. Once stable, this should be removed and bidi isolation should be on by default -- and eventually, can be opted out of via CodeMirror preferences (T359498). Bug: T358804 Change-Id: If7e024f0da71ddf1b0a38c0fc49f033ddbe745fd 2024-04-14 20:50:33 +00:00			`// TODO: remove URL feature flag once bidi isolation is more stable.`
			`const urlParams = new URLSearchParams( window.location.search );`
CM6: Add syntax highlighting preference for users without WikiEditor This adds the `ext.CodeMirror.v6.init` ResourceLoader module which allows use of CodeMirror on `#wpTextbox1` without the use of WikiEditor (the 'usebetatoolbar' preference). In order for users to opt-in to using CodeMirror, we make the existing 'usecodemirror' option into a visible preference. In addition, with two preferences related to CodeMirror, we group them under a new heading 'Syntax highlighting'. More preferences may be added later to this section following T359498. When WikiEditor is not enabled, the layout of the action=edit page has the textarea as a sibling to other visible content, like `.editOptions`. Because of this, we can't simply append the CodeMirror DOM to the parent like we were before, as that would put the visible editor beneath the edit summary, Publish button, etc. Instead we rework the CodeMirror to first add a wrapper around the textarea and use that as the parent. This way, `.cm-editor` is always in the same place in the DOM as the native textarea. Line wrapping and focus/blur events are also moved to CodeMirror, as these are needed when not using WikiEditor. Bug: T190108 Change-Id: I4bc069e0d398aa7088e4f50bbd0ddda458b289c3 2024-03-26 20:40:13 +00:00			`cm.initialize( [`
			`cm.defaultExtensions,`
CodeMirrorModeMediaWiki: put bidi isolation behind URL feature flag Bidi isolation is still not exactly 'stable'. Instead of removing it, we look for the URL query param `cm6bidi=1`. This allows users to test out bidi isolation and give feedback as we iterate on it. Once stable, this should be removed and bidi isolation should be on by default -- and eventually, can be opted out of via CodeMirror preferences (T359498). Bug: T358804 Change-Id: If7e024f0da71ddf1b0a38c0fc49f033ddbe745fd 2024-04-14 20:50:33 +00:00			`mediaWikiLang( {`
codemirror.mediawiki.js: add `Mod-Shift-x` This patch adds a keyboard shortcut `Mod-Shift-x` to toggle between left-to-right (LTR) and right-to-left (RTL) text directions. Bug: T170001 Change-Id: Ia857ad0b0aff0bb206b45e4d27dee6e91a3effce 2024-06-08 03:10:11 +00:00			`bidiIsolation: urlParams.get( 'cm6bidi' )`
CodeMirrorModeMediaWiki: put bidi isolation behind URL feature flag Bidi isolation is still not exactly 'stable'. Instead of removing it, we look for the URL query param `cm6bidi=1`. This allows users to test out bidi isolation and give feedback as we iterate on it. Once stable, this should be removed and bidi isolation should be on by default -- and eventually, can be opted out of via CodeMirror preferences (T359498). Bug: T358804 Change-Id: If7e024f0da71ddf1b0a38c0fc49f033ddbe745fd 2024-04-14 20:50:33 +00:00			`} )`
CM6: Add syntax highlighting preference for users without WikiEditor This adds the `ext.CodeMirror.v6.init` ResourceLoader module which allows use of CodeMirror on `#wpTextbox1` without the use of WikiEditor (the 'usebetatoolbar' preference). In order for users to opt-in to using CodeMirror, we make the existing 'usecodemirror' option into a visible preference. In addition, with two preferences related to CodeMirror, we group them under a new heading 'Syntax highlighting'. More preferences may be added later to this section following T359498. When WikiEditor is not enabled, the layout of the action=edit page has the textarea as a sibling to other visible content, like `.editOptions`. Because of this, we can't simply append the CodeMirror DOM to the parent like we were before, as that would put the visible editor beneath the edit summary, Publish button, etc. Instead we rework the CodeMirror to first add a wrapper around the textarea and use that as the parent. This way, `.cm-editor` is always in the same place in the DOM as the native textarea. Line wrapping and focus/blur events are also moved to CodeMirror, as these are needed when not using WikiEditor. Bug: T190108 Change-Id: I4bc069e0d398aa7088e4f50bbd0ddda458b289c3 2024-03-26 20:40:13 +00:00			`] );`