mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/CodeMirror
synced 2024-12-18 16:50:36 +00:00
7d3482f89e
CodeMirror 6 requires the use of NPM, but we can still bundle all CM packages into one file, and then everything else (i.e. our code) is managed by ResourceLoader as per usual. This makes contribution considerably easier as we no longer need a build step for each change. CM5 files are now under resources/legacy, and the CM6 files are moved to the root of the resources/ directory. Only one file, codemirror.bundle.js, is managed by Rollup, while everything else is RL. The Rollup output for now is put under resources/lib/ alongside the CM5 upstream files. This patch is *mostly* renames of files, along with changing ECMAScript Module (ESM) syntax into the CommonJS style that ResourceLoader prefers. We also remove more modern JS syntax (i.e. private class methods) that we were able to use before because we had a build step with Babel. This patch should effectively make no user-facing changes, or to the ResourceLoader modules we offer in Extension:CodeMirror. Finally, bump version in extension.json to 6, to match the upstream lib, and add Bhsd as an author :-) Bug: T368053 Change-Id: Ie258e49f5df8db23a7344ac3c4c9300aaa991042
41 lines
2.1 KiB
Markdown
41 lines
2.1 KiB
Markdown
The CodeMirror extension provides syntax highlighting in MediaWiki wikitext editors using
|
|
the [CodeMirror library](https://codemirror.net/).
|
|
|
|
CodeMirror 6 homepage: [https://www.mediawiki.org/wiki/Extension:CodeMirror/6](https://www.mediawiki.org/wiki/Extension:CodeMirror/6)
|
|
|
|
JS documentation: [https://doc.wikimedia.org/CodeMirror](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](https://www.mediawiki.org/wiki/Extension:CodeMirror/6#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](resources/codemirror.bundle.js), built using [Rollup](https://rollupjs.org/),
|
|
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](https://gerrit.wikimedia.org/g/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](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.
|