Page MenuHomePhabricator
Create Task
Maniphest T407154

API-powered linting for JavaScript using Peast
Open, Needs TriagePublic
Actions

Description

This task is about the JavaScript portion of T394965: Provide API-powered linting of supported languages in CodeMirror. See parent task for details applicable to all modes/languages we plan to support.

The Peast PHP package is what is used to validate on-wiki JS. It looks like in order to make it available to client, we'll need to create our own API module for it and call Peast::ES2017() directly.

Testing needs to be done to see if this is quick enough to query continuously in the background, like we are doing for T407153. If it's too slow, linting can be provided by a call-to-action (keyboard shortcut, or a button in the WikiEditor toolbar).

Details

Related Changes in Gerrit:
SubjectRepoBranchLines +/-
api: return Peast errors only for pages that need to pass validationmediawiki/extensions/CodeMirrormaster+179 -1
Add API module for server-side content validationmediawiki/extensions/CodeMirrormaster+416 -2
Customize query in gerrit

Related Objects
Search...

Event Timeline

• MusikAnimal created this task.Oct 13 2025, 6:38 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptOct 13 2025, 6:38 PM
• MusikAnimal mentioned this in T394965: Provide API-powered linting of supported languages in CodeMirror.Oct 13 2025, 6:46 PM
Bugreporter subscribed.Oct 14 2025, 1:26 AM

Please note Wikifunction's implementation code editor uses ES2023 instead of ES2017.

Bhsd moved this task from Backlog to Improvement on the MediaWiki-extensions-CodeMirror board.Oct 14 2025, 8:07 PM
Mr._Starfleet_Command subscribed.Dec 13 2025, 8:37 PM
gerritbot added a comment.Fri, Dec 19, 8:00 PM

Change #1219938 had a related patch set uploaded (by SD0001; author: SD0001):

[mediawiki/extensions/CodeMirror@master] Add API module for server-side content validation

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

gerritbot added a project: Patch-For-Review.Fri, Dec 19, 8:00 PM
gerritbot added a comment.Sun, Jan 4, 12:56 AM

Change #1219938 merged by jenkins-bot:

[mediawiki/extensions/CodeMirror@master] Add API module for server-side content validation

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

Maintenance_bot removed a project: Patch-For-Review.Sun, Jan 4, 1:30 AM
Bhsd added subscribers: SD0001, Bhsd.Sun, Jan 4, 7:55 AM

@SD0001 Thank you for creating the new API modules!

Do you know how we can determine whether a JavaScript page should pass Peast (so that we should use the Peast API for linting)?

SD0001 added a comment.Mon, Jan 5, 11:32 AM

The list of pages that need to pass can be obtained by going through every WikiModule in the module registry and calling getPages() on them. This isn't exposed client-side, but it can be done within the API implementation. Not sure how we want to expose it:

  • Validate to ES2017 for pages needing to pass Peast, and ES2024 for other pages? (The API caller won't be able to tell what standard was used for validation.)
  • Send error code syntax-error for issues on pages that need to be compliant, and syntax-warning for other pages?

The other way is to just do some pattern-matching: MediaWiki:Gadget-*.js, MediaWiki:(common|<skin>).js, MediaWiki:Group-<group>.js, User:<username>/(common|<skin>).js. But this would miss WikiModules registered by other extensions (eg. MediaWiki:WikiLove.js, MediaWiki:Kartographer.js, User:<username>/global.js) unless we do a lot of special cases and checking of installed extensions.

Bhsd added a comment.Tue, Jan 6, 6:34 AM
In T407154#11491430, @SD0001 wrote:
  • Validate to ES2017 for pages needing to pass Peast, and ES2024 for other pages?
  • Send error code syntax-error for issues on pages that need to be compliant, and syntax-warning for other pages?

I think we can just skip pages that will not be processed by ResourceLoader.

gerritbot added a comment.Tue, Jan 13, 4:19 PM

Change #1226290 had a related patch set uploaded (by SD0001; author: SD0001):

[mediawiki/extensions/CodeMirror@master] api: return Peast errors only for pages that need to pass validation

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

gerritbot added a project: Patch-For-Review.Tue, Jan 13, 4:19 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