mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/CodeMirror
synced 2024-11-23 22:03:28 +00:00
380ec9d1ce
This is essentially the CM6-style variant of the same code used for TagModes in CM5. The big difference is in CM6, every tag must be registered in order to be used. We do this dynamically when CodeMirrorModeMediaWiki is intantiated. As of this patch only tags that contain mediawiki (formerly 'text/mediawiki') are supported, such as <ref>. The CM6 tag registration surfaced an old bug, now fixed: when using different capitalization on extension-supplied tags, the CSS class name used to match that. I.e. <REF> would produce .cm-mw-ext-REF, when it should be .cm-mw-ext-ref Also remove the old line-level styles. With I17b1f0b7a6, line-level styling was added for section headings. Doing the same for tags like <nowiki> and <pre> isn't as important, and can be addressed later or not at all. Add test case for extension tag with no supplied TagMode Other minor cleanup, including removing old commented out code Bug: T348684 Change-Id: Ibfff1fc6eacc42b95f557abb40774a65c46ba373
61 lines
2.5 KiB
Markdown
61 lines
2.5 KiB
Markdown
# mediawiki/extensions/CodeMirror
|
|
|
|
Homepage: https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:CodeMirror
|
|
|
|
## Development
|
|
|
|
As part of the [upgrade to CodeMirror 6](https://phabricator.wikimedia.org/T259059),
|
|
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](https://gerrit.wikimedia.org/g/fresh/) to run these tasks._
|
|
|
|
* `npm install` to install dependencies.
|
|
* `npm start` to 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 build` to 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 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 test:bundlesize` to test if the gzip'd entrypoint is of acceptable size.
|
|
|
|
Older QUnit tests are in `resources/mode/mediawiki/tests/qunit/`. These will
|
|
eventually be moved over to `tests/qunit` and rewritten for CodeMirror 6.
|
|
|
|
## CodeMirror 6 change log
|
|
|
|
This is a list of changes that either come by default with the CodeMirror 6 upgrade,
|
|
or changes of our that we deem as reasonable improvements.
|
|
Some may be removed pending user feedback:
|
|
|
|
### Upstream changes
|
|
|
|
* Bracket matching now highlights unmatched brackets in red
|
|
|
|
### New MediaWiki mode features
|
|
|
|
* Closing HTML tags that highlighted as an error now also highlight the closing '>'
|
|
* Allow link titles to be both emboldened and italicized.
|
|
|
|
### Deprecations and other changes
|
|
|
|
* 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.
|
|
* Line-level styling for `<nowiki>`, `<pre>`, and any tag without an associated
|
|
TagMode has been removed.
|