wikimedia/mediawiki-extensions-CodeMirror
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/CodeMirror synced 2024-11-23 13:56:44 +00:00
Code Issues Packages Projects Releases Wiki Activity
Mirror of https://gerrit.wikimedia.org/g/mediawiki/extensions/CodeMirror
1210 commits 278 branches 0 tags 47 MiB
JavaScript 96.7%
PHP 1.7%
Less 1.6%
Go to file
MusikAnimal 13c9eae26e CodeMirrorPreferences: add panel to tweak prefs with the editor open 
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
2024-11-18 22:23:22 -05:00
.phan Use service 'GadgetsRepo' instead of deprecated GadgetRepo::singleton() 2024-07-01 09:32:50 +00:00
i18n CodeMirrorPreferences: add panel to tweak prefs with the editor open 2024-11-18 22:23:22 -05:00
includes CodeMirrorPreferences: add panel to tweak prefs with the editor open 2024-11-18 22:23:22 -05:00
resources CodeMirrorPreferences: add panel to tweak prefs with the editor open 2024-11-18 22:23:22 -05:00
tests CodeMirrorPreferences: add panel to tweak prefs with the editor open 2024-11-18 22:23:22 -05:00
.eslintignore CodeMirror 6 for VE 2017 wikitext editor 2024-08-01 03:15:21 -04:00
.eslintrc.json eslint: Lint Gruntile.js using server rules 2022-02-07 16:25:32 +00:00
.gitignore CM6: Add jsdoc build step, fix JSDoc annotations, and add @stable tags 2024-03-26 13:35:47 -04:00
.gitreview Whoops, track not trace 2016-10-24 17:02:17 -07:00
.nvmrc Bump Node version to 18.20.4 2024-09-03 20:21:31 +00:00
.phpcs.xml build: Updating eslint-config-wikimedia to 0.18.2 2021-03-06 09:27:20 +00:00
.stylelintrc.json CodeMirror6: add new modules, feature flag, and URL query parameter 2023-10-09 19:51:24 -04:00
CODE_OF_CONDUCT.md build: Updating mediawiki/phan-taint-check-plugin to 1.3.0 2018-08-19 10:46:12 +00:00
composer.json build: Updating mediawiki/mediawiki-codesniffer to 45.0.0 2024-11-02 04:47:15 +00:00
COPYING CodeMirror: Add COPYING file and credit for CodeMirror authors 2020-03-02 21:34:06 +00:00
extension.json CodeMirrorPreferences: add panel to tweak prefs with the editor open 2024-11-18 22:23:22 -05:00
jest.config.js CodeMirror6: add new modules, feature flag, and URL query parameter 2023-10-09 19:51:24 -04:00
jsdoc.json CodeMirrorPreferences: add panel to tweak prefs with the editor open 2024-11-18 22:23:22 -05:00
package-lock.json build: Updating rollup to 4.22.4 2024-09-24 00:56:45 +00:00
package.json build: Updating rollup to 4.22.4 2024-09-24 00:56:45 +00:00
README.md Isolate build step to CM6 library and restructure files to work with RL 2024-07-31 22:45:48 -04:00
rollup.config.js Isolate build step to CM6 library and restructure files to work with RL 2024-07-31 22:45:48 -04:00

README.md

The CodeMirror extension provides syntax highlighting in MediaWiki wikitext editors using the CodeMirror library.

CodeMirror 6 homepage: https://www.mediawiki.org/wiki/Extension:CodeMirror/6

JS documentation: https://doc.wikimedia.org/CodeMirror

Development

Preface

Extension:CodeMirror is currently in the process of being upgraded to the new major version, CodeMirror 6. See the change log for details.

Use of CodeMirror 6 is controlled by the wgCodeMirrorV6 configuration setting, or by passing in cm6enable=1 in the URL query string.

CodeMirror 6 requires the use of NPM to bundle the dependencies. These are bundled in resources/codemirror.bundle.js, built using Rollup, and packaged as the ext.CodeMirror.v6.lib ResourceLoader module. If you make changes to the versions of the dependencies, you will need to run npm run build to update the ResourceLoader module.

NPM commands

NOTE: Consider using Fresh to run these tasks.

  • npm install to install dependencies.
  • npm run doc to generate the API documentation.
  • npm test to run the linting tools, JavaScript unit tests, and build checks.
  • npm run test:lint for linting of JS/LESS/CSS.
  • npm run test:lint:js for linting of just JavaScript.
  • npm run test:lint:styles for linting of just Less/CSS.
  • npm run test:i18n for linting of i18n messages with banana-checker.
  • npm run test:unit for the new Jest unit tests.
  • npm run selenium-test for the Selenium tests.
  • npm run build to rebundle the CodeMirror library. If changes are made to the @codemirror or @lezer dependencies in package.json, this command must be run before sending the patch or CI will fail.
  • Older QUnit tests are in resources/mode/mediawiki/tests/qunit/. These have been replaced and will be removed after the CodeMirror 6 upgrade is complete.