Go to file
joakin 937651f0ea Docs: Add ADR about using webpack's production mode and UglifyJS
Bug: T160061
Change-Id: I458fd6479860b3fd2a43ee382a0219743fca865d
2017-05-12 18:12:30 +02:00
doc Docs: Add ADR about using webpack's production mode and UglifyJS 2017-05-12 18:12:30 +02:00
i18n Localisation updates from https://translatewiki.net. 2017-05-11 23:25:44 +02:00
images Optimise SVGs with svgo 2017-04-26 17:15:45 +01:00
includes Tests: Migrate processLinks.test.js to node-qunit 2017-04-26 12:26:43 +02:00
resources Enable production settings for the production bundle 2017-05-11 10:37:45 +02:00
src eventLogging: Discard events with duplicate tokens 2017-05-10 11:43:05 +01:00
tests eventLogging: Discard events with duplicate tokens 2017-05-10 11:43:05 +01: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 Hygiene: Tidy up QUnit references 2017-05-04 15:53:44 +01:00
.stylelintrc Remove jshint/jscs, add eslint and stylelint 2016-12-16 13:35:34 +01:00
composer.json build: add jakub-onderka/php-console-highlighter 2017-05-05 21:51:43 +02:00
COPYING
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 Remove eslint:fix 2017-05-03 10:19:31 +01:00
jsduck.json Setup jsduck to run on 'npm run doc' 2015-08-03 15:54:25 +05:30
package.json Tools: Add pre-commit git hook to auto test and build 2017-05-11 10:37:48 +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 Enable production settings for the production bundle 2017-05-11 10:37:45 +02: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