Page MenuHomePhabricator
Create Task
Maniphest T359498

Add preferences panel to CodeMirror 6
Closed, ResolvedPublic
Actions

Description

Background

With the advent of CodeMirror 6, we open the door to a lot of amazing new features:

  • Autocompletion (T95100)
  • Code folding (T30684)
  • Line numbering (would take precedence over $wgCodeMirrorLineNumberingNamespaces)
  • Active line highlighting

To come later:

  • Themes (T163533)
  • Bidi isolation (T358804)
  • Modifier + clicking to open templates (T303392)
  • HTML tag matching
  • Rectangular selection
  • Linting

These are amazing, but surely won't be desired by all. Meanwhile we want to avoid adding these to Special:Preferences both to not clutter it further, but also that ideally you could customize your editor in realtime, rather than having to save your preferences and refresh.

Proposed solution

Introduce a "CodeMirror preferences" panel, akin to the one seen in CodeEditor with the ⌃+, keystroke. Here we could house all the advanced features, most of which will probably be off by default.

Turning CodeMirror on/off by itself should still be done either via the toggles shown in WikiEditor (2010) and VisualEditor-MediaWiki-2017WikitextEditor.

Relevant links:

Details

SubjectRepoBranchLines +/-
CodeMirrorWikiEditor: add button to open preferences panelmediawiki/extensions/CodeMirrormaster+58 -22
CodeMirrorPreferences: add panel to tweak prefs with the editor openmediawiki/extensions/CodeMirrormaster+628 -111
Implement dark mode styles and use Codex CSS components in search panelmediawiki/extensions/CodeMirrormaster+1 K -205
Customize query in gerrit

Related Objects
Search...

Event Timeline

MusikAnimal created this task.Mar 7 2024, 2:20 AM
Restricted Application added a project: Community-Tech. · View Herald TranscriptMar 7 2024, 2:20 AM
Restricted Application added a subscriber: Aklapper. · View Herald Transcript
MusikAnimal updated the task description. (Show Details)Mar 7 2024, 2:21 AM
MusikAnimal mentioned this in T259059: Upgrade to CodeMirror 6.
MusikAnimal updated the task description. (Show Details)Mar 7 2024, 2:25 AM
MusikAnimal moved this task from Backlog to CodeMirror 6 migration on the MediaWiki-extensions-CodeMirror board.
Tacsipacsi subscribed.Mar 14 2024, 8:05 PM

Please make the CM panel more discoverable. I know the CodeEditor panel exists, I use it every now and then, yet I struggle each time recalling/finding out the hotkey.

Meanwhile we want to avoid adding these to Special:Preferences both to not clutter it further

On the other hand, this cluttering would make it possible to configure the features in global preferences, which would probably be welcomed by people active on multiple wikis. Realtime customization would also be possible by interfacing the preferences both in Special:Preferences and in the panel (I don’t know how well it interacts with global preferences, but if someone wants global preferences, they can use that, if someone wants realtime customization, they can have that).

MusikAnimal updated the task description. (Show Details)Mar 14 2024, 10:59 PM

Good point about Global Preferences! I know I would want that. I'll see what's doable.

MusikAnimal mentioned this in T360566: CodeMirror breaks on some large RTL pages.Mar 20 2024, 8:36 PM
MusikAnimal mentioned this in T190108: Ways to opt-in/opt-out CodeMirror in 2003 Wikitext editor (without using the Toolbar).Mar 26 2024, 9:14 PM
MusikAnimal removed a project: Community-Tech.Mar 27 2024, 4:25 PM
MusikAnimal mentioned this in T95100: Add autocompletion to CodeMirror extension.Mar 28 2024, 3:54 AM
MusikAnimal mentioned this in T174811: Support JavaScript hook events for CodeMirror.Apr 13 2024, 12:12 AM
Jack_who_built_the_house subscribed.Apr 16 2024, 5:31 AM
MusikAnimal mentioned this in T347211: Enable line numbering in all namespaces for all wikis.Apr 23 2024, 8:28 PM
MusikAnimal updated the task description. (Show Details)May 14 2024, 4:28 AM
MusikAnimal updated the task description. (Show Details)
MusikAnimal updated the task description. (Show Details)Jun 7 2024, 9:33 PM
MusikAnimal mentioned this in T170001: Support CodeMirror syntax highlighting on RTL wikis.Jun 7 2024, 9:38 PM
Tholme subscribed.Jul 8 2024, 10:15 PM
MusikAnimal claimed this task.Aug 8 2024, 6:05 AM
gerritbot added a comment.Aug 8 2024, 6:49 AM

