Extension:CodeMirror

This documentation refers to CodeMirror 6 – the new version of CodeMirror. It is slated to replace CodeMirror 5 by MediaWiki version 1.45 (release timeline ). See the migration guide on migrating clients to CodeMirror 6, and Extension:CodeMirror/5 for CodeMirror 5 documentation.

CodeMirror currently does not support syntax highlighting of Scribunto, JavaScript, CSS and JSON pages, but might in the future (T373711). In the meantime, use Extension:CodeEditor instead.

MediaWiki扩展手册

CodeMirror 发行状态： 稳定版
实现	用户界面
描述	为编辑器提供语法高亮
作者	Pavel Astakhov MusikAnimal Bhsd
维护者	Community Tech
最新版本	6.0.0
兼容性政策	快照跟随MediaWiki发布。 master分支不向后兼容。
PHP	7.4+
许可协议	GNU通用公眾授權條款2.0或更新版本
下載	下載扩展 Git [?]: 浏览存储库 (Phabricator · GitHub) Gerrit代码复核 Git提交日誌 下載原始碼(tarball壓縮) README
参数 $wgCodeMirrorContentModels $wgCodeMirrorV6 $wgCodeMirrorConflictingGadgets $wgCodeMirrorTitleCompletion $wgCodeMirrorDefaultPreferences $wgCodeMirrorLineNumberingNamespaces
使用的函数钩 EditPage::showEditForm:initial EditPage::showReadOnlyForm:initial GetBetaFeaturePreferences GetPreferences SpecialPageBeforeExecute UploadForm:initial
前往translatewiki.net翻譯CodeMirror扩展
問題	开启的任务 · 报告错误

CodeMirror 扩展使用 CodeMirror 库为 MediaWiki 的维基文本（wikitext）编辑器提供语法高亮。 For usage and a list of features, see Help:Extension:CodeMirror .

In 2024, the extension was upgraded to the new major version, CodeMirror 6, and with it many new features were added.

Usage

For usage of this extension, see Help:Extension:CodeMirror .

For the JavaScript documentation, see docs.wikimedia.org/CodeMirror.

Installation

• 下载文件，并将解压后的CodeMirror文件夹移动到extensions/目录中。
  开发者和代码贡献人员应从Git安装扩展，输入：

  cd extensions/
  git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CodeMirror
  

• 将下列代码放置在您的LocalSettings.php 文件的底部：

  wfLoadExtension( 'CodeMirror' );
  

• Configure as required.
• 完成 – 在您的wiki上导航至Special:Version，以验证已成功安装扩展。

Configuration

For customization of colors and CodeMirror's various features, see Help:Extension:CodeMirror .

To enable CodeMirror for all users by default, add the following to your LocalSettings.php :

# Enables use of CodeMirror by default but still allow users to disable it
$wgDefaultUserOptions[ 'usecodemirror' ] = true;

$wgCodeMirrorV6

Temporary feature flag to control the migration to CodeMirror 6 (T259059).

$wgCodeMirrorContentModels

Temporary feature flag to control conflicts with Extension:CodeEditor .

$wgCodeMirrorConflictingGadgets

An array of gadget names that, if enabled, will prevent CodeMirror from loading. Defaults to wikEd.

$wgCodeMirrorDefaultPreferences

Control which features are enabled by default for all users. Use true or false to enable or disable a feature entirely, or provide an array containing namespace IDs (integers) or content models (strings). For example, to limit autocompletion to JavaScript pages or templates, you could use:

$wgCodeMirrorDefaultPreferences[ 'autocomplete' ] = [ CONTENT_MODEL_JAVASCRIPT, NS_TEMPLATE ];

$wgCodeMirrorDefaultPreferences

Feature	2017 editor compatibility	Default value
activeLine	N	false
bidiIsolation	N	false
bracketMatching		true
lineNumbering		true
lineWrapping		true
specialChars	N	true
codeFolding	N	true
autocomplete	N	true
openLinks	N	true
whitespace	N	false
lint	N	['json','css']

Differences from CodeMirror 5

New features

• No longer requires the use of WikiEditor .
• Significant performance improvements.
• Right-to-left support (T170001) with bidi isolation (T358804).
• Code folding (T30684).
• Autocompletion (T95100).
• Quickly open links with modifier key + click (T303392).
• Improved search panel (T371436).
• CodeMirror preferences (T359498).
• Syntax highlighting on read-only pages (T301615).
• Robust JavaScript API for integration with extensions, gadgets, and user scripts.

Deprecations and other changes

