wikimedia/mediawiki-extensions-CodeMirror
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/CodeMirror synced 2024-09-23 18:28:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
Mirror of https://gerrit.wikimedia.org/g/mediawiki/extensions/CodeMirror
967 commits 268 branches 0 tags 83 MiB
JavaScript 96.4%
PHP 1.8%
Less 1.8%
Go to file
MusikAnimal c670344851 Implement core MediaWiki stream parser for CodeMirror 6 
This is more or less a exact port of the old stream parser, with the big
notable change being that all configuration-related code lives in a
separate class, CodeMirrorModeMediaWikiConfig. A smaller change is that
closing HTML tags that are marked as errors now have the ending '>'
character highlighted red, when it didn't before.

Integration with other extensions and modes is saved for a future patch
(T348684). This means <nowiki>, <ref> and other extension-supplied
markup is not yet highlighted.

The entry point for WikiEditor integration is now at
ext.CodeMirror.v6.WikiEditor.init.js, which needs to first require the
virtual file set via the DataScript (PHP) class. This can't be
integrated into the CM6 code because it needs to be precompiled before
ResourceLoader can use it (T281781).

Known issues, to be addressed separately:

* No support for TagModes / PluginModes (T348684)
* Identical adjacent tokens produce excess markup (T352917)
* Section headings do not have line-level styling (T351686)

Bug: T348019
Change-Id: I8f8a81f362bed60dea14ecde9487a2b0c89225e8
2024-01-02 23:18:32 -05:00
.phan Add phan 2019-04-09 20:35:56 +02:00
i18n Localisation updates from https://translatewiki.net. 2023-11-13 08:40:33 +01:00
includes Implement core MediaWiki stream parser for CodeMirror 6 2024-01-02 23:18:32 -05:00
resources Implement core MediaWiki stream parser for CodeMirror 6 2024-01-02 23:18:32 -05:00
src Implement core MediaWiki stream parser for CodeMirror 6 2024-01-02 23:18:32 -05:00
tests Implement core MediaWiki stream parser for CodeMirror 6 2024-01-02 23:18:32 -05:00
.babelrc Implement core MediaWiki stream parser for CodeMirror 6 2024-01-02 23:18:32 -05: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 Implement core MediaWiki stream parser for CodeMirror 6 2024-01-02 23:18:32 -05: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 Implement core MediaWiki stream parser for CodeMirror 6 2024-01-02 23:18:32 -05:00
package.json Implement core MediaWiki stream parser for CodeMirror 6 2024-01-02 23:18:32 -05:00
README.md Implement core MediaWiki stream parser for CodeMirror 6 2024-01-02 23:18:32 -05:00
webpack.config.js Implement core MediaWiki stream parser for CodeMirror 6 2024-01-02 23:18:32 -05: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.

CodeMirror 6 change log

Upstream changes

This list changes that come by default with the CodeMirror 6 upgrade. Some may be removed pending user feedback:

  • 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 '>'