Change #1059166 had a related patch set uploaded (by MusikAnimal; author: MusikAnimal):

[mediawiki/extensions/CodeMirror@master] Implement dark mode styles and use Codex CSS components in search panel

https://gerrit.wikimedia.org/r/1059166

gerritbot added a project: Patch-For-Review.Aug 8 2024, 6:49 AM
MusikAnimal mentioned this in T357482: 2017 wikitext editor integration in CodeMirror 6.Aug 19 2024, 7:15 PM
gerritbot added a comment.Aug 20 2024, 4:47 AM

Change #1063929 had a related patch set uploaded (by MusikAnimal; author: MusikAnimal):

[mediawiki/extensions/CodeMirror@master] [WIP] CodeMirrorPreferences: panel to tweak prefs with the editor open

https://gerrit.wikimedia.org/r/1063929

MusikAnimal mentioned this in T373710: Metrics instrumentation for CodeMirror 6.Aug 30 2024, 6:37 PM
gerritbot added a comment.Sep 3 2024, 3:59 PM

Change #1059166 merged by jenkins-bot:

[mediawiki/extensions/CodeMirror@master] Implement dark mode styles and use Codex CSS components in search panel

https://gerrit.wikimedia.org/r/1059166

MusikAnimal mentioned this in T95148: Add toolbar to CodeMirror.Sep 4 2024, 1:54 AM
MusikAnimal added a parent task: T259059: Upgrade to CodeMirror 6.Sep 6 2024, 6:01 PM
Bhsd mentioned this in T376351: Insert tabs and not spaces in indented blocks in CodeMirror.Oct 3 2024, 1:58 AM
Alien333 subscribed.Wed, Nov 6, 1:24 PM
MusikAnimal mentioned this in T286270: CodeMirror does not set a default for "usecodemirror" preference, causing user_properties bloat.Wed, Nov 13, 7:52 AM
PatchDemoBot added a comment.Mon, Nov 18, 5:50 AM

Test wiki created on Patch demo by MusikAnimal using patch(es) linked to this task:
http://patchdemo.wmcloud.org/wikis/f67b3f09f0/w/

PatchDemoBot added a comment.Mon, Nov 18, 10:20 PM

Test wiki on Patch demo by MusikAnimal using patch(es) linked to this task was deleted:

http://patchdemo.wmcloud.org/wikis/f67b3f09f0/w/

PatchDemoBot added a comment.Mon, Nov 18, 10:31 PM

Test wiki created on Patch demo by MusikAnimal using patch(es) linked to this task:
http://patchdemo.wmcloud.org/wikis/89a3c214db/w/

MusikAnimal updated the task description. (Show Details)Mon, Nov 18, 10:31 PM
gerritbot added a comment.Tue, Nov 19, 4:34 AM

Change #1063929 merged by jenkins-bot:

[mediawiki/extensions/CodeMirror@master] CodeMirrorPreferences: add panel to tweak prefs with the editor open

https://gerrit.wikimedia.org/r/1063929

MusikAnimal closed this task as Resolved.Tue, Nov 19, 4:53 AM
MusikAnimal moved this task from CodeMirror 6 migration to Done on the MediaWiki-extensions-CodeMirror board.

This will go out with the Beta deployment planned for next week.

We have a system in place now to add preferences dynamically, see https://www.mediawiki.org/wiki/Extension:CodeMirror/6#Registering_an_extension_in_CodeMirror_preferences

Maintenance_bot removed a project: Patch-For-Review.Tue, Nov 19, 5:30 AM
gerritbot added a comment.Tue, Nov 19, 6:28 PM

Change #1092889 had a related patch set uploaded (by MusikAnimal; author: MusikAnimal):

[mediawiki/extensions/CodeMirror@master] CodeMirrorWikiEditor: add button to open preferences panel

https://gerrit.wikimedia.org/r/1092889

gerritbot added a project: Patch-For-Review.Tue, Nov 19, 6:28 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits