mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/CodeMirror
synced 2024-11-27 15:40:00 +00:00
81ec0c292a
Use Codex design tokens where possible, and implement custom dark theming for things for which there is no suitable design token. This means we're changing the colors for light mode ever so slightly. We need to style the search panel for dark mode, so we might as well tackle T371436 and use CSS-only Codex components. The same is done for the "Go to line" panel (can be opened with Mod+Alt+g). The messages in this panel are now also localizable. The search panel (and goto line panel) are abstracted, with helpers to create the Codex components. These will not only be used here but also for the upcoming preferences panel (T359498). Visually, the search and goto panels were inspired by the 2017 editor and share a similar layout. CodeMirror similarly uses a more compact design than usual to maximize the real estate of the editor itself. Other changes: * Bump codemirror/search to get latest bug fixes * Remove stylelint ignorance and fix errors * Move CM5 styles to ext.CodeMirror.less * Move CM-specific styles out of mediawiki.less and into codemirror.less * Move WikiEditor-specific styles to codemirror.wikieditor.less (incidentally, these only apply to CodeMirror 6) * Correct qqq documentation; the "dialog" should be called a "panel" * extension.json: alphabetize list of messages Bug: T365311 Bug: T371436 Bug: T359498 Change-Id: I6a3bbc6bce4e490886753ff484e377c1763de456
174 lines
4.3 KiB
JavaScript
174 lines
4.3 KiB
JavaScript
const {
|
|
EditorSelection,
|
|
EditorView,
|
|
Prec,
|
|
StateEffect,
|
|
StateEffectType,
|
|
StateField,
|
|
keymap,
|
|
showPanel
|
|
} = require( 'ext.CodeMirror.v6.lib' );
|
|
const CodeMirrorPanel = require( './codemirror.panel.js' );
|
|
|
|
/**
|
|
* Custom goto line panel for CodeMirror using CSS-only Codex components.
|
|
*
|
|
* Using the Alt-g keybinding, this shows a panel asking the user for a line number,
|
|
* when a valid position is provided, moves the cursor to that line.
|
|
*
|
|
* This feature supports line numbers, relative line offsets prefixed with `+` or `-`,
|
|
* document percentages suffixed with `%`, and an optional column position by adding `:`
|
|
* and a second number after the line number.
|
|
*
|
|
* Based on the CodeMirror implementation (MIT).
|
|
*
|
|
* @see https://github.com/codemirror/search/blob/0d8af3e4cc/src/goto-line.ts
|
|
* @extends CodeMirrorPanel
|
|
*/
|
|
class CodeMirrorGotoLine extends CodeMirrorPanel {
|
|
constructor() {
|
|
super();
|
|
|
|
/**
|
|
* @type {StateEffectType}
|
|
*/
|
|
this.toggleEffect = StateEffect.define();
|
|
|
|
/**
|
|
* @type {StateField}
|
|
*/
|
|
this.panelStateField = StateField.define( {
|
|
create: () => true,
|
|
update: ( value, transaction ) => {
|
|
for ( const e of transaction.effects ) {
|
|
if ( e.is( this.toggleEffect ) ) {
|
|
value = e.value;
|
|
}
|
|
}
|
|
|
|
return value;
|
|
},
|
|
// eslint-disable-next-line arrow-body-style
|
|
provide: ( stateField ) => {
|
|
// eslint-disable-next-line arrow-body-style
|
|
return showPanel.from( stateField, ( on ) => {
|
|
return on ? () => this.panel : null;
|
|
} );
|
|
}
|
|
} );
|
|
|
|
/**
|
|
* @type {HTMLInputElement}
|
|
*/
|
|
this.input = undefined;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
get extension() {
|
|
// Use Prec.highest to ensure that this keymap is used before the default searchKeymap.
|
|
return Prec.highest(
|
|
keymap.of( {
|
|
key: 'Mod-Alt-g',
|
|
run: ( view ) => {
|
|
this.view = view;
|
|
const effects = [ this.toggleEffect.of( true ) ];
|
|
if ( !this.view.state.field( this.panelStateField, false ) ) {
|
|
effects.push( StateEffect.appendConfig.of( [ this.panelStateField ] ) );
|
|
}
|
|
this.view.dispatch( { effects } );
|
|
return true;
|
|
}
|
|
} )
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
get panel() {
|
|
const container = document.createElement( 'div' );
|
|
container.className = 'cm-mw-goto-line-panel cm-mw-panel cm-mw-panel--row';
|
|
container.addEventListener( 'keydown', this.onKeydown.bind( this ) );
|
|
|
|
// Line input.
|
|
const [ inputWrapper, input ] = this.getTextInput( 'line', this.line );
|
|
this.input = input;
|
|
container.appendChild( inputWrapper );
|
|
|
|
// Go button.
|
|
const button = this.getButton( 'codemirror-goto-line-go' );
|
|
button.addEventListener( 'click', this.go.bind( this ) );
|
|
container.appendChild( button );
|
|
|
|
return {
|
|
dom: container,
|
|
top: true,
|
|
mount: () => {
|
|
this.input.value = String(
|
|
this.view.state.doc.lineAt(
|
|
this.view.state.selection.main.head
|
|
).number
|
|
);
|
|
this.input.focus();
|
|
this.input.select();
|
|
}
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Respond to keydown events.
|
|
*
|
|
* @param {KeyboardEvent} event
|
|
*/
|
|
onKeydown( event ) {
|
|
if ( event.key === 'Escape' ) {
|
|
event.preventDefault();
|
|
this.view.dispatch( { effects: this.toggleEffect.of( false ) } );
|
|
this.view.focus();
|
|
} else if ( event.key === 'Enter' ) {
|
|
event.preventDefault();
|
|
this.go();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Go to the specified line.
|
|
*/
|
|
go() {
|
|
const match = /^([+-])?(\d+)?(:\d+)?(%)?$/.exec( this.input.value );
|
|
if ( !match ) {
|
|
return;
|
|
}
|
|
const { state } = this.view;
|
|
const startLine = state.doc.lineAt( state.selection.main.head );
|
|
const [ , sign, ln, cl, percent ] = match;
|
|
const col = cl ? +cl.slice( 1 ) : 0;
|
|
let line = ln ? +ln : startLine.number;
|
|
if ( ln && percent ) {
|
|
let pc = line / 100;
|
|
if ( sign ) {
|
|
pc = pc * ( sign === '-' ? -1 : 1 ) + ( startLine.number / state.doc.lines );
|
|
}
|
|
line = Math.round( state.doc.lines * pc );
|
|
} else if ( ln && sign ) {
|
|
line = line * ( sign === '-' ? -1 : 1 ) + startLine.number;
|
|
}
|
|
const docLine = state.doc.line( Math.max( 1, Math.min( state.doc.lines, line ) ) );
|
|
const selection = EditorSelection.cursor(
|
|
docLine.from + Math.max( 0, Math.min( col, docLine.length ) )
|
|
);
|
|
this.view.dispatch( {
|
|
effects: [
|
|
this.toggleEffect.of( false ),
|
|
EditorView.scrollIntoView( selection.from, { y: 'center' } )
|
|
],
|
|
selection
|
|
} );
|
|
this.view.focus();
|
|
}
|
|
}
|
|
|
|
module.exports = CodeMirrorGotoLine;
|