mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/CodeMirror
synced 2024-11-27 15:40:00 +00:00
925775778a
Add new temporary ext.CodeMirror.visualEditor.init RL module which selects the temporary ext.CodeMirror.visualEditor.v6 or non-v6 based on $wgCodeMirrorV6. This will allow us to deploy CM6 further. As a result of this work, the core CodeMirror class now has knowledge of ve.ui.Surface. Other changes: * Add Compartment for specialCharsExtension so it can be disabled in VE. * Add option to mediaWikiLang() to disable template folding. * Add support for RTL wikis where $wgCodeMirrorRTL is enabled. * Make CodeMirror.logUsage() and setCodeMirrorPreference() static. * Fix unit and linting tests. Some code courtesy of Fandom, GPLv2-or-later; see: https://github.com/Wikia/mediawiki-extensions-CodeMirror/commit/ef297c48c Bug: T357482 Change-Id: I15453b33e77e1c1b4d5e5183e41e53d56ff14c3e
100 lines
3.3 KiB
JavaScript
100 lines
3.3 KiB
JavaScript
/* eslint-disable-next-line n/no-missing-require */
|
|
const { EditorView } = require( 'ext.CodeMirror.v6.lib' );
|
|
const CodeMirror = require( '../../resources/codemirror.js' );
|
|
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 set the height to the same as the textarea', () => {
|
|
$textarea.css( 'height', '100px' );
|
|
cm.initialize();
|
|
// 100 + 6 (padding/border) = 106
|
|
expect( $( cm.view.dom ).height() ).toStrictEqual( 106 );
|
|
} );
|
|
|
|
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 );
|
|
} );
|
|
|
|
it( 'should retain the mw-editfont- class present on the textarea', () => {
|
|
cm.$textarea.addClass( 'mw-editfont-monospace' );
|
|
cm.initialize();
|
|
expect( cm.view.dom.querySelector( '.cm-content' ).classList ).toContain( 'mw-editfont-monospace' );
|
|
} );
|
|
|
|
it( "should copy the 'dir' and 'lang' attributes of the textarea to .cm-editor", () => {
|
|
cm.$textarea.prop( 'dir', 'rtl' )
|
|
.prop( 'lang', 'ar' );
|
|
cm.initialize();
|
|
expect( cm.view.dom.getAttribute( 'dir' ) ).toStrictEqual( 'rtl' );
|
|
expect( cm.view.dom.getAttribute( 'lang' ) ).toStrictEqual( 'ar' );
|
|
} );
|
|
} );
|
|
|
|
describe( 'logUsage', () => {
|
|
it( 'should track usage of CodeMirror with the correct data', () => {
|
|
CodeMirror.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', () => {
|
|
CodeMirror.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 );
|
|
CodeMirror.setCodeMirrorPreference( true );
|
|
expect( mw.Api.prototype.saveOption ).toHaveBeenCalledTimes( 0 );
|
|
expect( mw.user.options.set ).toHaveBeenCalledTimes( 0 );
|
|
} );
|
|
} );
|