mediawiki-extensions-CodeMi.../README.md

CodeMirror 6 homepage: [https://www.mediawiki.org/wiki/Extension:CodeMirror/6](https://www.mediawiki.org/wiki/Extension:CodeMirror/6)

## Development

As part of the [upgrade to CodeMirror 6](https://phabricator.wikimedia.org/T259059),
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](https://gerrit.wikimedia.org/g/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.

## CodeMirror 6 change log

* See [Extension:CodeMirror/6](https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:CodeMirror/6#Differences_from_CodeMirror_5)
CM6: Add jsdoc build step, fix JSDoc annotations, and add @stable tags There is a known bug with JSDoc and using `export default`. These must be separate statements for JSDoc to parse properly. See https://github.com/jsdoc/jsdoc/issues/1132 Update README; change log now lives on the wiki. Bug: T359986 Depends-On: I58a0766e35eddaf7bebe2c080757bb09963d8555 Change-Id: Ibc2212ef9eab512511b13a99ecc2ccbda8c52ece 2024-03-19 03:10:11 +00:00			`CodeMirror 6 homepage: [https://www.mediawiki.org/wiki/Extension:CodeMirror/6](https://www.mediawiki.org/wiki/Extension:CodeMirror/6)`
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-09-19 17:59:29 +00:00
			`## Development`

			`As part of the [upgrade to CodeMirror 6](https://phabricator.wikimedia.org/T259059),`
			`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](https://gerrit.wikimedia.org/g/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).`
CM6: Add jsdoc build step, fix JSDoc annotations, and add @stable tags There is a known bug with JSDoc and using `export default`. These must be separate statements for JSDoc to parse properly. See https://github.com/jsdoc/jsdoc/issues/1132 Update README; change log now lives on the wiki. Bug: T359986 Depends-On: I58a0766e35eddaf7bebe2c080757bb09963d8555 Change-Id: Ibc2212ef9eab512511b13a99ecc2ccbda8c52ece 2024-03-19 03:10:11 +00:00			* `npm run doc` to generate the API documentation.
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-09-19 17:59:29 +00:00			* `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.
CM6: Add jsdoc build step, fix JSDoc annotations, and add @stable tags There is a known bug with JSDoc and using `export default`. These must be separate statements for JSDoc to parse properly. See https://github.com/jsdoc/jsdoc/issues/1132 Update README; change log now lives on the wiki. Bug: T359986 Depends-On: I58a0766e35eddaf7bebe2c080757bb09963d8555 Change-Id: Ibc2212ef9eab512511b13a99ecc2ccbda8c52ece 2024-03-19 03:10:11 +00:00			* Older QUnit tests are in `resources/mode/mediawiki/tests/qunit/`. These have been
			`replaced and will be removed after the CodeMirror 6 upgrade.`
CodeMirrorWikiEditor: add bracketMatching as default extension By default, this feature highlights unmatched brackets when the cursor is placed over it. This can be disabled, but seems useful so we'll add it as one of the new features in README and see how users react. Bug: T348019 Change-Id: Ie6af715e40aeb8217a7c4dfe0c6e6a3dcfa725d5 2023-12-06 05:52:51 +00:00
			`## CodeMirror 6 change log`

CM6: Add jsdoc build step, fix JSDoc annotations, and add @stable tags There is a known bug with JSDoc and using `export default`. These must be separate statements for JSDoc to parse properly. See https://github.com/jsdoc/jsdoc/issues/1132 Update README; change log now lives on the wiki. Bug: T359986 Depends-On: I58a0766e35eddaf7bebe2c080757bb09963d8555 Change-Id: Ibc2212ef9eab512511b13a99ecc2ccbda8c52ece 2024-03-19 03:10:11 +00:00			`* See [Extension:CodeMirror/6](https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:CodeMirror/6#Differences_from_CodeMirror_5)`