mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/CodeMirror
synced 2024-11-23 13:56:44 +00:00
ca6eb17ffe
Change-Id: Ibf686ea7289ef5882b17cb5c63e982117364b2ed |
||
---|---|---|
.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 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 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.- Older QUnit tests are in
resources/mode/mediawiki/tests/qunit/
. These have been replaced and will be removed after the CodeMirror 6 upgrade.