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
1122 commits 11 branches 15 tags 48 MiB
JavaScript 96.6%
PHP 1.8%
Less 1.6%
Go to file
MusikAnimal 27b6aaebcc CodeMirrorWikiEditor: use new icon and add text to toggle button 
For years, users have complained that the CodeMirror toggle button is
confusing and concealed. The icon looked too similar to the edit icon,
when it was supposed to be a highlighter. The new icon is similar but
has a highlighted line to help clarify what it is. We also now have the
text 'Syntax' accompanying the icon. Translators are instructed to try
to be brief to conserve space in the toolbar. "Syntax highlighting" is
the full correct term, and remains the text for the button's tooltip.

The new icon is ~0.3KB uncompressed, just meeting performance guidelines
for using @embed <https://w.wiki/AsPW>. This is also only temporary until the icon is upstreamed in Codex/OOUI.

New icon courtesy of Thiemo Kreuz (WMDE)

A corresponding change for the 2017 editor will follow I15453b33e7.

Bug: T174145
Change-Id: Ib6dbfc261214ed6672c1a54738e3401fa2f5d262
2024-08-09 06:08:33 +00:00
.phan Use service 'GadgetsRepo' instead of deprecated GadgetRepo::singleton() 2024-07-01 09:32:50 +00:00
i18n CodeMirrorWikiEditor: use new icon and add text to toggle button 2024-08-09 06:08:33 +00:00
includes Use service 'GadgetsRepo' instead of deprecated GadgetRepo::singleton() 2024-07-01 09:32:50 +00:00
resources CodeMirrorWikiEditor: use new icon and add text to toggle button 2024-08-09 06:08:33 +00:00
tests Isolate build step to CM6 library and restructure files to work with RL 2024-07-31 22:45:48 -04:00
.eslintignore build: Update eslint-config-wikimedia to 0.28.2 and autofix 2024-06-17 13:02:26 +00:00
.eslintrc.json eslint: Lint Gruntile.js using server rules 2022-02-07 16:25:32 +00:00
.gitignore CM6: Add jsdoc build step, fix JSDoc annotations, and add @stable tags 2024-03-26 13:35:47 -04:00
.gitreview Whoops, track not trace 2016-10-24 17:02:17 -07:00
.nvmrc .nvmrc: Update version from 18.17.0 to 18.20.2 2024-05-30 22:04:13 -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 2024-05-08 07:35:28 +00:00
COPYING CodeMirror: Add COPYING file and credit for CodeMirror authors 2020-03-02 21:34:06 +00:00
extension.json CodeMirrorWikiEditor: use new icon and add text to toggle button 2024-08-09 06:08:33 +00:00
jest.config.js CodeMirror6: add new modules, feature flag, and URL query parameter 2023-10-09 19:51:24 -04:00
jsdoc.json Isolate build step to CM6 library and restructure files to work with RL 2024-07-31 22:45:48 -04:00
package-lock.json Isolate build step to CM6 library and restructure files to work with RL 2024-07-31 22:45:48 -04:00
package.json CodeMirrorWikiEditor: use new icon and add text to toggle button 2024-08-09 06:08:33 +00:00
README.md Isolate build step to CM6 library and restructure files to work with RL 2024-07-31 22:45:48 -04:00
rollup.config.js Isolate build step to CM6 library and restructure files to work with RL 2024-07-31 22:45:48 -04:00

README.md

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

Development

Preface

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.

NPM commands

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.
  • Older QUnit tests are in resources/mode/mediawiki/tests/qunit/. These have been replaced and will be removed after the CodeMirror 6 upgrade is complete.