Go to file
Antoine Musso 46e0d7cdbe Define npm peer dependency explicitly
npm 3 requires dependencies to be explicitly defined.

Bug: T172094
Change-Id: Ic640ccf0f577e47036d473892522ea758014fab4
2017-07-31 13:31:35 +02:00
doc Document decision to cache requests 2017-06-22 07:12:49 +01:00
i18n Localisation updates from https://translatewiki.net. 2017-07-27 23:14:20 +02:00
images Optimise SVGs with svgo 2017-04-26 17:15:45 +01:00
includes Hygiene: Dependency Injection for Popups 2017-07-24 22:41:28 +00:00
resources Hygiene: i13n: Return false over not sampling 2017-07-26 17:06:58 +00:00
src Hygiene: i13n: Return false over not sampling 2017-07-26 17:06:58 +00:00
tests Hygiene: i13n: Return false over not sampling 2017-07-26 17:06:58 +00: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 Generate docs inside doc folder 2017-05-30 10:16:57 -04: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
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 0.10.1 2017-07-23 00:35:36 -07:00
COPYING Add COPYING file 2014-02-06 15:38:46 +05:30
extension.json Hygiene: Dependency Injection for Popups 2017-07-24 22:41:28 +00:00
Gemfile doc: Replace JSDuck v5.3.4 with JSDoc v3.4.3 2017-05-23 05:33:31 +01: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
jsdoc.json Generate docs inside doc folder 2017-05-30 10:16:57 -04:00
package.json Define npm peer dependency explicitly 2017-07-31 13:31:35 +02:00
phpcs.xml Re-enable MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic sniff 2017-07-13 21:14:29 +02:00
Popups.php Hygiene: Update required MediaWiki version 2017-07-24 16:12:03 +02: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