jonny
/
Vector-Local
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Vector-Local/jsdoc.json

48 lines
2.1 KiB
JSON
Raw Permalink Normal View History

build: Replace JSDuck with JSDoc * jsdoc.json was copied from Minerva. The markdown plugin from that config was removed since there no usages of that in Vector. * Added latest jsdoc dependency to package.json * Copied 'jsdoc' task from Minerva into Vector. Revised storybook output so that multiple docs (storybook + jsdoc) could be in /docs * Made collapsibleTabs.js JSDoc compliant (This was really the only thing using jsduck syntax) * Modified Gruntfile stylelinter to ignore docs folder Bug: T239258 Change-Id: Id07d591ffe7bf0ac021109051e89b91ffdcf4c78
2020-02-13 00:36:02 +00:00
{
"opts": {
"destination": "docs/js",
"package": "package.json",
"pedantic": true,
"readme": "README.md",
Add 'jsdoc-wmf-theme' to jsdoc This adds the wmf theme styles to our jsdoc as can be seen on https://doc.wikimedia.org/Parsoid/master/. There is a caveat with this though. jsdoc-wmf-theme adds warnings for unlinked symbols (e.g. 'return {jQuery}') [1] which causes the jsdoc doc generation to fail since it is set to fail on warnings (we have it configured with `pedantic: true`). If we add the jsdoc-wmf-theme, we will need to be stricter about our symbol usage which could be a good thing or just be tedious and annoying. What do you think? [1] https://github.com/cscott/jsdoc-wmf-theme/blob/master/publish.js#L29 Bug: T239258 Change-Id: Icade62a278d7e685cbda28a8ca26a1b703e64f19
2020-02-14 00:43:31 +00:00
"recurse": true,
"template": "node_modules/jsdoc-wmf-theme"
build: Replace JSDuck with JSDoc * jsdoc.json was copied from Minerva. The markdown plugin from that config was removed since there no usages of that in Vector. * Added latest jsdoc dependency to package.json * Copied 'jsdoc' task from Minerva into Vector. Revised storybook output so that multiple docs (storybook + jsdoc) could be in /docs * Made collapsibleTabs.js JSDoc compliant (This was really the only thing using jsduck syntax) * Modified Gruntfile stylelinter to ignore docs folder Bug: T239258 Change-Id: Id07d591ffe7bf0ac021109051e89b91ffdcf4c78
2020-02-13 00:36:02 +00:00
},
"source": {
"include": [ "resources" ]
},
"templates": {
"cleverLinks": true,
"default": {
"useLongnameInNav": true
[feature] add menu button to toggle panel visibility Add a menu button that toggles the panel's (also referred to as a sidebar) collapse state. When the screen is wide enough, animate the transition. The menu icon from OOUI is copied into Vector to avoid two ResourceLoaders modules (collapseHorizontal icon isn't ready for inclusion in the OOUI icon pack and ResourceLoaderOOUIIconPackModule doesn't support images). Additional polish and collaboration is needed but this patch fulfills the scope of its referenced task. Bug: T246419 Depends-On: I8e153c0ab927f9d880a68fb9efb0bf37b91d26b2 Change-Id: Ic9d54de7e19ef8d5dfd703d95a45b78c0aaf791a
2020-03-30 20:07:35 +00:00
},
"wmf": {
"linkMap": {
Adds loading indicator for new search module Provides a loading indicator to show while the new Vue.js based search widget loads. Given that the new widget will pull down the entire Vue.js runtime, it's likely that there will be a delay before the search suggestions appear. This loader is meant to improve the perceived loading experience of the new widget. Adds: - New searchLoader.js file containing loading behaviour. - This overrides the code searchSuggest loading behaviour. - New SearchBoxLoader.less file containing the loader styles. - i18n message: 'vector-search-loader'. - The Event type to jsdoc.json Bug: T254695 Change-Id: I6b5f0a60018954e10b9e80792030b67b2ec33e5a
2020-08-04 12:02:50 +00:00
"\"addEventListener\"": "https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener",
Add watchstar to sticky header (alternative) Bug: T294759 Depends-on: I88af8585e8fc75f77ebef867d267199aeb2c6592 Change-Id: I15c409830ef8970ff7319b4dd447904443949b8d
2021-11-15 23:09:51 +00:00
"jQuery": "https://api.jquery.com",
Move REST search client out of WVUI into Vector Bug: T288686 Depends-on: I4afc8c38dc9c51d55b46b766a1417b1266963482 Change-Id: Iac6023bb6edca5c8dddc3bfd362db727b2534946
2022-02-02 21:17:56 +00:00
"AbortSignal": "https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal",
[feature] add menu button to toggle panel visibility Add a menu button that toggles the panel's (also referred to as a sidebar) collapse state. When the screen is wide enough, animate the transition. The menu icon from OOUI is copied into Vector to avoid two ResourceLoaders modules (collapseHorizontal icon isn't ready for inclusion in the OOUI icon pack and ResourceLoaderOOUIIconPackModule doesn't support images). Additional polish and collaboration is needed but this patch fulfills the scope of its referenced task. Bug: T246419 Depends-On: I8e153c0ab927f9d880a68fb9efb0bf37b91d26b2 Change-Id: Ic9d54de7e19ef8d5dfd703d95a45b78c0aaf791a
2020-03-30 20:07:35 +00:00
"Document": "https://developer.mozilla.org/docs/Web/API/Document",
Add history and talk page icons to sticky header Bug: T290597 Change-Id: Ib590399df09a9da8e181b331d4227b0de30b9a8e
2021-09-14 16:53:35 +00:00
"Element": "https://developer.mozilla.org/docs/Web/API/Element",
Adds loading indicator for new search module Provides a loading indicator to show while the new Vue.js based search widget loads. Given that the new widget will pull down the entire Vue.js runtime, it's likely that there will be a delay before the search suggestions appear. This loader is meant to improve the perceived loading experience of the new widget. Adds: - New searchLoader.js file containing loading behaviour. - This overrides the code searchSuggest loading behaviour. - New SearchBoxLoader.less file containing the loader styles. - i18n message: 'vector-search-loader'. - The Event type to jsdoc.json Bug: T254695 Change-Id: I6b5f0a60018954e10b9e80792030b67b2ec33e5a
2020-08-04 12:02:50 +00:00
"Event": "https://developer.mozilla.org/docs/Web/API/Event",
Sticky header edit icons trigger via JavaScript Current expected behaviour: the editor experience will load and the user will be thrown to the top of the page. Bug: T293158 Change-Id: I3585616c2244a6b91ef5f160beb1cf51af3599aa
2021-10-19 19:14:30 +00:00
"EventTarget": "https://developer.mozilla.org/docs/Web/API/EventTarget",
[feature] add menu button to toggle panel visibility Add a menu button that toggles the panel's (also referred to as a sidebar) collapse state. When the screen is wide enough, animate the transition. The menu icon from OOUI is copied into Vector to avoid two ResourceLoaders modules (collapseHorizontal icon isn't ready for inclusion in the OOUI icon pack and ResourceLoaderOOUIIconPackModule doesn't support images). Additional polish and collaboration is needed but this patch fulfills the scope of its referenced task. Bug: T246419 Depends-On: I8e153c0ab927f9d880a68fb9efb0bf37b91d26b2 Change-Id: Ic9d54de7e19ef8d5dfd703d95a45b78c0aaf791a
2020-03-30 20:07:35 +00:00
"HTMLElement": "https://developer.mozilla.org/docs/Web/API/HTMLElement",
Add scroll event + init A/B test logging to sticky header, AB js - Pull IntersectionObserver into new file to share observer with different callbacks: - Wrap show/hide functionality of sticky header in conditionals based on user test group or by default. - Fire hooks for scroll event tracking in WME. - Add new js for A/B test functions and variables: - Fire hook to send data for A/B test initialization. - Update main js to include scrollObserver, A/B test init functionality. - Add A/B test config. - Update ResourceLoader package dependencies for sticky header. - Though not a strict dependency, see I42e3e7c2084c1e88363d5d1662630ed23a28c4d2 in WME repo which uses these hooks to log scroll events. - This patch includes changes from I56f40e706f8706fde1c0891a0561dd32c5e02bfc which were consolidated here for simplicity and ease of review - related to T292587 which calls for logging an init event for bucketing of users during A/B testing. Bug: T292586 Change-Id: If6446e1e84cea3649905808c4f0e9f6862255fa3
2021-10-26 23:37:56 +00:00
"IntersectionObserver": "https://developer.mozilla.org/docs/Web/API/IntersectionObserver",
Add sectionObserver and tableOfContents component JS to respond to intersection changes This commits sets up the Table of Contents to bold the active section when the section is scrolled. Unfortunately, because our content does not have actual sections but instead has a flat list of headings and paragraphs, we can't use IntersectionObserver in the conventional way as it is optimized to find intersections of elements that are *within* the viewport and the callback will not reliably fire during certain scenarios (e.g. with fast scrolling or when the headings are not currently within the viewport). Furthermore, iterating through a list of elements and calling `getBoundingClientRect()` can be expensive and can also cause significant forced synchronous layouts that block the main thread. The best compromise in terms of performance and function that I've found is to use a combination of a throttled scroll event listener and IntersectionObserver's ability to asyncronously find the boundingClientRect of all elements off the main thread when `.observe` is called which is the approach this patch takes. Although this is an unorthodox way to use IntersectionObserver, performance profiles recorded while holding the "down" arrow and scrolling for 10 seconds with a 6x CPU throttle are comparable between master and this patch: master: https://phabricator.wikimedia.org/F34930737 this patch: https://phabricator.wikimedia.org/F34930738 Bug: T297614 Change-Id: I4077d86a1786cc1f4a7d85b20b7cf402960940e7
2022-01-21 20:15:34 +00:00
"IntersectionObserverEntry": "https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserverEntry",
Add edit icons to sticky header - Add edit icons. - Update data passed to sticky header, button templates. - Show/hide edit icons client-side based on ids in fixed header. - Disable sticky header when in Visual Editor mode. - Use Visual Editor hooks to toggle IntersectionObserver. - Remove extraneous js for setting offsets for other sticky elements (simplify by moving known sticky element th to css - follow up to https://gerrit.wikimedia.org/r/c/mediawiki/skins/Vector/+/722475/comment/7b8ab2db_cd5c7e78/). Bug: T289723 Change-Id: Ifbab2f1c4d716f8fc261e3d7fa35fc71c6065ec5
2021-09-24 21:00:32 +00:00
"Node": "https://developer.mozilla.org/docs/Web/API/Node",
Add search to sticky header Per T289724#7342741, server renders an anchor tag pointing to #p-search into the "button-start" bucket of the sticky header. In the future after T289718, this anchor will then acts as a button when the search module is loaded and searchToggle executes. * skins.vector.search was modified to accomodate instantiating multiple search components (one in the main header and one in the sticky header). * searchToggle.js was modified to accept a searchToggle element as a param which the caller can then instantiate when ideal. For the sticky header toggle, this needs to happen *after* the search module loads. Before then, the toggle will act as a link. * Drops one jQuery usage from searchToggle so that it can be jQuery free. Because the native .closest method is used, IE11 support is also dropped. However, the script feature detects and returns early if the API isn't available. * Makes App.vue accept an `id` prop so that multiple instances of it can be created. Bug: T289724 Change-Id: I1c5e6eee75918a0d06562d07c31fdcbd5a4ed6d5
2021-09-09 21:40:06 +00:00
"NodeList": "https://developer.mozilla.org/docs/Web/API/NodeList",
[feature] add menu button to toggle panel visibility Add a menu button that toggles the panel's (also referred to as a sidebar) collapse state. When the screen is wide enough, animate the transition. The menu icon from OOUI is copied into Vector to avoid two ResourceLoaders modules (collapseHorizontal icon isn't ready for inclusion in the OOUI icon pack and ResourceLoaderOOUIIconPackModule doesn't support images). Additional polish and collaboration is needed but this patch fulfills the scope of its referenced task. Bug: T246419 Depends-On: I8e153c0ab927f9d880a68fb9efb0bf37b91d26b2 Change-Id: Ic9d54de7e19ef8d5dfd703d95a45b78c0aaf791a
2020-03-30 20:07:35 +00:00
"HTMLInputElement": "https://developer.mozilla.org/docs/Web/API/HTMLInputElement",
Adds loading indicator for new search module Provides a loading indicator to show while the new Vue.js based search widget loads. Given that the new widget will pull down the entire Vue.js runtime, it's likely that there will be a delay before the search suggestions appear. This loader is meant to improve the perceived loading experience of the new widget. Adds: - New searchLoader.js file containing loading behaviour. - This overrides the code searchSuggest loading behaviour. - New SearchBoxLoader.less file containing the loader styles. - i18n message: 'vector-search-loader'. - The Event type to jsdoc.json Bug: T254695 Change-Id: I6b5f0a60018954e10b9e80792030b67b2ec33e5a
2020-08-04 12:02:50 +00:00
"\"removeEventListener\"": "https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener",
[feature] add menu button to toggle panel visibility Add a menu button that toggles the panel's (also referred to as a sidebar) collapse state. When the screen is wide enough, animate the transition. The menu icon from OOUI is copied into Vector to avoid two ResourceLoaders modules (collapseHorizontal icon isn't ready for inclusion in the OOUI icon pack and ResourceLoaderOOUIIconPackModule doesn't support images). Additional polish and collaboration is needed but this patch fulfills the scope of its referenced task. Bug: T246419 Depends-On: I8e153c0ab927f9d880a68fb9efb0bf37b91d26b2 Change-Id: Ic9d54de7e19ef8d5dfd703d95a45b78c0aaf791a
2020-03-30 20:07:35 +00:00
"Window": "https://developer.mozilla.org/docs/Web/API/Window",
"CheckboxHack": "https://doc.wikimedia.org/mediawiki-core/master/js",
Vector manages search functionality and provides config flag Add onSkinPageReadyConfig hook that overrides module after page loaded The new module is currently empty pending further work in the feature branch. Depends-On: I0dc38e74052027f26a70d58b5f520e5830e0d55d Bug: T257706 Change-Id: Ib6c8f890fb3d6e751f5f01a6576614b9cc9b440c
2020-07-14 13:07:09 +00:00
"MediaWikiPageReadyModule": "https://doc.wikimedia.org/mediawiki-core/master/js/#!/api/mw.plugin.page.ready",
Move REST search client out of WVUI into Vector Bug: T288686 Depends-on: I4afc8c38dc9c51d55b46b766a1417b1266963482 Change-Id: Iac6023bb6edca5c8dddc3bfd362db727b2534946
2022-02-02 21:17:56 +00:00
"MW": "https://doc.wikimedia.org/mediawiki-core/master/js/#!/api/mw",
"MwMap": "https://doc.wikimedia.org/mediawiki-core/master/js/#!/api/mw.Map",
"RequestInit": "https://developer.mozilla.org/en-US/docs/Web/API/Request/Request",
[feature] add menu button to toggle panel visibility Add a menu button that toggles the panel's (also referred to as a sidebar) collapse state. When the screen is wide enough, animate the transition. The menu icon from OOUI is copied into Vector to avoid two ResourceLoaders modules (collapseHorizontal icon isn't ready for inclusion in the OOUI icon pack and ResourceLoaderOOUIIconPackModule doesn't support images). Additional polish and collaboration is needed but this patch fulfills the scope of its referenced task. Bug: T246419 Depends-On: I8e153c0ab927f9d880a68fb9efb0bf37b91d26b2 Change-Id: Ic9d54de7e19ef8d5dfd703d95a45b78c0aaf791a
2020-03-30 20:07:35 +00:00
"JQueryStatic": "https://api.jquery.com",
Vector manages search functionality and provides config flag Add onSkinPageReadyConfig hook that overrides module after page loaded The new module is currently empty pending further work in the feature branch. Depends-On: I0dc38e74052027f26a70d58b5f520e5830e0d55d Bug: T257706 Change-Id: Ib6c8f890fb3d6e751f5f01a6576614b9cc9b440c
2020-07-14 13:07:09 +00:00
"VectorResourceLoaderVirtualConfig": "#",
Integrate WVUI search into Vector Creates a new skins.vector.search module that replaces the searchSuggest module from MediaWiki core. This module creates a new Vue app using the WVUI search widget for the new search experience. The legacy search input form is still retains on pageload, and the new search kicks on search input focus. In order to manage that transition, the legacy search input is styled to resemble the new WVUI input, and the new input is manually focused after the component mounts. Vue is also added as a dev-dependency to help with type-checking. Other changes: * the entry in skin.json is reordered alphabetically after skins.vector.js Bug: T264355 Change-Id: Ibb9561a77a14734297cb4d0ddcd415fc0750b45d
2020-11-19 17:12:53 +00:00
"void": "#",
"Vue.VNode": "https://vuejs.org/v2/api/#VNode-Interface"
[feature] add menu button to toggle panel visibility Add a menu button that toggles the panel's (also referred to as a sidebar) collapse state. When the screen is wide enough, animate the transition. The menu icon from OOUI is copied into Vector to avoid two ResourceLoaders modules (collapseHorizontal icon isn't ready for inclusion in the OOUI icon pack and ResourceLoaderOOUIIconPackModule doesn't support images). Additional polish and collaboration is needed but this patch fulfills the scope of its referenced task. Bug: T246419 Depends-On: I8e153c0ab927f9d880a68fb9efb0bf37b91d26b2 Change-Id: Ic9d54de7e19ef8d5dfd703d95a45b78c0aaf791a
2020-03-30 20:07:35 +00:00
}
build: Replace JSDuck with JSDoc * jsdoc.json was copied from Minerva. The markdown plugin from that config was removed since there no usages of that in Vector. * Added latest jsdoc dependency to package.json * Copied 'jsdoc' task from Minerva into Vector. Revised storybook output so that multiple docs (storybook + jsdoc) could be in /docs * Made collapsibleTabs.js JSDoc compliant (This was really the only thing using jsduck syntax) * Modified Gruntfile stylelinter to ignore docs folder Bug: T239258 Change-Id: Id07d591ffe7bf0ac021109051e89b91ffdcf4c78
2020-02-13 00:36:02 +00:00
}
}
}