wikimedia/mediawiki-extensions-CodeMirror
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/CodeMirror synced 2024-11-27 15:40:00 +00:00
Code Issues Packages Projects Releases Wiki Activity
Mirror of https://gerrit.wikimedia.org/g/mediawiki/extensions/CodeMirror
974 commits 11 branches 15 tags 48 MiB
JavaScript 96.6%
PHP 1.8%
Less 1.6%
Go to file
MusikAnimal 380ec9d1ce CodeMirrorModeMediaWiki: add support for mediawiki TagModes 
This is essentially the CM6-style variant of the same code used for
TagModes in CM5. The big difference is in CM6, every tag must be
registered in order to be used. We do this dynamically when
CodeMirrorModeMediaWiki is intantiated. As of this patch only tags
that contain mediawiki (formerly 'text/mediawiki') are supported,
such as <ref>.

The CM6 tag registration surfaced an old bug, now fixed: when using
different capitalization on extension-supplied tags, the CSS class name
used to match that. I.e. <REF> would produce .cm-mw-ext-REF, when it
should be .cm-mw-ext-ref

Also remove the old line-level styles. With I17b1f0b7a6, line-level
styling was added for section headings. Doing the same for tags like
<nowiki> and <pre> isn't as important, and can be addressed later or
not at all.

Add test case for extension tag with no supplied TagMode

Other minor cleanup, including removing old commented out code

Bug: T348684
Change-Id: Ibfff1fc6eacc42b95f557abb40774a65c46ba373
2024-01-16 15:30:22 -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 CodeMirrorModeMediaWiki: add support for mediawiki TagModes 2024-01-16 15:30:22 -05:00
src CodeMirrorModeMediaWiki: add support for mediawiki TagModes 2024-01-16 15:30:22 -05:00
tests CodeMirrorModeMediaWiki: add support for mediawiki TagModes 2024-01-16 15:30:22 -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 .nvmrc: Update now we're using Node 18 2024-01-11 11:05:51 -05: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 .nvmrc: Update now we're using Node 18 2024-01-11 11:05:51 -05:00
package.json .nvmrc: Update now we're using Node 18 2024-01-11 11:05:51 -05:00
README.md CodeMirrorModeMediaWiki: add support for mediawiki TagModes 2024-01-16 15:30:22 -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

This is a list of changes that either come by default with the CodeMirror 6 upgrade, or changes of our that we deem as reasonable improvements. Some may be removed pending user feedback:

Upstream changes

  • 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 '>'
  • Allow link titles to be both emboldened and italicized.

Deprecations and other changes

  • The .cm-mw-mnemonic CSS class has been renamed to .cm-mw-html-entity
  • The .cm-mw-template-name-mnemonic class has been removed. Use .cm-mw-template-ground.cm-html-entity instead.
  • Line-level styling for <nowiki>, <pre>, and any tag without an associated TagMode has been removed.