https://github.com/mooeypoo/mwstew-cli

A command line interface for creating base files needed for MediaWiki extensions
https://github.com/mooeypoo/mwstew-cli

boilerplate command-line-tool mediawiki mediawiki-extension

Last synced: 3 months ago
JSON representation

A command line interface for creating base files needed for MediaWiki extensions

• Host: GitHub
• URL: https://github.com/mooeypoo/mwstew-cli
• Owner: mooeypoo
• License: gpl-2.0
• Created: 2018-12-28T00:37:56.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-05-31T05:45:14.000Z (over 5 years ago)
• Last Synced: 2024-10-14T08:21:01.047Z (3 months ago)
• Topics: boilerplate, command-line-tool, mediawiki, mediawiki-extension
• Language: PHP
• Size: 33.2 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/mooeypoo/MWStew.svg?branch=master)](https://travis-ci.org/mooeypoo/MWStew-CLI)

[![Coverage Status](https://coveralls.io/repos/github/mooeypoo/MWStew-CLI/badge.svg?branch=master)](https://coveralls.io/github/mooeypoo/MWStew-CLI?branch=master)

[![GitHub license](https://img.shields.io/badge/license-GPLv2-blue.svg?style=plastic)](https://raw.githubusercontent.com/mooeypoo/MWStew-CLI/master/LICENSE)

# MWStew-CLI: A command line tool to create mediawiki extension files

## Usage

Get the package from packagist:

```

composer install mooeypoo/mwstew-cli

```

### Command: create-extension

To create extension files, run the `create-extension` command:

```

./vendor/bin/mwstew create-extension extensionName

```

By default, files will be created in the path `./extensions/`. You can provide a different path by using the `--path [new path]` command.

To see the available parameters for create-extension command, use `./vendor/bin/mwstew create-extension -h`

### Command: list-hooks

To see a list of all available recognized hooks from the MediaWiki API, use the `list-hooks` command:

```

./vendor/bin/mwstew create-extension list-hooks

```

You can also search the list of hooks:

```

./vendor/bin/mwstew create-extension list-hooks --search="api"

```

To see the available parameters for create-extension command, use `./vendor/bin/mwstew list-hooks -h`

## Contribute

This is fully open source tool. Pull requests are welcome! Please participate and help make this a great tool!

If you have suggestions or bug reports, please [submit an issue](https://github.com/mooeypoo/MWStew-CLI/issues).

If you want to contribute to the code, clone and initialize locally:

1. Clone the repo

2. Run `composer install`

3. Run `composer run test` to run tests

* See [MWStew](https://github.com/mooeypoo/MWStew) for the graphical interface.

* See [MWStew-CLI](https://github.com/mooeypoo/MWStew-builder) for the extension-creation engine behind this tool.

## Authors

Moriel Schottlender (mooeypoo)