| commit | 7d3482f89e169d965bac081d65e9f8760d542974 | [log] [tgz] |
|---|---|---|
| author | MusikAnimal <[email protected]> | Thu Jun 20 23:21:09 2024 -0400 |
| committer | MusikAnimal <[email protected]> | Wed Jul 31 22:45:48 2024 -0400 |
| tree | 30d8ea885bdde2330ae461f7e0d1984c87467aae | |
| parent | f3be172173bb3d89b2374339e818c2743cdedbfc [diff] |
Isolate build step to CM6 library and restructure files to work with RL 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
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
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.
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.resources/mode/mediawiki/tests/qunit/. These have been replaced and will be removed after the CodeMirror 6 upgrade is complete.