/Katsa

This extension for Mediawiki add spies to Lua modules. This makes it possible to report actions clearly and visible, to facilitate interactive and collaborative debugging.

Primary LanguageLuaGNU General Public License v2.0GPL-2.0

Katsa

stability-experimental GitHub issues

This extension for Mediawiki add spies (or katsas) for use in Lua modules provided by the Scribunto extension. This makes it possible to report actions clearly and visible, to facilitate interactive and collaborative debugging.

Usage

Katsa depends on modules from the Scribunto extension.

  1. Download from Github (zip) and place the file(s) in a directory called Katsa in your extensions/ folder.

  2. Add the following code at the bottom of your LocalSettings.php:

    wfLoadExtension( 'Katsa' );
  3. Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Development

Katsa uses Mediawiki-Vagrant, and a complete setup can be made quite easily.

  1. Make sure you have Vagrant, etc, prepare a development directory, and move to that directory.

  2. Clone Mediawiki

    git clone --recursive https://gerrit.wikimedia.org/r/mediawiki/vagrant .
  3. Add the role unless #541075 has been merged. (You need git-review to do this.)

    git review -d 541075
  4. Run setup.

    ./setup.sh
  5. Enable role for Katsa. This pulls in the role for Scribunto, which then pulls in additional roles.

    vagrant roles enable katsa
  6. Start the instance.

    vagrant up
  7. Done.