mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Popups
synced 2024-09-24 02:39:11 +00:00
0c1a65f39d
webpack | 4.1.1 | 4.27.1 webpack-cli | 2.0.12 | 3.1.2 The upgrade of webpack modified our build files and included these side effects: * Our linter flagged the usage of bitwise operators in the build files so I turned that off in our build file lint config (.eslintrc.es5.json) * Our build file's size increased slightly from 12.1 KB to 12.13 KB (gzip) so the package.json's bundlesize was updated accordingly. No deleterious effects were noticed to popups running locally, but the jump in webpack version included these notable changes: * Switch from uglify-es to terser minimizer [1] [1] https://github.com/webpack/webpack/releases/tag/v4.26.0 The upgrade for webpack-cli was a major version jump, but the params that we pass to it in our package.json file appear to work as before. Bug: T209314 Change-Id: I1403f2c4d354cf54554a740f8c23176bf80fd3c6 |
||
|---|---|---|
| docs | ||
| i18n | ||
| includes | ||
| resources | ||
| src | ||
| tests | ||
| .babelrc | ||
| .eslintrc.es5.json | ||
| .eslintrc.json | ||
| .gitattributes | ||
| .gitignore | ||
| .gitreview | ||
| .istanbul.yml | ||
| .nvmrc | ||
| .nycrc.json | ||
| .phpcs.xml | ||
| .stylelintrc.json | ||
| .svgo.json | ||
| CODE_OF_CONDUCT.md | ||
| composer.json | ||
| COPYING | ||
| extension.json | ||
| Gruntfile.js | ||
| jsdoc.json | ||
| package.json | ||
| Popups.php | ||
| popups.svg | ||
| README.md | ||
| webpack.config.js | ||
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 startWill 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 buildWill 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 testTo 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 withnpm run test:node
- You can find the QUnit tests that depend on running MediaWiki under
- We recommend you install a file watcher like
nodemonto 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
- Reports printed in the
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 startenables Redux DevTools functionality. In production builds, this same functionality can be enabled by setting adebug=truequery. 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.