Page MenuHomePhabricator

Fix jsduck warnings in Wikispeech
Closed, ResolvedPublic

Description

Running jsduck on the Wikispeech direcotry (using composer doc) results in the following warnings

Warning: /vagrant/mediawiki/extensions/Wikispeech/modules/ext.wikispeech.loader.js:3: Unnamed property
Warning: /vagrant/mediawiki/extensions/Wikispeech/jsduck-categories.json Class 'global' not found in categories file
Warning: /vagrant/mediawiki/extensions/Wikispeech/modules/ext.wikispeech.ui.js:97: Unknown type OO.ui.ButtonGroupWidget
Warning: /vagrant/mediawiki/extensions/Wikispeech/modules/ext.wikispeech.ui.js:97: Unknown type OO.ui.ButtonWidget
Warning: /vagrant/mediawiki/extensions/Wikispeech/modules/ext.wikispeech.ui.js:205: Unknown type OO.ui.ButtonGroupWidget
Warning: /vagrant/mediawiki/extensions/Wikispeech/modules/ext.wikispeech.storage.js:170: Unknown type jQuery.Promise

Event Timeline

On vagrant jsduck must first be installed using sudo gem install jsduck

adding OO.ui.* and jQuery.Promise to --external in jsduck.json should fix most of these. Unsure about the first though.

In general we should be aware of T138401: Replace jsduck with JSDoc3 across all Wikimedia code bases

Change 640922 had a related patch set uploaded (by Lokal Profil; owner: Lokal Profil):
[mediawiki/extensions/Wikispeech@master] Fix jsduck warnings

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

Class 'global' not found in categories file is caused by the issue with ext.wikispeech.loader.js:3

Change 641388 had a related patch set uploaded (by Lokal Profil; owner: Lokal Profil):
[mediawiki/extensions/Wikispeech@master] Fix jsduck warning

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

Change 640922 merged by jenkins-bot:
[mediawiki/extensions/Wikispeech@master] Fix jsduck Unknown type warnings

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

Change 641388 merged by jenkins-bot:
[mediawiki/extensions/Wikispeech@master] Fix jsduck warning

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