Extension:CodeEditor

The CodeEditor extension extends the 1>Special:MyLanguage/Extension:WikiEditor|WikiEditor advanced editing toolbar with an embedded [https://github.com/ajaxorg/ace Ace editor widget], providing some handy features for user/site JS, CSS pages, and when  is also installed, for pages in Module namespace:


 * syntax highlighting for JavaScript, CSS and Lua


 * auto-indent


 * tab key produces tab indents (since 1.22), soft indents before.


 * indent/unindent selection with tab/shift-tab


 * syntax validity check for JavaScript


 * Pair-matching for parenthesis, braces and square brackets

Currently the extension is under development, and details of activation and functionality are subject to change.

License
While this extension is licensed [https://phabricator.wikimedia.org/diffusion/ECED/browse/master/COPYING GNU General Public License v2.0 or later (GPL-2.0+)] it makes use of the [https://ace.c9.io/#nav=about Ace editor software] which is licensed [https://raw.githubusercontent.com/ajaxorg/ace/master/LICENSE BSD 3-clause "New" or "Revised" License (BSD-3-Clause)].

Configuration

 * To disable the editor on JavaScript and CSS pages in the MediaWiki, User and other core namespaces, set   (default is "true")
 * To disable the editor on JavaScript and CSS pages in the MediaWiki, User and other core namespaces, set   (default is "true")


 * To disable this extension for ext-scribunto>Special:MyLanguage/Extension:Scribunto|Scribunto, i.e. in the module namespace set <tvar|code> </> (default is "true")
 * To disable this extension for ext-scribunto>Special:MyLanguage/Extension:Scribunto</>|Scribunto, i.e. in the module namespace set <tvar|code> </> (default is "true")


 * JavaScript

It is possible to change the configuration of the ACE editor, by hooking into the res-loader>ResourceLoader/Core modules#mw.hook</>|MediaWiki JS hook <tvar|configure>(i.e. </>). The argument passed to your hook will be an [<tvar|ace-editor>http://ace.c9.io/api/edit_session.html</> ACE editor session].

WikiEditor integration
''I've been integrating CodeEditor into the pluggable portions of <tvar|1></> as prep for Future editor work, since we'll want to be able to extend it to edit things that aren't plain wikitext, which'll need some changes to the toolbar setup and whatnot. JS/CSS here still return plain text in the end, making it an easier intermediate project. --brion 00:26, 14 June 2011 (UTC)''

Good:


 * special char insertions work, including quote pairs to surround text


 * basic formatting insertions work, including link dialogs


 * search/replace dialog works


 * ace's built-in search/replace UI also triggers from keyboard commands, still need to disable them! ([<tvar|commkey-link>http://ace.c9.io/api/editor.html#Editor.onCommandKey</> onCommandKey])

Bad:


 * multi-line formatting doesn't apply correctly (but really should that apply here? :)

Todo:


 * remove toolbar buttons that don't apply (formatting, syntax help?)


 * add toolbar buttons that are more directly useful


 * indent/outdent


 * insertion helpers for common keywords or code bits


 * help reference to MW JS API reference, JS & CSS specs/documentation

Issues
Known issues:


 * probably explodes with classic toolbar now; use with <tvar|1></> toolbar. See also <tvar|1>55419</>


 * accessibility: tab/shift-tab are overridden. is there a consistent alternative for keyboard-reliant users?


 * accessibility: accesskey on the original textarea needs to be moved over or otherwise handled


 * scrollbar initializes too wide; need to trigger resize check after that's filled (maybe fixed?)


 * cursor/scroll position not maintained over previews/show changes


 * [<tvar|upstream>https://github.com/ajaxorg/ace/issues/210</> upstream] ctrl+R, ctrl+L, ctrl+T are taken over by the editor, which is SUPER annoying