mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/CodeMirror
synced 2024-11-23 13:56:44 +00:00
f3f46d8e05
This adds the `ext.CodeMirror.v6.init` ResourceLoader module which allows use of CodeMirror on `#wpTextbox1` without the use of WikiEditor (the 'usebetatoolbar' preference). In order for users to opt-in to using CodeMirror, we make the existing 'usecodemirror' option into a visible preference. In addition, with two preferences related to CodeMirror, we group them under a new heading 'Syntax highlighting'. More preferences may be added later to this section following T359498. When WikiEditor is not enabled, the layout of the action=edit page has the textarea as a sibling to other visible content, like `.editOptions`. Because of this, we can't simply append the CodeMirror DOM to the parent like we were before, as that would put the visible editor beneath the edit summary, Publish button, etc. Instead we rework the CodeMirror to first add a wrapper around the textarea and use that as the parent. This way, `.cm-editor` is always in the same place in the DOM as the native textarea. Line wrapping and focus/blur events are also moved to CodeMirror, as these are needed when not using WikiEditor. Bug: T190108 Change-Id: I4bc069e0d398aa7088e4f50bbd0ddda458b289c3 |
||
|---|---|---|
| .phan | ||
| i18n | ||
| includes | ||
| resources | ||
| src | ||
| tests | ||
| .babelrc | ||
| .eslintignore | ||
| .eslintrc.json | ||
| .gitignore | ||
| .gitreview | ||
| .nvmrc | ||
| .phpcs.xml | ||
| .stylelintrc.json | ||
| CODE_OF_CONDUCT.md | ||
| composer.json | ||
| COPYING | ||
| extension.json | ||
| jest.config.js | ||
| jsdoc.json | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| rollup.config.js | ||
CodeMirror 6 homepage: https://www.mediawiki.org/wiki/Extension:CodeMirror/6
Development
As part of the upgrade to CodeMirror 6, CodeMirror now uses an asset bundler, so during development you'll need to run a script to assemble the frontend assets.
Use of CodeMirror 6 is controlled by the wgCodeMirrorV6 configuration setting, or by
passing in cm6enable=1 in the URL query string.
You can find the v6 frontend source files in src/, the compiled sources in
resources/dist/, and other frontend assets managed by ResourceLoader in
resources/*.
Commands
NOTE: Consider using Fresh to run these tasks.
npm installto install dependencies.npm startto run the bundler in watch mode, reassembling the files on file change. You'll want to keep this running in a separate terminal during development.npm run buildto compile the production assets. You must run this step before sending the patch or CI will fail (so that sources and built assets are in sync).npm run docto generate the API documentation.npm testto run the linting tools, JavaScript unit tests, and build checks.npm run test:lintfor linting of JS/LESS/CSS.npm run test:lint:jsfor linting of just JavaScript.npm run test:lint:stylesfor linting of just Less/CSS.npm run test:i18nfor linting of i18n messages with banana-checker.npm run test:unitfor the new Jest unit tests.npm run selenium-testfor the Selenium tests.- Older QUnit tests are in
resources/mode/mediawiki/tests/qunit/. These have been replaced and will be removed after the CodeMirror 6 upgrade.