Manual:Composer.json best practices

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Manual:Composer.json best practices and the translation is 26% complete.
Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎polski • ‎日本語

When creating a composer.json file for your extension/library/etc that will be used inside MediaWiki, here are a few best practices to follow. You should also run composer validate, which will point out schema errors.

設定

  • prepend-autoloader: false. Composer's autoloader is slower than MediaWiki's, and most of the classes being loaded are likely to be found inside MediaWiki, so append the composer autoloader instead of prepending it. See this for some more details.
  • optimize-autoloader: true. 最適化しない理由はありません。

Good example: mediawiki/core

依存関係

  • Dependencies should be pinned to a specific version number or sha1 commit if a tag isn't available.
    • For development tools like phpunit or phpcs, "dev-master" or "*" is acceptable.

Good example: mediawiki/core

命名

Libraries hosted in Gerrit or by the Wikimedia GitHub account should typically be published under the "wikimedia" namespace (e.g. "wikimedia/cdb", "wikimedia/simplei18n"). The use of the "mediawiki" namespace should be reserved for extensions and other intrinsically MediaWiki related components (bot frameworks, etc). Projects hosted at GitHub under an independent organization are encouraged to adopt a similar convention of an organization namespace to be applied consistently across the libraries published by the group.

Authors

Major authors to the project should be documented in the "authors" property. At least the name and email fields should be filled out. For libraries, this will be displayed on Special:Version in the "Installed libraries" section.

拡張機能

Extension names should be all lowercase with hyphens as word separators. For example:

  • Extension:WikiEditor --> mediawiki/wiki-editor
  • Extension:MassMessage --> mediawiki/mass-message

To make themselves installable, a dependency upon "composer/installers" with version >= 1.0.1 is required, and the type needs to be set to "mediawiki-extension".

Good example: mediawiki/extensions/Bootstrap

外装

Mainly the same as extensions, except the type should be "mediawiki-skin". The names should end with a suffix of "-skin".

Because composer uses lowercase names for packages (e.g. mediawiki/vector-skin), the extra.installer-name property must be set to the uppercase name (e.g. Vector) so it is cloned in the right directory.

To make themselves installable, a dependency upon "composer/installers" with version >= 1.0.13 is required, and the type needs to be set to "mediawiki-skin".

Good example: mediawiki/skins/Vector

Also extension.json

MediaWiki バージョン: 1.25
Gerrit change 166705

Extensions and skins register information about themselves using an extension.json or skin.json file. Some metadata fields in these files overlap (discussed in T89456), including

  • homepage and url
  • license and license-name