• The ResourceLoader modules are changing. See the migration guide .
• The ext.CodeMirror.switch hook has been deprecated. Use ext.CodeMirror.toggle instead.
• The .cm-mw-mnemonic CSS class has been renamed to .cm-mw-html-entity.
• The .cm-mw-template-name-mnemonic class has been removed. Use .cm-mw-template-ground.cm-html-entity instead.
• The .cm-mw-apostrophes-bold and .cm-mw-apostrophes-italic CSS classes have been removed. Use .cm-mw-apostrophes instead.
• Line-level styling for <nowiki>, <pre>, or any tag without an associated TagMode has been removed (T351686).
• Mixed languages within wikitext are not yet supported (T357480).
• The browser's native search functionality (using Ctrl+F) has been replaced with search functionality built into CodeMirror. This is necessary to maintain performance (T303664).

Migration guide

MediaWiki版本：

≥ 1.43

This guide applies to MediaWiki 1.43 and later. All integrations should aim to be migrated by the release of MediaWiki 1.45 (release timeline ).

MediaWiki configuration

• $wgCodeMirrorLineNumberingNamespaces is deprecated. Configure $wgCodeMirrorDefaultPreferences instead.

ResourceLoader modules

Ensure you're using the new .v6 modules . Because CodeMirror 6 no longer relies on WikiEditor, there are some naming and behaviourial changes from the CodeMirror 5 counterparts:

Old module	New module (MW 1.43)	New module (MW 1.44+)	Description
ext.CodeMirror	ext.CodeMirror.v6.WikiEditor.init	ext.CodeMirror.init	CodeMirror integration for WikiEditor on #wpTextbox1 (the normal editing textarea) and only for wikitext.
N/A	ext.CodeMirror.v6.WikiEditor	ext.CodeMirror.WikiEditor	Exports the CodeMirrorWikiEditor class
N/A	ext.CodeMirror.v6.init	ext.CodeMirror.init	CodeMirror for #wpTextbox1 and only for wikitext.
ext.CodeMirror.lib	ext.CodeMirror.v6.lib	ext.CodeMirror.lib	Exports CodeMirror internals.
ext.CodeMirror.addons	N/A	N/A	This packaged the bracket matching feature in CodeMirror 5. Bracket matching is default behaviour in CodeMirror 6.
ext.CodeMirror.mode.mediawiki	ext.CodeMirror.v6.mode.mediawiki	ext.CodeMirror.mode.mediawiki	The MediaWiki language mode.
N/A	ext.CodeMirror.v6	ext.CodeMirror	Exports the CodeMirror class.
ext.CodeMirror.visualEditor	ext.CodeMirror.visualEditor.init	ext.CodeMirror.init	Integration with the 2017 wikitext編輯器 .
ext.CodeMirror.lib.mode.php	N/A	N/A	CodeMirror 6 will not provide these modules. They are rarely used and have no corresponding content model in MediaWiki. If you want support for these languages, you'll need to install the packages and bundle the code yourself.
ext.CodeMirror.lib.mode.clike
ext.CodeMirror.lib.mode.htmlmixed
ext.CodeMirror.lib.mode.xml
ext.CodeMirror.lib.mode.javascript	TBD	ext.CodeMirror.lib.mode.javascript	These languages are planned to be supported in CodeMirror 6.
ext.CodeMirror.lib.mode.css		ext.CodeMirror.lib.mode.css
N/A		ext.CodeMirror.lib.mode.lua
N/A		ext.CodeMirror.lib.mode.json
N/A		ext.CodeMirror.lib.mode.vue

With the release of MediaWiki 1.45, the old modules will be replaced with the news ones, and for some time the .v6 modules will be aliased before being removed entirely.

Gadgets and user scripts

The CodeMirror global has been removed entirely. For example, CodeMirror.fromTextArea( myTextarea ) will no longer work. Instead, first load the desired ResourceLoader modules , instantiate a CodeMirror object, and call the initialize() method.

If your script relies on the ext.CodeMirror.switch hook to change the way it interacts with the editor, you'll need to use ext.CodeMirror.toggle instead, or alternatively listen to an event. See the JavaScript integration section for more information.

CSS

