wikimedia/mediawiki-extensions-CodeMirror
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/CodeMirror synced 2024-11-23 13:56:44 +00:00
Code Issues Packages Projects Releases Wiki Activity
Mirror of https://gerrit.wikimedia.org/g/mediawiki/extensions/CodeMirror
935 commits 278 branches 0 tags 47 MiB
JavaScript 96.7%
PHP 1.7%
Less 1.6%
Go to file
MusikAnimal 880c690a10 CodeMirror6: add new modules, feature flag, and URL query parameter 
Add a new $wgCodeMirrorV6 temporary feature flag that when enabled,
will load the 'ext.CodeMirror.v6.WikiEditor' module that is built
against CodeMirror 6. You can also pass in the ?cm6enable=1 query
parameter to force use of CodeMirror 6. This is currently only
implemented for the 2010 editor.

Due to packaging constraints with CodeMirror 6, we now use Webpack to
bundle the files, which are then used by ResourceLoader. This is similar
to what is done for Extension:Popups, MobileFrontend, among other
extensions.

A new generic class CodeMirror can be used on other areas where syntax
highlighting is desirable, but not necessarily for editing (i.e. without
WikiEditor).

This commit merely lays the foundation for CodeMirror 6 and updates
WikiEditor to use it. The actual MediaWiki syntax highlighting will come
with a future commit.

With the new Webpack build, the Gruntfile was removed and the tasks
moved to npm commands.

Bug: T317243
Change-Id: I2239d2449b2db3b638551f847eb4eff1aafa6276
2023-10-09 19:51:24 -04:00
.phan Add phan 2019-04-09 20:35:56 +02:00
i18n Localisation updates from https://translatewiki.net. 2023-09-12 08:26:32 +02:00
includes CodeMirror6: add new modules, feature flag, and URL query parameter 2023-10-09 19:51:24 -04:00
resources CodeMirror6: add new modules, feature flag, and URL query parameter 2023-10-09 19:51:24 -04:00
src CodeMirror6: add new modules, feature flag, and URL query parameter 2023-10-09 19:51:24 -04:00
tests CodeMirror6: add new modules, feature flag, and URL query parameter 2023-10-09 19:51:24 -04:00
.babelrc CodeMirror6: add new modules, feature flag, and URL query parameter 2023-10-09 19:51:24 -04:00
.eslintignore build: Update linters 2023-09-13 14:02:43 +01:00
.eslintrc.json eslint: Lint Gruntile.js using server rules 2022-02-07 16:25:32 +00:00
.gitignore CodeMirror6: add new modules, feature flag, and URL query parameter 2023-10-09 19:51:24 -04:00
.gitreview Whoops, track not trace 2016-10-24 17:02:17 -07:00
.nvmrc CodeMirror6: add new modules, feature flag, and URL query parameter 2023-10-09 19:51:24 -04:00
.phpcs.xml build: Updating eslint-config-wikimedia to 0.18.2 2021-03-06 09:27:20 +00:00
.stylelintrc.json CodeMirror6: add new modules, feature flag, and URL query parameter 2023-10-09 19:51:24 -04:00
CODE_OF_CONDUCT.md build: Updating mediawiki/phan-taint-check-plugin to 1.3.0 2018-08-19 10:46:12 +00:00
composer.json build: Updating dependencies 2023-04-29 01:27:19 +00:00
COPYING CodeMirror: Add COPYING file and credit for CodeMirror authors 2020-03-02 21:34:06 +00:00
extension.json CodeMirror6: add new modules, feature flag, and URL query parameter 2023-10-09 19:51:24 -04:00
jest.config.js CodeMirror6: add new modules, feature flag, and URL query parameter 2023-10-09 19:51:24 -04:00
package-lock.json CodeMirror6: add new modules, feature flag, and URL query parameter 2023-10-09 19:51:24 -04:00
package.json CodeMirror6: add new modules, feature flag, and URL query parameter 2023-10-09 19:51:24 -04:00
README.md CodeMirror6: add new modules, feature flag, and URL query parameter 2023-10-09 19:51:24 -04:00
webpack.config.js CodeMirror6: add new modules, feature flag, and URL query parameter 2023-10-09 19:51:24 -04:00

README.md

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 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.