mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/CodeMirror
synced 2024-12-13 14:48:16 +00:00
7d3482f89e
CodeMirror 6 requires the use of NPM, but we can still bundle all CM packages into one file, and then everything else (i.e. our code) is managed by ResourceLoader as per usual. This makes contribution considerably easier as we no longer need a build step for each change. CM5 files are now under resources/legacy, and the CM6 files are moved to the root of the resources/ directory. Only one file, codemirror.bundle.js, is managed by Rollup, while everything else is RL. The Rollup output for now is put under resources/lib/ alongside the CM5 upstream files. This patch is *mostly* renames of files, along with changing ECMAScript Module (ESM) syntax into the CommonJS style that ResourceLoader prefers. We also remove more modern JS syntax (i.e. private class methods) that we were able to use before because we had a build step with Babel. This patch should effectively make no user-facing changes, or to the ResourceLoader modules we offer in Extension:CodeMirror. Finally, bump version in extension.json to 6, to match the upstream lib, and add Bhsd as an author :-) Bug: T368053 Change-Id: Ie258e49f5df8db23a7344ac3c4c9300aaa991042
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', () => {
|
|
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 );
|
|
} );
|
|
} );
|