The .CodeMirror element no longer exists. Use .cm-editor instead for the entire CodeMirror DOM, or .cm-content for the inner content (doesn't include the search panel, for example).

See deprecations and other changes to other CSS classes.

Integration

MediaWiki Extensions

Registering a new tag for MediaWiki

If you simply want CodeMirror to recognize a tag that is added by an extension, you can do so using the CodeMirrorTagModes extension attribute . For example, to register the tag ‎<foo> as something containing wikitext, you would add the following to extension.json:

{
	"attributes": {
		"CodeMirror": {
			"TagModes": [
				"foo": "mediawiki"
			]
		}
	}
}

CodeMirror will then highlight the content inside ‎<foo>...‎</foo> as wikitext.

Registering a tag so that CodeMirror treats the contents as something other than wikitext is currently not supported (T357480). If a tag is not registered, CodeMirror will highlight the contents as non-wikitext in the same way it highlights the contents of a ‎<nowiki>...‎</nowiki> tag.

Registering content models

CodeMirror's integration with WikiEditor currently works only with wikitext, but will eventually support other content types.

For the time being, if you need wikitext syntax highlighting on the main textarea (#wpTextbox1) for a content model other than wikitext, you can use the CodeMirrorContentModels extension attribute . For example, Extension:校对页面 registers the proofread-page content type:

{
	"attributes": {
		"CodeMirror": {
			"ContentModels": [
				"proofread-page"
			]
		}
	}
}

PluginModules

CodeMirrorPluginModules is an extension attribute that allows side-loading a module with CodeMirror. This unconditionally loads the module whenever the ext.CodeMirror.v6 module is loaded. If your plugin is only used in specific circumstances, consider having it check whether it is needed, and dynamically load the core code from a different module. This will avoid unnecessarily consuming end user bandwidth.

extension.json:

{
	"attributes": {
		"CodeMirror": {
			"PluginModules": [
				"ext.MyExtension.CodeMirror"
			]
		}
	}
}

ext.MyExtension.CodeMirror.js:

// Only load in the template namespace
if ( mw.config.get( 'wgNamespaceNumber' ) === 10 ) {
	return mw.loader.using( 'ext.MyExtension.CodeMirror.core' );
}
return Promise.resolve();

JavaScript

The CodeMirror editor is not an actual textarea, but a contenteditable. Usually developers need to ensure their code works with both given that CodeMirror can be toggled off.

For detecting changes to the document, using an event or a hook is likely the simplest. For reading and making changes, jQuery.textSelection may be convenient.

For more complex integrations or those who need better preformance, you can add your own extension to a new or an existing CodeMirror instance.

Using jQuery.textSelection

If you simply want to fetch or make changes to the document text, jQuery.textSelection is the easiest and most reliable means to do so. Usage of jQuery.textSelection on the textarea is bubbled up to CodeMirror, so you don't need to have any knowledge of whether CodeMirror is enabled:

const $textarea = $( '#wpTextbox1' )
const content = $textarea.textSelection( 'getContents' );
// Append "Foobar" to the content.
$textarea.textSelection( 'setContents', content + '\nFoobar' );

jQuery's .val() on #wpTextbox1 can be used, but this isn't recommended and may not work in all editors, such as the 2017 wikitext編輯器 .

Using ResourceLoader

The CodeMirror extension provides a number of 资源加载器 modules for use by user scripts, gadgets, and extensions. To make use of CodeMirror, you'll need at minimum the ext.CodeMirror.v6 module, along with the desired language. For MediaWiki wikitext, you'd use ext.CodeMirror.v6.mode.mediawiki.

Here is an example of how to apply wikitext syntax highlighting to any arbitrary textarea, using the default set of features:

mw.loader.using( [ 'ext.CodeMirror.v6', 'ext.CodeMirror.v6.mode.mediawiki' ] ).then( ( require ) => {
	const CodeMirror = require( 'ext.CodeMirror.v6' );
	const mediawikiLang = require( 'ext.CodeMirror.v6.mode.mediawiki' );
	const cm = new CodeMirror( myTextarea, mediawikiLang() );
	cm.initialize();
} );

If you also want WikiEditor:

mw.loader.using( [
	'ext.wikiEditor',
	'ext.CodeMirror.v6.WikiEditor',
	'ext.CodeMirror.v6.mode.mediawiki'
] ).then( ( require ) => {
	const textarea = document.getElementById( 'wpTextbox1' );
	mw.addWikiEditor( $( textarea ) );
    const CodeMirrorWikiEditor = require( 'ext.CodeMirror.v6.WikiEditor' );
	const mediawikiLang = require( 'ext.CodeMirror.v6.mode.mediawiki' );
	const cmWe = new CodeMirrorWikiEditor( textarea, mediawikiLang() );
	cmWe.initialize();
} );

ResourceLoader modules

Module	Description
ext.CodeMirror.v6.lib	The core CodeMirror library. You shouldn't need to require this directly unless you need access to the upstream CodeMirror API.
ext.CodeMirror.v6	The basic CodeMirror integration for MediaWiki editors. This module exports the CodeMirror class.
ext.CodeMirror.v6.mode.mediawiki	The MediaWiki language mode. Use this in conjunction with the ext.CodeMirror.v6 module.
ext.CodeMirror.v6.init （內部）	action=edit 请求的主要入口点。不用于外部用途。
ext.CodeMirror.v6.WikiEditor	CodeMirror integration for WikiEditor. This module exports the CodeMirrorWikiEditor class.
ext.CodeMirror.visualEditor.init	CodeMirror integration with the 2017 wikitext編輯器 , and only for wikitext.

Using hooks

You can also integrate with CodeMirror by using frontend hooks. These allow you to run code just before or after CodeMirror has loaded, or react to changes to the document.

Frontend hooks

Hook	Description
ext.CodeMirror.initialize	Called just before CodeMirror is initialized. This can be used to manipulate the DOM to suit CodeMirror (i.e. if you manipulate WikiEditor's DOM, you may need this). Parameters (HTMLTextAreaElement) The current "editor", most likely #wpTextbox1. (ve.ui.Surface) The VisualEditor surface CodeMirror is bound to, if applicable.
ext.CodeMirror.ready	Called just after CodeMirror is initialized. Parameters (CodeMirror) The CodeMirror instance.
ext.CodeMirror.toggle	Called when CodeMirror is toggled on or off. Parameters (boolean) Whether CodeMirror is now enabled. (CodeMirror) The CodeMirror instance. (HTMLTextAreaElement) The original textarea.
ext.CodeMirror.destroy	Called just after CodeMirror is destroyed and the original textarea is restored. Parameters (HTMLTextAreaElement) The original textarea.
ext.CodeMirror.input	Called when document changes are made in CodeMirror. Note that the textarea may not be updated yet. Parameters (ViewUpdate) The ViewUpdate object.
ext.CodeMirror.preferences.ready	Fired just before CodeMirrorPreferences has been instantiated. Paramaters (CodeMirrorPreferences) The CodeMirrorPreferences instance.
ext.CodeMirror.preferences.apply	Fired when a CodeMirror preference is enabled or initially applied. Parameters (string) The name of the preference, which is also the corresponding key in the extensionRegistry and compartmentRegistry.
ext.CodeMirror.preferences.change	Fired when a CodeMirror preference is enabled or disabled by the user. Paramaters (string) The name of the preference. (boolean) The new value of the preference.
ext.CodeMirror.preferences.display (internal)	Fired when the preferences panel is constructed, just before it is displayed. Parameters (HTMLDivElement) The preferences panel container.
ext.CodeMirror.keymap (internal)	Fired when the keyboard shortcut help dialog is opened.
ext.CodeMirror.search (internal)	Fired when the search panel is opened.

Using events

The following events are bubbled to the textarea for developer convenience:

• blur
• focus
• keyup
• keydown
• scroll

Using these events, you can integrate with CodeMirror using the same code as the original textarea:

myTextarea.addEventListener( 'keyup', ( event ) => {
	console.log( event.key );
} );

Extending CodeMirror

You can import the ext.CodeMirror.v6.lib module to get access to the upstream CodeMirror API. With this you can provide your own Extension when instantiating a CodeMirror or CodeMirrorWikiEditor instance.

For example, to provide your own Extension that reacts to changes made in CodeMirror:

mw.loader.using( [ 'ext.CodeMirror.v6', 'ext.CodeMirror.v6.mode.mediawiki' ] ).then( ( require ) => {
	const CodeMirror = require( 'ext.CodeMirror.v6' );
	const mediawikiLang = require( 'ext.CodeMirror.v6.mode.mediawiki' );
	// ext.CodeMirror.v6.lib is a dependency of ext.CodeMirror.v6, so it's already loaded at this point.
	const { EditorView } = require( 'ext.CodeMirror.v6.lib' );
	const myExtension = EditorView.updateListener.of( ( /** @type {ViewUpdate} */ update ) => {
		if ( update.docChanged ) {
		    // do something
		    console.log( update.changes );
		}
	} );
	const cm = new CodeMirror( myTextarea, mediawikiLang() );
    cm.initialize( [ cm.defaultExtensions, myExtension ] );
} );

Or if you need to interact with an existng CodeMirror instance:

// Ensure CodeMirror is initialized first
mw.hook( 'ext.CodeMirror.ready' ).add( ( cm ) => {
	const { EditorView } = require( 'ext.CodeMirror.v6.lib' );
	const myExtension = EditorView.updateListener.of( ( /** @type {ViewUpdate} */ update ) => {
		if ( update.docChanged ) {
		    // do something
		    console.log( update.changes );
		}
	} );
	cm.applyExtension( myExtension );
} );

Another means of listening to changes is using the ext.CodeMirror.input hook :

mw.hook( 'ext.CodeMirror.input' ).add( ( update ) => {
	// Print the ChangeSet to the console
	console.log( update.changes.toJSON() );
} );

See also

• User:Remember the dot/Syntax highlighter
• Extension:VisualEditor
• Extension:WikiEditor
• Extension:CodeEditor
• c:Category:MediaWiki extension CodeMirror

Notes