Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update jsdoc-wmf-theme from 1.0.1 to 1.1.0

Browse source 
* Use the new default set of plugins
* Remove prefixMap since that is now handled by the theme
* Remove linkMap items provided by the theme
* Replace the JSDoc-specific package.json with a maintitle
  and README h1
* Add node_modules/jsdoc-class-hierarchy as a dependency.
  This plugin isn't currently used in core, but it is part
  of the default plugin set.

Bug: T368081
Change-Id: Ib2b16b2f4c5f11ff29cc6dc5d67df43bc59c9752
This commit is contained in:
apaskulin 2024-06-25 08:53:10 -07:00 committed by Alex Paskulin
parent a377aaa495
commit 139160aabc
5 changed files with 29 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
jsdoc.json
View file

@ -1,7 +1,6 @@
{
"opts": {
"destination": "docs/js",
"package": "resources/package.json",
"pages": {
"modules": {
"longname": "Modules",
@ -19,11 +18,7 @@
"template": "node_modules/jsdoc-wmf-theme"
},
"plugins": [
"node_modules/jsdoc-wmf-theme/plugins/allow-dots-in-modules",
"plugins/markdown",
"node_modules/jsdoc-wmf-theme/plugins/externals",
"node_modules/jsdoc-wmf-theme/plugins/summarize",
"node_modules/jsdoc-wmf-theme/plugins/betterlinks"
"node_modules/jsdoc-wmf-theme/plugins/default"
],
"source": {
"include": [
@ -38,41 +33,18 @@
"useLongnameInNav": true
},
"wmf": {
"maintitle": "MediaWiki Frontend API",
"siteMap": {
"sections": true
},
"hideSections": [ "Classes", "Events" ],
"repository": "https://gerrit.wikimedia.org/g/mediawiki/core/",
"prefixMap": {
"OO.ui.": "https://doc.wikimedia.org/oojs-ui/master/js/{type}.html",
"OO.": "https://doc.wikimedia.org/oojs/master/{type}.html"
},
"linkMap": {
"Array": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array",
"Blob": "https://developer.mozilla.org/docs/Web/API/Blob",
"boolean": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean",
"CSSStyleSheet": "https://developer.mozilla.org/docs/Web/API/CSSStyleSheet",
"Date": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date",
"Event": "https://developer.mozilla.org/docs/Web/API/Event",
"File": "https://developer.mozilla.org/docs/Web/API/File",
"Function": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function",
"HTMLElement": "https://developer.mozilla.org/docs/Web/API/HTMLElement",
"HTMLInputElement": "https://developer.mozilla.org/docs/Web/API/HTMLInputElement",
"HTMLStyleElement": "https://developer.mozilla.org/docs/Web/API/HTMLStyleElement",
"jQuery.Deferred": "https://api.jquery.com/Types/#Deferred",
"jQuery.Event": "https://api.jquery.com/Types/#Event",
"jQuery.fn": "https://api.jquery.com/jQuery/",
"jQuery.Promise": "https://api.jquery.com/Types/#Promise",
"jQuery": "https://api.jquery.com/jQuery/",
"JSON.parse": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse",
"Node": "https://developer.mozilla.org/docs/Web/API/Node",
"number": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number",
"Object": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object",
"Promise": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise",
"RegExp": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp",
"Set": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set",
"string": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String",
"URLSearchParams": "https://developer.mozilla.org/docs/Web/API/URLSearchParams"
"string": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String"
}
}
}

30
package-lock.json generated
View file

@ -24,7 +24,7 @@
"grunt-karma": "4.0.2",
"grunt-stylelint": "0.20.0",
"jsdoc": "4.0.2",
"jsdoc-wmf-theme": "1.0.1",
"jsdoc-wmf-theme": "1.1.0",
"karma": "6.4.1",
"karma-chrome-launcher": "3.1.0",
"karma-mocha-reporter": "2.2.5",
@ -6021,6 +6021,13 @@
"node": ">=12.0.0"
}
},
"node_modules/jsdoc-class-hierarchy": {
"version": "1.1.2",
"resolved": "https://registry.npmjs.org/jsdoc-class-hierarchy/-/jsdoc-class-hierarchy-1.1.2.tgz",
"integrity": "sha512-oU7UgWr0Qbtxd2J81/ee1lM8xAdyUU7B1ZosVwZxJwjhPWvtkX9ooHjD1Fk97OyOlpTBXxYVTpptvSCKRt8wvQ==",
"dev": true,
"license": "MIT"
},
"node_modules/jsdoc-type-pratt-parser": {
"version": "4.0.0",
"resolved": "https://registry.npmjs.org/jsdoc-type-pratt-parser/-/jsdoc-type-pratt-parser-4.0.0.tgz",
@ -6031,14 +6038,16 @@
}
},
"node_modules/jsdoc-wmf-theme": {
"version": "1.0.1",
"resolved": "https://registry.npmjs.org/jsdoc-wmf-theme/-/jsdoc-wmf-theme-1.0.1.tgz",
"integrity": "sha512-QKCtPM1INxFDOPSIEcPTHP4PhVzyDyQD7ALWLmVD8dP0BFdQuGVFG/q3sbxC4uNCrntOoLOVmzFFK95d0OgeTQ==",
"version": "1.1.0",
"resolved": "https://registry.npmjs.org/jsdoc-wmf-theme/-/jsdoc-wmf-theme-1.1.0.tgz",
"integrity": "sha512-0BQMgaSBmdGRVSiyAF7SMm1mTS59Y5vpPHAFFABcZRL15TIc5UyL88DtrrA1nuKL+jgTBsMgaeu8NDfNstC8RA==",
"dev": true,
"license": "Apache-2.0",
"dependencies": {
"@jsdoc/salty": "^0.2.8",
"@wikimedia/codex-design-tokens": "1.1.1",
"domino": "^2.1.6",
"jsdoc-class-hierarchy": "1.1.2",
"lunr": "2.3.9",
"marked": "^12.0.2",
"normalize.css": "8.0.1"
@ -15636,6 +15645,12 @@
}
}
},
"jsdoc-class-hierarchy": {
"version": "1.1.2",
"resolved": "https://registry.npmjs.org/jsdoc-class-hierarchy/-/jsdoc-class-hierarchy-1.1.2.tgz",
"integrity": "sha512-oU7UgWr0Qbtxd2J81/ee1lM8xAdyUU7B1ZosVwZxJwjhPWvtkX9ooHjD1Fk97OyOlpTBXxYVTpptvSCKRt8wvQ==",
"dev": true
},
"jsdoc-type-pratt-parser": {
"version": "4.0.0",
"resolved": "https://registry.npmjs.org/jsdoc-type-pratt-parser/-/jsdoc-type-pratt-parser-4.0.0.tgz",
@ -15643,14 +15658,15 @@
"dev": true
},
"jsdoc-wmf-theme": {
"version": "1.0.1",
"resolved": "https://registry.npmjs.org/jsdoc-wmf-theme/-/jsdoc-wmf-theme-1.0.1.tgz",
"integrity": "sha512-QKCtPM1INxFDOPSIEcPTHP4PhVzyDyQD7ALWLmVD8dP0BFdQuGVFG/q3sbxC4uNCrntOoLOVmzFFK95d0OgeTQ==",
"version": "1.1.0",
"resolved": "https://registry.npmjs.org/jsdoc-wmf-theme/-/jsdoc-wmf-theme-1.1.0.tgz",
"integrity": "sha512-0BQMgaSBmdGRVSiyAF7SMm1mTS59Y5vpPHAFFABcZRL15TIc5UyL88DtrrA1nuKL+jgTBsMgaeu8NDfNstC8RA==",
"dev": true,
"requires": {
"@jsdoc/salty": "^0.2.8",
"@wikimedia/codex-design-tokens": "1.1.1",
"domino": "^2.1.6",
"jsdoc-class-hierarchy": "1.1.2",
"lunr": "2.3.9",
"marked": "^12.0.2",
"normalize.css": "8.0.1"

2
package.json
View file

@ -31,7 +31,7 @@
"grunt-karma": "4.0.2",
"grunt-stylelint": "0.20.0",
"jsdoc": "4.0.2",
"jsdoc-wmf-theme": "1.0.1",
"jsdoc-wmf-theme": "1.1.0",
"karma": "6.4.1",
"karma-chrome-launcher": "3.1.0",
"karma-mocha-reporter": "2.2.5",

2
resources/README.md
View file

@ -1,3 +1,5 @@
# MediaWiki Frontend API
This documentation describes the public API that user scripts, gadgets, skins, and extensions can use to interact with [MediaWiki](https://www.mediawiki.org/wiki/Special:MyLanguage/MediaWiki).
To interact with MediaWiki from outside a wiki, use the [Action API](https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page).

4
resources/package.json
View file

@ -1,4 +0,0 @@
{
"@name": "Used by jsdoc",
"name": "MediaWiki Frontend API"
}