Go to file
joakin 698a93f5bc Hygiene: QUnit setup -> beforeEach & teardown -> afterEach
The setup and teardown hooks on QUnit.module are deprecated on the
latest versions.

See https://api.qunitjs.com/QUnit/module

mw-node-qunit supports them but we shouldn't be using them.

Bug: T160406
Change-Id: I32c07f22d01d16449a6e37f46ff20c577a1f14c6
2017-04-26 12:34:12 +02:00
doc Log events to statsv for monitoring PagePreviews performance 2017-03-14 08:51:10 +00:00
i18n Localisation updates from https://translatewiki.net. 2017-04-23 22:43:59 +02:00
images Directory structure should reflect the ResourceLoader definitions 2016-10-19 20:52:40 +00:00
includes Tests: Migrate processLinks.test.js to node-qunit 2017-04-26 12:26:43 +02:00
resources Merge "Don't show preview if user has abandoned link" 2017-04-24 21:33:12 +00:00
src Don't show preview if user has abandoned link 2017-04-24 15:35:07 +01:00
tests Hygiene: QUnit setup -> beforeEach & teardown -> afterEach 2017-04-26 12:34:12 +02:00
.eslintrc.json Tooling: Begin to use webpack for JS code generation 2017-02-13 13:42:22 +01:00
.gitattributes Hygiene: Move build/ext.popups/ to src/ 2017-02-14 09:59:59 -08:00
.gitignore Add code coverage reports npm script 2017-03-03 13:34:33 +01:00
.gitreview Merge remote-tracking branch 'gerrit/mpga' 2017-02-14 11:20:17 -08:00
.istanbul.yml Add code coverage reports npm script 2017-03-03 13:34:33 +01:00
.stylelintrc Remove jshint/jscs, add eslint and stylelint 2016-12-16 13:35:34 +01:00
composer.json build: Updating development dependencies 2016-01-05 10:39:25 -08:00
COPYING Add COPYING file 2014-02-06 15:38:46 +05:30
extension.json Tests: Migrate processLinks.test.js to node-qunit 2017-04-26 12:26:43 +02:00
Gemfile Update mediawiki_api gem to 1.7.1 2016-05-26 01:34:35 +02:00
Gemfile.lock Hygiene: Remove RL-related step 2016-12-13 14:46:03 +00:00
Gruntfile.js Hygiene: Lint JS files on tests/node-qunit too 2017-04-26 12:34:12 +02:00
jsduck.json Setup jsduck to run on 'npm run doc' 2015-08-03 15:54:25 +05:30
package.json Tests: Remove grunt-contrib-qunit 2017-04-26 12:34:12 +02:00
Popups.php Add extension.json, empty php entry point 2015-07-02 22:19:24 +00:00
README.md Add code coverage reports npm script 2017-03-03 13:34:33 +01:00
webpack.config.js build: Make webpack config compatible with v2.3.0 2017-03-22 11:32:35 +00:00

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.
    • 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