mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/CodeMirror
synced 2024-11-23 22:03:28 +00:00
13c9eae26e
This is toggled by pressing Mod-Shift-, (or Command-Shift-, on MacOS), which then puts focus on the preferences panel. It can be closed with the Escape key, just like other CM panels. The CodeMirror class comes with these extension which can be toggled in preferences: * Bracket matching * Line numbering * Line wrapping * Highlight the active line * Show special characters Only bracket matching, line numbering, and line wrapping are available in the 2017 editor. The bidi isolation and template folding extensions are registered in CodeMirrorModeMediaWiki as they are MW-specific. CodeMirrorPreferences' new registerExtension() method allows any consumer of CodeMirror to add any arbitrary extensions to the preferences panel. This is expected to be called *after* CodeMirror has finished initializing. The 'ext.CodeMirror.ready' hook now passes the CodeMirror instance to accommodate this. The preferences are stored as a single user option in the database, called 'codemirror-preferences'. The defaults can be configured with the $wgCodeMirrorDefaultPreferences configuration setting. The sysadmin-facing values are the familiar boolean, but since CodeMirror is widely used, we make extra efforts to reduce the storage footprint (see T54777). This includes only storing preferences that differ from the defaults, and using binary representation instead of boolean values, since the user option is stored as a string. For now, all preferences are ignored in the 2017 editor. In a future patch, we may add some as toggleable Tools in the VE toolbar. Other changes: * Refactor CSS to use a .darkmode() mixin * Add a method to create a CSS-only fieldset in CodeMirrorPanel * Fix Jest tests now that there are more calls to mw.user.options.get() * Adjust Selenium tests to always use CM6 * Adjust Selenium tests to delete test pages (useful for local dev) * Remove unused code Bug: T359498 Change-Id: I70dcf2f49418cea632c452c1266440effad634f3
101 lines
3.4 KiB
PHP
101 lines
3.4 KiB
PHP
<?php
|
|
/**
|
|
* ResourceLoader callback for ext.CodeMirror.data module
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
namespace MediaWiki\Extension\CodeMirror;
|
|
|
|
use MediaWiki\MediaWikiServices;
|
|
use MediaWiki\Registration\ExtensionRegistry;
|
|
use MediaWiki\ResourceLoader as RL;
|
|
use MediaWiki\ResourceLoader\ResourceLoader;
|
|
|
|
/**
|
|
* ResourceLoader callback for ext.CodeMirror.data
|
|
*/
|
|
class DataScript {
|
|
/**
|
|
* @param RL\Context $context
|
|
* @return string
|
|
*/
|
|
public static function makeScript( RL\Context $context ) {
|
|
return ResourceLoader::makeConfigSetScript(
|
|
[ 'extCodeMirrorConfig' => self::getFrontendConfiguraton() ]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Returns an array of variables for CodeMirror to work (tags and so on)
|
|
*
|
|
* @return array
|
|
*/
|
|
private static function getFrontendConfiguraton() {
|
|
// Use the content language, not the user language. (See T170130.)
|
|
$lang = MediaWikiServices::getInstance()->getContentLanguage();
|
|
$registry = ExtensionRegistry::getInstance();
|
|
$parser = MediaWikiServices::getInstance()->getParser();
|
|
$mwConfig = MediaWikiServices::getInstance()->getMainConfig();
|
|
|
|
$tagModes = $registry->getAttribute( 'CodeMirrorTagModes' );
|
|
$tagNames = array_merge( $parser->getTags(), array_keys( $tagModes ) );
|
|
|
|
// initialize configuration
|
|
$config = [
|
|
'useV6' => $mwConfig->get( 'CodeMirrorV6' ),
|
|
'defaultPreferences' => $mwConfig->get( 'CodeMirrorDefaultPreferences' ),
|
|
'lineNumberingNamespaces' => $mwConfig->get( 'CodeMirrorLineNumberingNamespaces' ),
|
|
'templateFoldingNamespaces' => $mwConfig->get( 'CodeMirrorTemplateFoldingNamespaces' ),
|
|
'pluginModules' => $registry->getAttribute( 'CodeMirrorPluginModules' ),
|
|
'tagModes' => $tagModes,
|
|
'tags' => array_fill_keys( $tagNames, true ),
|
|
'doubleUnderscore' => [ [], [] ],
|
|
'functionSynonyms' => $parser->getFunctionSynonyms(),
|
|
'urlProtocols' => $parser->getUrlProtocols(),
|
|
'linkTrailCharacters' => $lang->linkTrail(),
|
|
];
|
|
|
|
$mw = $lang->getMagicWords();
|
|
$magicWordFactory = $parser->getMagicWordFactory();
|
|
foreach ( $magicWordFactory->getDoubleUnderscoreArray()->getNames() as $name ) {
|
|
if ( isset( $mw[$name] ) ) {
|
|
$caseSensitive = array_shift( $mw[$name] ) == 0 ? 0 : 1;
|
|
foreach ( $mw[$name] as $n ) {
|
|
$n = $caseSensitive ? $n : $lang->lc( $n );
|
|
$config['doubleUnderscore'][$caseSensitive][$n] = $name;
|
|
}
|
|
} else {
|
|
$config['doubleUnderscore'][0][] = $name;
|
|
}
|
|
}
|
|
|
|
foreach ( $magicWordFactory->getVariableIDs() as $name ) {
|
|
if ( isset( $mw[$name] ) ) {
|
|
$caseSensitive = array_shift( $mw[$name] ) == 0 ? 0 : 1;
|
|
foreach ( $mw[$name] as $n ) {
|
|
$n = $caseSensitive ? $n : $lang->lc( $n );
|
|
$config['functionSynonyms'][$caseSensitive][$n] = $name;
|
|
}
|
|
}
|
|
}
|
|
|
|
return $config;
|
|
}
|
|
}
|