mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/CodeMirror
synced 2024-11-24 06:13:31 +00:00
880c690a10
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
78 lines
2.4 KiB
JavaScript
78 lines
2.4 KiB
JavaScript
const { EditorView } = require( '@codemirror/view' );
|
|
const CodeMirror = require( '../../src/codemirror.js' ).default;
|
|
const $textarea = $( '<textarea>' ),
|
|
cm = new CodeMirror( $textarea );
|
|
|
|
describe( 'initialize', () => {
|
|
const initializeWithForm = () => {
|
|
const form = document.createElement( 'form' );
|
|
form.append( cm.$textarea[ 0 ] );
|
|
cm.$textarea[ 0 ].form.addEventListener = jest.fn();
|
|
cm.initialize();
|
|
};
|
|
|
|
it( 'should create the EditorState with the value of the textarea', () => {
|
|
cm.$textarea.val( 'foobar' );
|
|
cm.$textarea.textSelection = jest.fn().mockReturnValue( 'foobar' );
|
|
cm.initialize();
|
|
expect( cm.view.state.doc.toString() ).toStrictEqual( 'foobar' );
|
|
} );
|
|
|
|
it( 'should instantiate an EditorView and add .cm-editor to the DOM', () => {
|
|
initializeWithForm();
|
|
expect( cm.view ).toBeInstanceOf( EditorView );
|
|
expect( cm.view.dom ).toBeInstanceOf( HTMLDivElement );
|
|
expect( cm.$textarea[ 0 ].nextSibling ).toStrictEqual( cm.view.dom );
|
|
} );
|
|
|
|
it( 'should hide the native textarea', () => {
|
|
cm.initialize();
|
|
expect( cm.$textarea[ 0 ].style.display ).toStrictEqual( 'none' );
|
|
} );
|
|
|
|
it( 'should add a listener for form submission', () => {
|
|
initializeWithForm();
|
|
expect( cm.$textarea[ 0 ].form.addEventListener ).toHaveBeenCalledTimes( 1 );
|
|
} );
|
|
} );
|
|
|
|
describe( 'logUsage', () => {
|
|
it( 'should track usage of CodeMirror with the correct data', () => {
|
|
cm.logUsage( {
|
|
editor: 'wikitext',
|
|
enabled: true,
|
|
toggled: false
|
|
} );
|
|
expect( mw.track ).toBeCalledWith( 'event.CodeMirrorUsage', {
|
|
editor: 'wikitext',
|
|
enabled: true,
|
|
// eslint-disable-next-line camelcase
|
|
session_token: 'abc',
|
|
toggled: false,
|
|
// eslint-disable-next-line camelcase
|
|
user_edit_count_bucket: '1000+ edits',
|
|
// eslint-disable-next-line camelcase
|
|
user_id: 123
|
|
} );
|
|
} );
|
|
} );
|
|
|
|
describe( 'setCodeMirrorPreference', () => {
|
|
beforeEach( () => {
|
|
cm.initialize();
|
|
} );
|
|
|
|
it( 'should save using the API with the correct value', () => {
|
|
cm.setCodeMirrorPreference( true );
|
|
expect( mw.Api.prototype.saveOption ).toHaveBeenCalledWith( 'usecodemirror', 1 );
|
|
expect( mw.user.options.set ).toHaveBeenCalledWith( 'usecodemirror', 1 );
|
|
} );
|
|
|
|
it( 'should not save preferences if the user is not named', () => {
|
|
mw.user.isNamed = jest.fn().mockReturnValue( false );
|
|
cm.setCodeMirrorPreference( true );
|
|
expect( mw.Api.prototype.saveOption ).toHaveBeenCalledTimes( 0 );
|
|
expect( mw.user.options.set ).toHaveBeenCalledTimes( 0 );
|
|
} );
|
|
} );
|