wikimedia/mediawiki-extensions-Popups
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Popups synced 2024-11-15 11:46:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Mirror of https://gerrit.wikimedia.org/g/mediawiki/extensions/Popups
1653 commits 279 branches 0 tags 65 MiB
JavaScript 84.7%
PHP 9.8%
Less 5%
Shell 0.5%
Go to file
Stephen Niedzielski 89e592183f Hygiene: enable Redux DevTools for debug builds 
Redux DevTools are available in all builds by passing the `?debug=true`
query string. Since globally enabling debug significantly slows load
times, also enable support when the build is non-production (debug)
which is known at transpile time. This enables a debuggable version of
Popups in an otherwise production-like MediaWiki without changing the
Popups release build product.

Also, update the readme with a couple debug tips and flip a few bullets
from hyphens to asterisks since that seems to be more prevalent.

Change-Id: I4cab0b8069b12505dbfa840939caac196bae2750
2018-07-02 14:54:36 -05:00
doc Merge "Doc: ADR for replacing Mustache with ES6 strings" 2018-03-23 15:57:33 +00:00
i18n Localisation updates from https://translatewiki.net. 2018-06-27 22:20:00 +02:00
includes Always set the PagePreviews visibility state 2018-06-11 21:46:03 +02:00
resources Hygiene: enable Redux DevTools for debug builds 2018-07-02 14:54:36 -05:00
src Hygiene: enable Redux DevTools for debug builds 2018-07-02 14:54:36 -05:00
tests Extracts can expand with narrow thumbnails 2018-06-28 16:34:41 -07:00
.babelrc Hygiene: enable Babel transpilation 2018-03-20 07:59:14 -05:00
.eslintrc.es5.json Hygiene: favor string templates over concatenation 2018-03-21 08:05:55 -05:00
.eslintrc.json Remove comments from json file - won't pass scap's json lint 2018-05-17 17:43:32 -05:00
.gitattributes Hide package lock file from git diff 2018-03-14 19:06:51 +00:00
.gitignore Fix: code coverage 2018-06-19 18:10:02 -05:00
.gitreview Merge remote-tracking branch 'gerrit/mpga' 2017-02-14 11:20:17 -08:00
.istanbul.yml Hygiene: Tidy up QUnit references 2017-05-04 15:53:44 +01:00
.nycrc.json Fix: code coverage 2018-06-19 18:10:02 -05:00
.phpcs.xml Add missing "public" visibility in PopupsHooks.php 2018-05-20 21:13:36 +02:00
.stylelintrc.json build: Update linters 2018-02-04 22:09:45 +00:00
CODE_OF_CONDUCT.md Add CODE_OF_CONDUCT.md 2017-06-07 15:30:07 +04:30
composer.json build: Updating mediawiki/mediawiki-codesniffer to 20.0.0 2018-05-26 05:52:59 +00:00
COPYING Add COPYING file 2014-02-06 15:38:46 +05:30
extension.json Change the PopupsVisibility state to visible to match anon experience 2018-05-10 00:57:44 +02:00
Gruntfile.js Restore stylelinting 2018-05-31 11:57:57 +00:00
jsdoc.json Doc: forbid JSDoc warnings & work around tag checker 2018-06-26 10:57:40 -05:00
package-lock.json Hygiene: update mw-node-qunit dependency package 2018-06-29 17:30:03 +00:00
package.json Hygiene: update mw-node-qunit dependency package 2018-06-29 17:30:03 +00:00
Popups.php Remove remaining references to beta 2018-05-02 13:31:43 -07:00
popups.svg Remove BetaFeature code 2018-04-26 15:51:48 -07:00
README.md Hygiene: enable Redux DevTools for debug builds 2018-07-02 14:54:36 -05:00
webpack.config.js Hygiene: replace call to rm with clean-webpack-plugin 2018-06-18 09:09:28 -05:00

README.md

Popups

mediawiki/extensions/Popups

See https://www.mediawiki.org/wiki/Extension:Popups for more information about what it does.

Development

Popups uses an asset bundler so when developing for the extension you'll need to run a script to assemble the frontend assets.

You can find the frontend source files in src/, the compiled sources in resources/dist/, and other frontend assets managed by resource loader in resources/*.

After an npm install:

  • On one terminal, kickstart the bundler process:
    • npm start Will run the bundler in watch mode, re-assembling the files on file change. Additionally, this builds debug-friendly assets and enables Redux DevTools debugging.
    • npm run build Will compile the assets just once, ready for deployment. You must run this step before sending the patch or CI will fail (so that sources and built assets are in sync).
  • On another terminal, run tests and linting tools:
    • npm test To run the linting tools and the tests.
      • You can find the QUnit tests that depend on running MediaWiki under tests/qunit/
      • You can find the isolated QUnit tests under tests/node-qunit/, which you can run with npm run test:node
    • We recommend you install a file watcher like nodemon to watch sources and auto run linting and tests.
      • npm install -g nodemon
      • Example running linting and node unit tests:
        • nodemon -w src/ --exec "grunt lint:all && npm run test:node"
    • Get code coverage report with npm run coverage
      • Reports printed in the coverage/ folder

Developers are likely to work with local MediaWiki instances that do not have content to test with. To reduce this pain, you can create a single page with a list of links that point to an existing and external wiki by using the following config flag:

$wgPopupsGateway = 'restbaseHTML';
$wgPopupsRestGatewayEndpoint = 'https://en.wikipedia.org/api/rest_v1/page/summary/';

Popups works with a local copy of the Mobile Content Service too:

$wgPopupsGateway = 'restbaseHTML';
$wgPopupsRestGatewayEndpoint = 'http://localhost:6927/en.wikipedia.org/v1/page/summary/';

Debugging

  • Popups are dismissed ("abandoned") when the cursor leaves the popup container. As such, it can be difficult to debug a popup of interest without it popping in and out of the DOM. A useful workaround in DevTools is to context click a link, select inspect, move the cursor some place comfortable, and then from the console enter $($0).trigger('mouseenter').
  • As described in #Development, npm start enables Redux DevTools functionality. In production builds, this same functionality can be enabled by setting a debug=true query. E.g., https://en.wikipedia.org/wiki/Popup?debug=true.

Terminology

  • Hovercard - Deprecated term for popup.
  • Link preview - A similar user feature in the Android native app.
  • Navpop / nav pop - A popup-like UI from the NavigationPopups gadget.
  • Popup - Generic term for a dialog that appears to float above a link that is being hovered over by a cursor.
  • Page preview - A specific type of popup that shows a page summary.
  • Preview - A synonym for popup.