mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/CodeMirror
synced 2024-11-23 13:56:44 +00:00
00f947e97f
The extension is custom built for MediaWiki (i.e. handling of extension tags like <ref> that aren't HTML tags), so it only makes sense to bundle it as part of the MediaWiki language mode. Resultantly, we can no longer check the direction of the textarea where we enable bidi isolation, because the language mode should have no knowledge of the textarea. Instead we offer a `config` object (akin to other language modes offered by CodeMirror), with currently only one option: `bidiIsolation`. It is the responsibility of the caller to enable this where desired. Also make templateFolding and CodeMirrorModeMediaWiki use `export default` since they both only export one thing. This commit is in preparation for Ide716247e5, where we need bidi isolation separated from the CodeMirror class due to its dependency on CodeMirrorModeMediaConfig. Bug: T358804 Bug: T214989 Change-Id: If3211bd259bd7833919a627faabd86ae7aa81b53 |
||
|---|---|---|
| .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 | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| webpack.config.js | ||
mediawiki/extensions/CodeMirror
Homepage: https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:CodeMirror
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 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.npm run test:bundlesizeto 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.
- Wikitext syntax highlighting is shown on protected pages (T301615)
Deprecations and other changes
- The
.cm-mw-mnemonicCSS class has been renamed to.cm-mw-html-entity - The
.cm-mw-template-name-mnemonicclass has been removed. Use.cm-mw-template-ground.cm-html-entityinstead. - Line-level styling for
<nowiki>,<pre>, and any tag without an associated TagMode has been removed. - The browser's native search functionality (ala Ctrl+F) has been replaced with search functionality built into CodeMirror. This is necessary to maintain performance (see T303664).