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

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

// TODO: remove URL feature flag once bidi isolation is more stable.
const urlParams = new URLSearchParams( window.location.search );

if ( mw.loader.getState( 'ext.wikiEditor' ) ) {
	mw.hook( 'wikiEditor.toolbarReady' ).add( ( $textarea ) => {
		const cmWE = new CodeMirrorWikiEditor(
			$textarea,
			mediaWikiLang( {
				bidiIsolation: $textarea.attr( 'dir' ) === 'rtl' && urlParams.get( 'cm6bidi' )
			} )
		);
		cmWE.addCodeMirrorToWikiEditor();
	} );
}
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 CodeMirrorWikiEditor = require( 'ext.CodeMirror.v6.WikiEditor' );`
			`const mediaWikiLang = require( 'ext.CodeMirror.v6.mode.mediawiki' );`
CodeMirror6: add new modules, feature flag, and URL query parameter Add a new $wgCodeMirrorV6 temporary feature flag that when enabled, will load the 'ext.CodeMirror.v6.WikiEditor' module that is built against CodeMirror 6. You can also pass in the ?cm6enable=1 query parameter to force use of CodeMirror 6. This is currently only implemented for the 2010 editor. Due to packaging constraints with CodeMirror 6, we now use Webpack to bundle the files, which are then used by ResourceLoader. This is similar to what is done for Extension:Popups, MobileFrontend, among other extensions. A new generic class CodeMirror can be used on other areas where syntax highlighting is desirable, but not necessarily for editing (i.e. without WikiEditor). This commit merely lays the foundation for CodeMirror 6 and updates WikiEditor to use it. The actual MediaWiki syntax highlighting will come with a future commit. With the new Webpack build, the Gruntfile was removed and the tasks moved to npm commands. Bug: T317243 Change-Id: I2239d2449b2db3b638551f847eb4eff1aafa6276 2023-09-19 17:59:29 +00:00
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 );`

CodeMirror6: add new modules, feature flag, and URL query parameter Add a new $wgCodeMirrorV6 temporary feature flag that when enabled, will load the 'ext.CodeMirror.v6.WikiEditor' module that is built against CodeMirror 6. You can also pass in the ?cm6enable=1 query parameter to force use of CodeMirror 6. This is currently only implemented for the 2010 editor. Due to packaging constraints with CodeMirror 6, we now use Webpack to bundle the files, which are then used by ResourceLoader. This is similar to what is done for Extension:Popups, MobileFrontend, among other extensions. A new generic class CodeMirror can be used on other areas where syntax highlighting is desirable, but not necessarily for editing (i.e. without WikiEditor). This commit merely lays the foundation for CodeMirror 6 and updates WikiEditor to use it. The actual MediaWiki syntax highlighting will come with a future commit. With the new Webpack build, the Gruntfile was removed and the tasks moved to npm commands. Bug: T317243 Change-Id: I2239d2449b2db3b638551f847eb4eff1aafa6276 2023-09-19 17:59:29 +00:00			`if ( mw.loader.getState( 'ext.wikiEditor' ) ) {`
			`mw.hook( 'wikiEditor.toolbarReady' ).add( ( $textarea ) => {`
CM6: move bidiIsolation to be part of CodeMirrorModeMediaWiki The extension is custom built for MediaWiki (i.e. handling of extension tags like <ref> that aren't HTML tags), so it only makes sense to bundle it as part of the MediaWiki language mode. Resultantly, we can no longer check the direction of the textarea where we enable bidi isolation, because the language mode should have no knowledge of the textarea. Instead we offer a `config` object (akin to other language modes offered by CodeMirror), with currently only one option: `bidiIsolation`. It is the responsibility of the caller to enable this where desired. Also make templateFolding and CodeMirrorModeMediaWiki use `export default` since they both only export one thing. This commit is in preparation for Ide716247e5, where we need bidi isolation separated from the CodeMirror class due to its dependency on CodeMirrorModeMediaConfig. Bug: T358804 Bug: T214989 Change-Id: If3211bd259bd7833919a627faabd86ae7aa81b53 2024-03-14 18:32:14 +00:00			`const cmWE = new CodeMirrorWikiEditor(`
			`$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			`mediaWikiLang( {`
			`bidiIsolation: $textarea.attr( 'dir' ) === 'rtl' && urlParams.get( 'cm6bidi' )`
			`} )`
CM6: move bidiIsolation to be part of CodeMirrorModeMediaWiki The extension is custom built for MediaWiki (i.e. handling of extension tags like <ref> that aren't HTML tags), so it only makes sense to bundle it as part of the MediaWiki language mode. Resultantly, we can no longer check the direction of the textarea where we enable bidi isolation, because the language mode should have no knowledge of the textarea. Instead we offer a `config` object (akin to other language modes offered by CodeMirror), with currently only one option: `bidiIsolation`. It is the responsibility of the caller to enable this where desired. Also make templateFolding and CodeMirrorModeMediaWiki use `export default` since they both only export one thing. This commit is in preparation for Ide716247e5, where we need bidi isolation separated from the CodeMirror class due to its dependency on CodeMirrorModeMediaConfig. Bug: T358804 Bug: T214989 Change-Id: If3211bd259bd7833919a627faabd86ae7aa81b53 2024-03-14 18:32:14 +00:00			`);`
CodeMirror6: add new modules, feature flag, and URL query parameter Add a new $wgCodeMirrorV6 temporary feature flag that when enabled, will load the 'ext.CodeMirror.v6.WikiEditor' module that is built against CodeMirror 6. You can also pass in the ?cm6enable=1 query parameter to force use of CodeMirror 6. This is currently only implemented for the 2010 editor. Due to packaging constraints with CodeMirror 6, we now use Webpack to bundle the files, which are then used by ResourceLoader. This is similar to what is done for Extension:Popups, MobileFrontend, among other extensions. A new generic class CodeMirror can be used on other areas where syntax highlighting is desirable, but not necessarily for editing (i.e. without WikiEditor). This commit merely lays the foundation for CodeMirror 6 and updates WikiEditor to use it. The actual MediaWiki syntax highlighting will come with a future commit. With the new Webpack build, the Gruntfile was removed and the tasks moved to npm commands. Bug: T317243 Change-Id: I2239d2449b2db3b638551f847eb4eff1aafa6276 2023-09-19 17:59:29 +00:00			`cmWE.addCodeMirrorToWikiEditor();`
			`} );`
			`}`