Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
wiki.techinc.nl/docs/extension.schema.v1.json

1171 lines
32 KiB
JSON
Raw Normal View History

registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
{
"$schema": "http://json-schema.org/schema#",
"description": "MediaWiki extension.json schema",
"type": "object",
"properties": {
"manifest_version": {
"type": "integer",
"description": "Version of the extension.json schema the extension.json file is in.",
"required": true
},
"name": {
"type": "string",
"description": "The extension's canonical name.",
"required": true
},
"namemsg": {
"type": "string",
"description": "i18n message key of the extension's name."
},
"type": {
"type": "string",
"description": "The extension's type, as an index to $wgExtensionCredits.",
"default": "other"
},
"author": {
"type": [
"string",
"array"
],
"description": "Extension's authors.",
"items": {
"type": "string"
}
},
"version": {
"type": "string",
"description": "The version of this release of the extension."
},
"url": {
"type": "string",
"description": "URL to the homepage for the extension.",
registration: Allow protocol-relative links in "url" field Bug: T93010 Change-Id: I626fb5528b41910d859d8596a8ad350f94c1082e
2017-07-17 17:13:49 +00:00
"format": "uri-reference"
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
},
"description": {
"type": "string",
"description": "Raw description of the extension."
},
"descriptionmsg": {
"type": "string",
"description": "Message key for a i18n message describing the extension."
},
"license-name": {
"type": "string",
registration: Improve license-name validation Our hardcoded enum list in the extension.json schema for license-name values was incomplete and did not cover the full SPDX license identifier specification, which includes things like "AND" for specifying multiple licenses. Composer already has solid code in a library to do this validation, so let's use it! This updates both the validateRegistrationFile.php and ExtensionJsonValidationTest.php to use the composer/spdx-licenses library (a new development dependency) to ensure the license-name field is a valid SPDX identifier. Also fix a silly typo in the validateRegistrationFile script which prevented it from running, and use ::class so it will be easier to detect typos like that in the future. Bug: T146862 Change-Id: Ibb8973ed7950ae81c90558f9630f73746b2aff2c
2016-09-28 02:56:07 +00:00
"description": "SPDX identifier for the license under which the extension is released."
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
},
"requires": {
"type": "object",
Clarifiy that (extension|skin).json requires properties can be for skins too Change-Id: I61f92dee4092ea2644f1d93eeaf7b03a6ef2308d
2020-04-22 14:50:30 +00:00
"description": "Indicates what versions of PHP, MediaWiki core, extensions or skins are required. This syntax may be extended in the future, for example to check dependencies between other services.",
registration: Allow properties in "requires" from v2 v2 of the schema allows extensions and skins to be definied under "requires". This is also used by some extensions in extension.json for v1. It works, so allow the same properties in v1 as in v2. Change-Id: I9b5f1986cadbd714d6f3460ac3e1db3bf7aae65d
2017-01-30 17:51:16 +00:00
"additionalProperties": false,
registration: Add development requirements to extension.json Extensions can specify development dependencies in extension.json under the "dev-requires" key. It's identical to the "requires" field. Any requirement that is needed to pass tests, including but not limited to, PHPUnit, QUnit, structure, phan, should be documented in this new field. The main intention is that CI will ensure that all of these dependencies are satisfied before running tests. At standard runtime, the development requirements will be ignored by MediaWiki, since it only checks for real requirements. Scripts can manually check development requirements by calling ExtensionRegistry::setCheckDevRequires( true ) before trying to load things. If both "requires" and "dev-requires" are present, MediaWiki will merge the two together, so the environment will need to satisfy both before proceeding. Bug: T193824 Change-Id: I9b2936666ee3c96f5c976c7a17f11c437c2c7f48
2019-05-19 09:17:56 +00:00
"properties": {
"MediaWiki": {
"type": "string",
"description": "Version constraint string against MediaWiki core."
},
"platform": {
"type": "object",
"description": "Indicates version constraints against platform services.",
"additionalProperties": false,
"properties": {
"php": {
"type": "string",
"description": "Version constraint string against PHP."
},
"ability-shell": {
"type": "boolean",
"default": false,
"description": "Whether this extension requires shell access."
}
},
"patternProperties": {
"^ext-": {
"type": "string",
"description": "Required PHP extension.",
"enum": ["*"]
}
}
},
"extensions": {
"type": "object",
"description": "Set of version constraint strings against specific extensions."
},
"skins": {
"type": "object",
"description": "Set of version constraint strings against specific skins."
}
}
},
"dev-requires": {
"type": "object",
"description": "Indicates what dependencies are required for development purposes such as running tests. This syntax may be extended in the future.",
"additionalProperties": false,
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
"properties": {
"MediaWiki": {
"type": "string",
"description": "Version constraint string against MediaWiki core."
registration: Allow properties in "requires" from v2 v2 of the schema allows extensions and skins to be definied under "requires". This is also used by some extensions in extension.json for v1. It works, so allow the same properties in v1 as in v2. Change-Id: I9b5f1986cadbd714d6f3460ac3e1db3bf7aae65d
2017-01-30 17:51:16 +00:00
},
registration: Let extensions add PHP version requirements While MediaWiki Core already sets requirements for PHP versions, it should be possible for extensions to tighten these requirements. This mirrors the PHP parameter of extension infoboxes as well. This change introduces a new 'platform' key (in addition to 'MediaWiki', 'skins' and 'extensions', where non-MediaWiki software requirements will be listed in the future, starting with a PHP version constraint. Further keys are supposed to be added to allow setting constraints against php extensions and other abilities of the platform. Bug: T197535 Change-Id: I6744cc0be2363b603331af9dc860eb8603a1a89a
2018-09-08 00:02:53 +00:00
"platform": {
"type": "object",
"description": "Indicates version constraints against platform services.",
"additionalProperties": false,
"properties": {
"php": {
"type": "string",
"description": "Version constraint string against PHP."
registration: Allow to require environment abilities This patch adds the possibility for extensions and skins to require certain environment abiltites that are not necessarily PHP extensions. For now, the only ability introduced is the ability to shell out, but the processing and testing is written in a more general way to allow users to add more abilties later on by just changing getAbilities(). In theory, this allows using VersionChecker to check for random abilities if they are specified in the constructor, as it is comletely environment agnostic and not really bound to just be used for checking extension compatibility. Furthermore, it is possible to specify custom error messages for each of these abilities in the constructor. Other parts of MediaWiki may use these features to check for requirements while working with totally different abilities. Bug: T212472 Change-Id: Iff8512530b08ef509e7ac0b6ed8fe9578ef3e2a1
2018-10-13 22:24:31 +00:00
},
"ability-shell": {
"type": "boolean",
"default": false,
"description": "Whether this extension requires shell access."
registration: Let extensions add PHP version requirements While MediaWiki Core already sets requirements for PHP versions, it should be possible for extensions to tighten these requirements. This mirrors the PHP parameter of extension infoboxes as well. This change introduces a new 'platform' key (in addition to 'MediaWiki', 'skins' and 'extensions', where non-MediaWiki software requirements will be listed in the future, starting with a PHP version constraint. Further keys are supposed to be added to allow setting constraints against php extensions and other abilities of the platform. Bug: T197535 Change-Id: I6744cc0be2363b603331af9dc860eb8603a1a89a
2018-09-08 00:02:53 +00:00
}
registration: Let extensions add PHP extension requirements This change adds the possibility to specify ext-* keys under the 'platform' key introduced in I6744cc0be2 to require given PHP extensions. Note that it's impossible to add constraints different from '*', as there is no universal way to retrieve PHP extension versions. Bug: T197535 Change-Id: I510de1e6d80f5c1d92dc1d1665aaa6c25bf28bf7
2018-09-24 21:55:16 +00:00
},
registration: Fix typo in schemas Change-Id: I8d39290904593c1ef962be2995a536028d0635bc
2019-01-22 02:09:13 +00:00
"patternProperties": {
registration: Let extensions add PHP extension requirements This change adds the possibility to specify ext-* keys under the 'platform' key introduced in I6744cc0be2 to require given PHP extensions. Note that it's impossible to add constraints different from '*', as there is no universal way to retrieve PHP extension versions. Bug: T197535 Change-Id: I510de1e6d80f5c1d92dc1d1665aaa6c25bf28bf7
2018-09-24 21:55:16 +00:00
"^ext-": {
"type": "string",
"description": "Required PHP extension.",
registration: Fix validation of ext-foo values Our json-schema library doesn't yet support "const" (at least not in a released version), so use "enum" with one element, since it's functionally equivalent per <https://json-schema.org/understanding-json-schema/reference/generic.html#constant-values>. Change-Id: Ib9ebb5c6b9d07903fa47603fbe54a148e9c00352
2019-05-22 08:57:05 +00:00
"enum": ["*"]
registration: Let extensions add PHP extension requirements This change adds the possibility to specify ext-* keys under the 'platform' key introduced in I6744cc0be2 to require given PHP extensions. Note that it's impossible to add constraints different from '*', as there is no universal way to retrieve PHP extension versions. Bug: T197535 Change-Id: I510de1e6d80f5c1d92dc1d1665aaa6c25bf28bf7
2018-09-24 21:55:16 +00:00
}
registration: Let extensions add PHP version requirements While MediaWiki Core already sets requirements for PHP versions, it should be possible for extensions to tighten these requirements. This mirrors the PHP parameter of extension infoboxes as well. This change introduces a new 'platform' key (in addition to 'MediaWiki', 'skins' and 'extensions', where non-MediaWiki software requirements will be listed in the future, starting with a PHP version constraint. Further keys are supposed to be added to allow setting constraints against php extensions and other abilities of the platform. Bug: T197535 Change-Id: I6744cc0be2363b603331af9dc860eb8603a1a89a
2018-09-08 00:02:53 +00:00
}
},
registration: Allow properties in "requires" from v2 v2 of the schema allows extensions and skins to be definied under "requires". This is also used by some extensions in extension.json for v1. It works, so allow the same properties in v1 as in v2. Change-Id: I9b5f1986cadbd714d6f3460ac3e1db3bf7aae65d
2017-01-30 17:51:16 +00:00
"extensions": {
"type": "object",
"description": "Set of version constraint strings against specific extensions."
},
"skins": {
"type": "object",
"description": "Set of version constraint strings against specific skins."
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
}
}
},
"ResourceFileModulePaths": {
"type": "object",
"description": "Default paths to use for all ResourceLoader file modules",
"additionalProperties": false,
"properties": {
"localBasePath": {
"type": "string",
"description": "Base path to prepend to all local paths, relative to current directory"
},
"remoteExtPath": {
"type": "string",
"description": "Base path to prepend to all remote paths, relative to $wgExtensionAssetsPath"
},
"remoteSkinPath": {
"type": "string",
"description": "Base path to prepend to all remote paths, relative to $wgStylePath"
}
}
},
"ResourceModules": {
"type": "object",
"description": "ResourceLoader modules to register",
"patternProperties": {
"^[a-zA-Z0-9-\\.]+$": {
"type": "object",
"anyOf": [
{
"description": "A ResourceLoaderFileModule definition",
"additionalProperties": false,
"properties": {
"localBasePath": {
"type": "string",
"description": "Base path to prepend to all local paths in $options. Defaults to $IP"
},
"remoteBasePath": {
"type": "string",
"description": "Base path to prepend to all remote paths in $options. Defaults to $wgScriptPath"
},
"remoteExtPath": {
"type": "string",
"description": "Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath"
},
"skipFunction": {
"type": "string",
"description": "Path to a file containing a JavaScript \"skip function\", if desired."
},
"scripts": {
"type": ["string", "array"],
"description": "Scripts to always include (array of file paths)",
"items": {
"type": "string"
}
},
"languageScripts": {
"type": "object",
"description": "Scripts to include in specific language contexts (mapping of language code to file path(s))",
"patternProperties": {
"^[a-zA-Z0-9-]{2,}$": {
"type": [
"string",
"array"
],
"items": {
"type": "string"
}
}
}
},
"skinScripts": {
"type": "object",
"description": "Scripts to include in specific skin contexts (mapping of skin name to script(s)",
"patternProperties": {
".+": {
"type": [
"string",
"array"
],
"items": {
"type": "string"
}
}
}
},
"debugScripts": {
"type": ["string", "array"],
"description": "Scripts to include in debug contexts",
"items": {
"type": "string"
}
},
"loaderScripts": {
"type": ["string", "array"],
"description": "Scripts to include in the startup module",
"items": {
"type": "string"
}
},
"dependencies": {
"type": ["string", "array"],
"description": "Modules which must be loaded before this module",
"items": {
"type": "string"
}
},
"styles": {
"type": ["string", "array", "object"],
"description": "Styles to always load",
"items": {
"type": "string"
}
},
"skinStyles": {
"type": "object",
"description": "Styles to include in specific skin contexts (mapping of skin name to style(s))",
"patternProperties": {
".+": {
"type": [
"string",
"array"
],
"items": {
"type": "string"
}
}
}
},
"messages": {
"type": ["string", "array"],
"description": "Messages to always load",
"items": {
"type": "string"
}
},
"group": {
"type": "string",
Sync descriptions from extension.schema.v2.json to v1.json Change-Id: I2acb39f4544e2608596f8e76e10ddc516309edec
2020-05-16 02:06:19 +00:00
"description": "Group with which this module should be loaded"
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
},
resourceloader: Implement 'deprecated' option for FileModule ResourceLoader modules can now carry a 'deprecated' option which can be a boolean or an object with message key. This message or a default deprecation message will be show whenever that module is used in production. Note: This will not work in debug mode for ResourceLoaderFile modules and this is deemed acceptable for the time being. We can revisit later. Bug: T137772 Change-Id: Ib9ebd2d39a59fd41d8537e06884699f77b03580c
2016-07-14 22:09:06 +00:00
"deprecated": {
Follow-up 8a7fb8577: For deprecated RL modules, allow strings So that more than just PHP code and MediaWiki core can use it, but also JSON-based static extension registrations. :-) Change-Id: If22fccbb43c5b05db2a666d61ae8864ee9815e7d
2018-01-09 00:05:05 +00:00
"type": ["object", "string", "boolean"],
"description": "Whether the module is deprecated and usage is discouraged. Either a boolean, or a string or an object with key message can be used to customise deprecation message."
resourceloader: Implement 'deprecated' option for FileModule ResourceLoader modules can now carry a 'deprecated' option which can be a boolean or an object with message key. This message or a default deprecation message will be show whenever that module is used in production. Note: This will not work in debug mode for ResourceLoaderFile modules and this is deemed acceptable for the time being. We can revisit later. Bug: T137772 Change-Id: Ib9ebd2d39a59fd41d8537e06884699f77b03580c
2016-07-14 22:09:06 +00:00
},
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
"position": {
"type": "string",
"description": "Position on the page to load this module at",
"enum": [
"bottom",
"top"
]
},
"templates": {
"type": ["object", "array"],
"description": "Templates to be loaded for client-side usage"
},
"targets": {
"type": ["string", "array"],
"description": "ResourceLoader target the module can run on",
"items": {
"type": "string"
}
Add 'noflip' option on RL modules to disable CSSJanus Should be useful for cases where we pull in an external library that already manages RTL flipping in its styles, and CSSJanus does the wrong thing without extra markup. Example: 'ext.tmh.video-js' => $baseExtensionResource + [ 'scripts' => 'resources/videojs/video.js', 'styles' => 'resources/videojs/video-js.css', 'noflip' => true, ... ], Bug: T148572 Bug: T148565 Change-Id: Icbad20d8a6e9a0d354ad159f5816f4fb67cc2775
2016-10-18 19:04:40 +00:00
},
"noflip": {
"type": "boolean",
"description": "Whether to skip CSSJanus LTR-to-RTL flipping for this module. Recommended for styles imported from libraries that already properly handle their RTL styles. Default is false, meaning CSSJanus will be applied on RTL-mode output."
registration: Define packageFiles for v1 extension schema Follows 56fa42d4332c. Bug: T215756 Change-Id: Icbf433b6b147f53cf99533a7272fc83392a8999d
2019-02-11 20:39:41 +00:00
},
"packageFiles": {
extension.schema.v2: Fix schemas for 'packageFiles' The PHP code handling 'packageFiles' looks like it only expects numeric arrays, and not associative arrays. Therefore in JSON the value for the 'packageFiles' key should be arrays and not objects. (And a special case of a string, handled the same as single-element array, is also accepted.) Individual items in the array can be not only strings, but also objects, describing data which is pulled from other sources than a file. * ResourceLoaderFileModule: Remove unused variable and tweak docs. Change-Id: I6c3d186de1877f73d4a4e3fec7d6d632a5d5fa83
2019-10-24 15:12:20 +00:00
"type": ["string", "array"],
"description": "Package files that can be require()d",
"items": {
"type": ["string", "object"]
}
resourceloader: Allow modules to mark themselves as ES6-only Modules that set "es6": true in their module definition will error when a non-ES6 client tries to load them. To detect ES6 support, this looks for native Promise support, RegExp.prototype.flags, and non-BMP characters in variable names. All browsers that lack full ES6 support fail at least one of those checks. To flag modules as requiring ES6, this adds a ! to the end of their version string. This takes up much less space than adding another register() parameter (which would have to be at the end). It's hacky, but we expect this feature to be relatively temporary, until we require ES6 for running any JS at all (probably in about a year). For distinguishing different types of errors thrown from sortDependencies(), use e.name. We can't subclass Error properly because that requires ES6. Bug: T272104 Change-Id: I45670c910ff12eb422ae54c9fcf372e45c7b2bf1
2021-01-23 07:33:38 +00:00
},
"es6": {
"type": "boolean",
"description": "Whether this module requires an ES6-capable browser. If set to true, loading this module in a non-ES6 browser will cause an error. Using ES6 syntax in modules is not yet supported, but will be in the near future. Default is false."
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
}
}
},
{
"description": "A ResourceLoaderWikiModule definition",
"additionalProperties": false,
"properties": {
"class": {
"enum": ["ResourceLoaderWikiModule"]
},
"group": {
"type": "string",
Sync descriptions from extension.schema.v2.json to v1.json Change-Id: I2acb39f4544e2608596f8e76e10ddc516309edec
2020-05-16 02:06:19 +00:00
"description": "Group with which this module should be loaded"
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
},
"position": {
"type": "string",
"description": "Position on the page to load this module at",
"enum": [
"bottom",
"top"
]
},
"targets": {
"type": ["string", "array"],
"description": "ResourceLoader target the module can run on",
"items": {
"type": "string"
}
},
"scripts": {
"type": "array",
Sync descriptions from extension.schema.v2.json to v1.json Change-Id: I2acb39f4544e2608596f8e76e10ddc516309edec
2020-05-16 02:06:19 +00:00
"description": "A list of on-wiki pages containing JavaScript that should be loaded",
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
"items": {
"type": "string"
}
},
"styles": {
"type": "array",
Sync descriptions from extension.schema.v2.json to v1.json Change-Id: I2acb39f4544e2608596f8e76e10ddc516309edec
2020-05-16 02:06:19 +00:00
"description": "A list of on-wiki pages containing CSS that should be loaded",
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
"items": {
"type": "string"
}
}
}
},
{
"description": "A ResourceLoaderImageModule definition",
"additionalProperties": false,
"properties": {
"class": {
"enum": ["ResourceLoaderImageModule"]
},
resourceloader: Allow 'localBasePath' for ImageModule to extension.json This wasn't yet part of the schema, hereby added. Being used for TemplateData in Ic8975d7ba349. Change-Id: If661c68bea069e99cfff35711efdde7805a12851
2020-03-15 14:54:56 +00:00
"localBasePath": {
"type": "string",
"description": "Base path to prepend to all local paths. Defaults to $IP"
},
ResourceLoaderImage module definitions can define a defaultColor Bug: T197909 Change-Id: I0745e112d11026ed59d8daca990b313305cd094a
2018-06-25 22:55:19 +00:00
"defaultColor": {
"type": "string"
},
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
"data": {
"type": "string"
},
"prefix": {
"type": "string"
},
"selector": {
"type": "string"
},
"selectorWithoutVariant": {
"type": "string"
},
"selectorWithVariant": {
"type": "string"
},
registration: Document ResourceLoaderImageModule's useDataURI option Without these rules, validation will fail in any skin or extension that tries to use it. Follows-up 36252b7. Bug: T198930 Change-Id: Iee77655d4868a7d921be8cc23776a7859d9acf0c
2018-07-09 23:26:15 +00:00
"useDataURI": {
"type": "boolean"
},
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
"variants": {
"type": "object"
},
"images": {
"type": "object"
},
"position": {
"enum": [
"top",
"bottom"
]
}
}
},
{
Sync descriptions from extension.schema.v2.json to v1.json Change-Id: I2acb39f4544e2608596f8e76e10ddc516309edec
2020-05-16 02:06:19 +00:00
"description": "An arbitrary ResourceLoaderModule definition by class",
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
"properties": {
"class": {
"type": "string",
registration: Fix 'ResourceLoaderWikiModule' schema validation There is a full schema for ResourceModules when the class: ResourceLoaderWikiModule is used. Except it doesn't actually work, since it it fails validating against that schema, it will continue to check the other anyOf schemas, find the arbitrary class one, and pass that one. Blacklisting ResourceLoaderWikiModule from the arbitrary class schema means that it has to pass the specified schema for it, or fail validation. I verified that all extensions and skins in Gerrit pass validation with this patch. Change-Id: Icb862088c0ca1f89ed5a57a4286dd9049d213021
2019-02-23 01:17:05 +00:00
"pattern": "^(?!ResourceLoader(File|Image|Wiki)Module).*$"
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
}
},
"required": ["class"]
}
]
}
}
},
"ResourceModuleSkinStyles": {
"type": "object",
"description": "ResourceLoader modules for custom skin styles"
},
"ResourceLoaderSources": {
"type": "object",
"description": "ResourceLoader sources to register"
},
resourceloader: Add skin-based 'mediawiki.skin.variables.less' import Add the SkinLessImportPaths attribute for skin-specific LESS import paths, which skins can use to override the mediawiki.skin.variables.less file. As a starting point, add the following 5 variables: * device widths (3x) To help phase out 'mediawiki.ui/variables'. These are commonly used by MobileFrontend. * @font-family-sans Recommended by Volker. Used by multiple skins. * @border-radius-base Recommended by Volker as example of something that we currently hardcode in MediaWiki core for Vector and OOUI/WikimediaUI in 'mediawiki.widgets.datetime' but should instead be allowed to vary by skin and OOUI theme. Remove the hardcoded value for '@border-radius-base' in various places in favour of importing from mediawiki.skin. The default is a bare default of 0 (as border-radius is off by default in the browser). The value for Vector is restored there by I47da304667811. The value for MonoBook is improved by I000f319ab31b. Bug: T112747 Change-Id: Icf86c930a3b5524254bb549624737d3b9dccb032
2018-05-20 18:32:57 +00:00
"SkinLessImportPaths": {
"type": "object",
"description": "Path to the skin-specific LESS import directory, keyed by skin name. Can be used to define skin-specific LESS variables."
},
resourceloader: Support TestModules registration via extension.json Bug: T126091 Change-Id: I27ecebe27d7aaebe6d1317bc5eaea9cca368b45d
2019-01-18 20:21:35 +00:00
"QUnitTestModule": {
"type": "object",
registration: Sync v2 and v1 schemas Unless it's an intentional deviation, everything in v2 should also be in v1. This copies over: * e71e025aba41: Add 'ParsoidModules' ... * 7abd828ea3a2: Extension schema updates for HookContainer * 34bff221badd: Introduce 'MessagePosterModule' extension attribute * e97f2943f2f7: QUnitTestModule should support packageFiles and templates ** d50c7f5b5689: Fix schemas for 'packageFiles' ** ee1f4f8ea380: Fix schemas for 'templates' * 3f0056a252da: REST API initial commit Change-Id: I1ae6fed0261ad29ea5cb39b3511b8cde392ab612
2020-07-20 23:27:32 +00:00
"description": "A ResourceLoaderFileModule definition registered only when wgEnableJavaScriptTest is true.",
"additionalProperties": false,
"properties": {
"localBasePath": {
"type": "string",
"description": "Prefix for local paths to files in $options, relative to extenion directory"
},
"remoteExtPath": {
"type": "string",
"description": "Prefix for URLs to files in $options, relative to $wgExtensionAssetsPath"
},
"remoteSkinPath": {
"type": "string",
"description": "Prefix for URLs to files in $options, relative to $wgStylePath"
},
"scripts": {
"type": ["string", "array"],
"description": "Scripts to include (array of file paths)",
"items": {
"type": "string"
}
},
"packageFiles": {
"type": ["string", "array"],
"description": "Package files that can be require()d",
"items": {
"type": ["string", "object"]
}
},
"dependencies": {
"type": ["string", "array"],
"description": "Modules which must be loaded before this module",
"items": {
"type": "string"
}
},
"styles": {
"type": ["string", "array", "object"],
"description": "Styles to load",
"items": {
"type": "string"
}
},
"templates": {
"type": ["object", "array"],
"description": "Templates to be loaded for client-side usage",
"items": {
"type": "string"
}
},
"messages": {
"type": ["string", "array"],
"description": "Messages to load",
"items": {
"type": "string"
}
}
}
resourceloader: Support TestModules registration via extension.json Bug: T126091 Change-Id: I27ecebe27d7aaebe6d1317bc5eaea9cca368b45d
2019-01-18 20:21:35 +00:00
},
mediawiki.messagePoster: Introduce 'MessagePosterModule' extension attribute This allows extensions to add additional files or dependencies to the 'mediawiki.messagePoster' module bundle. Bug: T235315 Change-Id: I17c34cbb26e786328d3d99beb0c0fa65e15ea084
2019-10-12 03:17:51 +00:00
"MessagePosterModule": {
"type": "object",
registration: Sync v2 and v1 schemas Unless it's an intentional deviation, everything in v2 should also be in v1. This copies over: * e71e025aba41: Add 'ParsoidModules' ... * 7abd828ea3a2: Extension schema updates for HookContainer * 34bff221badd: Introduce 'MessagePosterModule' extension attribute * e97f2943f2f7: QUnitTestModule should support packageFiles and templates ** d50c7f5b5689: Fix schemas for 'packageFiles' ** ee1f4f8ea380: Fix schemas for 'templates' * 3f0056a252da: REST API initial commit Change-Id: I1ae6fed0261ad29ea5cb39b3511b8cde392ab612
2020-07-20 23:27:32 +00:00
"description": "Additional JavaScript files and modules that will register content models with mw.messagePoster.factory.",
"additionalProperties": false,
"properties": {
"localBasePath": {
"type": "string",
"description": "Prefix for local paths to files in $options, relative to extenion directory"
},
"scripts": {
"type": "array",
"description": "Scripts to include as array of file paths",
"items": {
"type": "string"
}
},
"dependencies": {
"type": "array",
"description": "Modules which must load before these files",
"items": {
"type": "string"
}
}
}
mediawiki.messagePoster: Introduce 'MessagePosterModule' extension attribute This allows extensions to add additional files or dependencies to the 'mediawiki.messagePoster' module bundle. Bug: T235315 Change-Id: I17c34cbb26e786328d3d99beb0c0fa65e15ea084
2019-10-12 03:17:51 +00:00
},
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
"ConfigRegistry": {
"type": "object",
"description": "Registry of factory functions to create Config objects"
},
"SessionProviders": {
"type": "object",
"description": "Session providers"
},
"AuthManagerAutoConfig": {
"type": "object",
"description": "AuthManager auto-configuration",
"additionalProperties": false,
"properties": {
"preauth": {
"type": "object",
"description": "Pre-authentication providers"
},
"primaryauth": {
"type": "object",
"description": "Primary authentication providers"
},
"secondaryauth": {
"type": "object",
"description": "Secondary authentication providers"
}
}
},
"CentralIdLookupProviders": {
"type": "object",
"description": "Central ID lookup providers"
},
"namespaces": {
"type": "array",
"description": "Method to add extra namespaces",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"constant": {
"type": "string"
},
"name": {
"type": "string"
},
"gender": {
"type": "object",
"properties": {
"male": {
"type": "string"
},
"female": {
"type": "string"
}
}
},
"subpages": {
"type": "boolean",
"default": false
},
"content": {
"type": "boolean",
"default": false
},
"defaultcontentmodel": {
"type": "string"
},
"protection": {
"type": ["string", "array"],
"description": "Userright(s) required to edit in this namespace"
},
"capitallinkoverride": {
"type": "boolean",
"description": "Set $wgCapitalLinks on a per-namespace basis"
registration: Support conditionally registered namespaces Some extensions (e.g. EventLogging) conditionally register a namespace depending upon the wiki's configuration using the CanonicalNamespaces hook. Since the "namespaces" key automatically registers the namespace, we need an option to not register it and let the extension take care of that manually using the hook. All of the other namespace related settings are safe to unconditionally set since they won't do anything if the namespace doesn't actually exist. Bug: T141604 Change-Id: Ie8c217fdc8bd783b30f98210309ea56fef39c0da
2016-07-29 08:09:24 +00:00
},
"conditional": {
"type": "boolean",
"description": "Whether the namespace is conditional upon configuration and should not be registered (requires separate registration via a hook)",
"default": false
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
}
},
"required": ["id", "constant", "name"]
}
},
"TrackingCategories": {
"type": "array",
"description": "Tracking category message keys",
"items": {
"type": "string"
}
},
"DefaultUserOptions": {
"type": "object",
"description": "Default values of user options"
},
"HiddenPrefs": {
"type": "array",
"description": "Preferences users cannot set",
"items": {
"type": "string"
}
},
"GroupPermissions": {
"type": "object",
"description": "Default permissions to give to user groups",
"patternProperties": {
"^[a-z]+$": {
"type": "object",
"patternProperties": {
"^[a-z]+$": {
"type": "boolean"
}
}
}
}
},
"RevokePermissions": {
"type": "object",
"description": "Default permissions to revoke from user groups",
"patternProperties": {
"^[a-z]+$": {
"type": "object",
"patternProperties": {
"^[a-z]+$": {
"type": "boolean"
}
}
}
}
},
"GrantPermissions": {
"type": "object",
"description": "Map of permissions granted to authorized consumers to their bundles, called 'grants'",
"patternProperties": {
"^[a-z]+$": {
"type": "object",
"patternProperties": {
"^[a-z]+$": {
"type": "boolean"
}
}
}
}
},
"GrantPermissionGroups": {
"type": "object",
"description": "Map of grants to their UI grouping",
"patternProperties": {
"^[a-z]+$": {
"type": "string"
}
}
},
"ImplicitGroups": {
"type": "array",
"description": "Implicit groups"
},
"GroupsAddToSelf": {
"type": "object",
"description": "Groups a user can add to themselves"
},
"GroupsRemoveFromSelf": {
"type": "object",
"description": "Groups a user can remove from themselves"
},
"AddGroups": {
"type": "object",
"description": "Groups a user can add to users"
},
"RemoveGroups": {
"type": "object",
"description": "Groups a user can remove from users"
},
"AvailableRights": {
"type": "array",
"description": "User rights added by the extension",
"items": {
"type": "string"
}
},
"ContentHandlers": {
"type": "object",
"description": "Mapping of model ID to class name",
"patternProperties": {
"^[A-Za-z]+$": {
"type": "string"
}
}
},
"RateLimits": {
"type": "object",
"description": "Rate limits"
},
"RecentChangesFlags": {
"type": "object",
"description": "Flags (letter symbols) shown on RecentChanges pages"
},
"MediaHandlers": {
"type": "object",
"description": "Plugins for media file type handling. Each entry in the array maps a MIME type to a PHP class name."
},
"ExtensionFunctions": {
"type": [
"array",
"string"
],
"description": "Function to call after setup has finished",
"items": {
"type": "string"
}
},
"ExtensionMessagesFiles": {
"type": "object",
"description": "File paths containing PHP internationalization data"
},
"MessagesDirs": {
"type": "object",
"description": "Directory paths containing JSON internationalization data"
},
"ExtensionEntryPointListFiles": {
"type": "object"
},
"SpecialPages": {
"type": "object",
Support the creation of special pages with services injected Now that the ObjectFactory library supports object creation with services (T222409), the special page factory can use the object factory to create special pages based off a spec, allowing the creation of special pages that need services injected. The object factory now also handles constructing from class name and from callable. This also deprecates providing the special page list with an instance of SpecialPage, which hasn't been necessary since r15031. Bug: T222388 Change-Id: Iabb78ce5c98cfb3b586644be35d984871cb750cb
2019-09-06 09:21:29 +00:00
"description": "SpecialPages implemented in this extension (mapping of page name to class name or to ObjectFactory spec)"
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
},
Enable using PSR-4 autoloader for MediaWiki core and extensions This adds support for a PSR-4 (<http://www.php-fig.org/psr/psr-4/>) autoloader, so instead of needing to manually list each class, just the namespace prefix is needed. Extensions can set a "AutoloadNamespaces" property in extension.json to register PSR-4 compatible namespaces to be autoloaded. The implementation is based off of the example implementation (<http://www.php-fig.org/psr/psr-4/examples/>) with some modifications for performance, notably cutting down on function calls, and only trying to look up classes that are namespaced. The generateLocalAutoload.php script will ignore any directory that is registered as a PSR-4 namespace. Bug: T99865 Bug: T173799 Change-Id: Id095dde37cbb40aa424fb628bd3c94e684ca2f65
2017-08-24 18:05:26 +00:00
"AutoloadNamespaces": {
"type": "object",
registration: Validate AutoloadNamespaces keys have trailing \ The PSR-4 autoloader requires "AutoloadNamespaces" keys to have a trailing \ (\\ in JSON), so add a validation check for that. Unfortunately the validation error isn't great, since it checks to see if the property matches patternProperties, and when it doesn't, it claims the property isn't defined since additionalProperties is false. But it's still better than not failing when they are missing. Bug: T189136 Change-Id: If01bd06cdd767fb704a8ff85cdf1c143e53fa4ca
2018-05-20 19:13:05 +00:00
"description": "Mapping of PSR-4 compliant namespace to directory for autoloading",
"patternProperties": {
"^[A-Za-z0-9\\\\]+\\\\$": {
"type": "string"
}
},
"additionalProperties": false
Enable using PSR-4 autoloader for MediaWiki core and extensions This adds support for a PSR-4 (<http://www.php-fig.org/psr/psr-4/>) autoloader, so instead of needing to manually list each class, just the namespace prefix is needed. Extensions can set a "AutoloadNamespaces" property in extension.json to register PSR-4 compatible namespaces to be autoloaded. The implementation is based off of the example implementation (<http://www.php-fig.org/psr/psr-4/examples/>) with some modifications for performance, notably cutting down on function calls, and only trying to look up classes that are namespaced. The generateLocalAutoload.php script will ignore any directory that is registered as a PSR-4 namespace. Bug: T99865 Bug: T173799 Change-Id: Id095dde37cbb40aa424fb628bd3c94e684ca2f65
2017-08-24 18:05:26 +00:00
},
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
"AutoloadClasses": {
"type": "object"
},
Allow specifying autoloaded classes for tests This introduces two new keys to the extension schema, analogous to the existing autoloader keys: TestAutoloadNamespaces and TestAutoloadClasses. The classes and namespaces defined by these keys are only loaded by the registry when ExtensionRegistry::setLoadTestClassesAndNamespaces is called. The phpunit wrapper does this in PHPUnitMaintClass::setup. The unit test bootstrap file calls ExtensionRegistry::exportTestAutoloadClassesAndNamespaces instead, similar to how it loads the regular classes and namespaces. Bug: T196090 Change-Id: I88cf69663362fd599c20649b1df641907a02678d
2019-12-10 12:13:13 +00:00
"TestAutoloadNamespaces": {
"type": "object",
"description": "Mapping of PSR-4 compliant namespace to directory for autoloading to be used in tests",
"patternProperties": {
"^[A-Za-z0-9\\\\]+\\\\$": {
"type": "string"
}
},
"additionalProperties": false
},
"TestAutoloadClasses": {
"type": "object"
},
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
"Hooks": {
[registration] Remove type of string from Hooks in extension.schema.v1.json Same as it will be or v2 when that patch merges Change-Id: I64c3bbcda0f353fe9c14b0d5bea241e0304c0e2e Follows-Up: I1a8657ff9fd14618c6709dbab62c3b4ee9f659a5
2020-05-26 00:28:46 +00:00
"type": "object",
registration: Sync v2 and v1 schemas Unless it's an intentional deviation, everything in v2 should also be in v1. This copies over: * e71e025aba41: Add 'ParsoidModules' ... * 7abd828ea3a2: Extension schema updates for HookContainer * 34bff221badd: Introduce 'MessagePosterModule' extension attribute * e97f2943f2f7: QUnitTestModule should support packageFiles and templates ** d50c7f5b5689: Fix schemas for 'packageFiles' ** ee1f4f8ea380: Fix schemas for 'templates' * 3f0056a252da: REST API initial commit Change-Id: I1ae6fed0261ad29ea5cb39b3511b8cde392ab612
2020-07-20 23:27:32 +00:00
"description": "Hooks this extension uses (mapping of hook name to callback)",
"additionalProperties": {
"oneOf": [
{
"type": "string",
"description": "A global function name, static function name, or the name of a property in HookHandlers"
},
{
"type": "object",
"description": "A handler specification",
"properties": {
"handler": {
"type": "string",
"description": "The name of a property in HookHandlers"
},
"deprecated": {
"type": "boolean",
"description": "The deprecation acknowledgement flag for the handler. If this is true, calls will be filtered if the relevant hook is deprecated."
}
},
"required": [
"handler"
]
},
{
"type": "array",
"description": "An ordered array of handlers",
"items": {
"oneOf": [
{
"type": "string",
"description": "A global function name, static function name, or the name of a property in HookHandlers"
},
{
"type": "object",
"description": "A handler specification",
"properties": {
"handler": {
"type": "string",
"description": "The name of a property in HookHandlers"
},
"deprecated": {
"type": "boolean",
"description": "The deprecation acknowledgement flag for the handler. If this is true, calls will be filtered if the relevant hook is deprecated."
}
},
"required": [
"handler"
]
}
]
}
}
]
}
},
"HookHandlers": {
"type": "object",
"description": "ObjectFactory specifications for new-style hook handlers",
"additionalProperties": {
"type": "object",
"properties": {
"factory": {
"type": ["string", "array"],
"description": "A factory function to be called to create the handler for this hook"
},
"class": {
"type": "string",
"description": "The fully-qualified class name of the handler. This should be omitted if a factory is specified."
},
"args": {
"type": "array",
"description": "The arguments passed to the handler constructor or factory"
},
"services": {
"type": "array",
"description": "If supplied and non-empty, the named services are requested from the service container and prepended before 'args'."
Update for object-factory v.3 Bug: T267074 Change-Id: Iff9b46c9e78e87d32c8f75d26b284ce01bccb63d
2020-11-17 06:15:02 +00:00
},
"optional_services": {
"type": "array",
"description": "If supplied and non-empty, the named services are requested from the service container and appended after 'services' if the services are available; null is passed if the services are not available."
registration: Sync v2 and v1 schemas Unless it's an intentional deviation, everything in v2 should also be in v1. This copies over: * e71e025aba41: Add 'ParsoidModules' ... * 7abd828ea3a2: Extension schema updates for HookContainer * 34bff221badd: Introduce 'MessagePosterModule' extension attribute * e97f2943f2f7: QUnitTestModule should support packageFiles and templates ** d50c7f5b5689: Fix schemas for 'packageFiles' ** ee1f4f8ea380: Fix schemas for 'templates' * 3f0056a252da: REST API initial commit Change-Id: I1ae6fed0261ad29ea5cb39b3511b8cde392ab612
2020-07-20 23:27:32 +00:00
}
}
}
},
"DeprecatedHooks": {
"type": "object",
"description": "Hooks which are defined and deprecated by the extension",
"additionalProperties": {
"type": "object",
"properties": {
"deprecatedVersion": {
"type": "string",
"description": "The version in which the hook was deprecated"
},
"component": {
"type": "string",
"description" : "The component to which the deprecated version relates. If omitted, the extension name will be used."
},
"silent": {
"type": "boolean",
"description": "If true, no warning is raised when the hook is called or when a handler is declared. However, call filtering is still activated."
}
},
"required": [
"deprecatedVersion"
]
}
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
},
"JobClasses": {
"type": "object",
Allow callback functions for creating jobs $wgJobClasses can now specify a factory function for creating a job, instead of a class to be instantiated directly. This makes it possible to inject services in a job constructor, and register a factory function that calls the constructor with default services. This follows Ieb85493a7765 and Ia2107dc5af78, which introduced factory functions for API modules and special pages. Change-Id: I0461e59da2a8fa6681e3b1fcdfc38bfed7f3ac32
2017-05-04 16:00:28 +00:00
"description": "Job types this extension implements (mapping of job type to class name or factory function)"
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
},
"LogTypes": {
"type": "array",
"description": "List of new log types this extension uses"
},
"LogRestrictions": {
"type": "object"
},
"FilterLogTypes": {
"type": "object"
},
"ActionFilteredLogs": {
"type": "object",
"description": "List of log types which can be filtered by log actions",
"patternProperties": {
"^[a-z-]+$": {
"type": "object",
"patternProperties": {
"^[a-z-]+$": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"LogNames": {
"type": "object"
},
"LogHeaders": {
"type": "object"
},
"LogActions": {
"type": "object"
},
"LogActionsHandlers": {
"type": "object"
},
"Actions": {
"type": "object"
},
"APIModules": {
"type": "object"
},
"APIFormatModules": {
"type": "object"
},
"APIMetaModules": {
"type": "object"
},
"APIPropModules": {
"type": "object"
},
"APIListModules": {
"type": "object"
},
"ValidSkinNames": {
skins: Allow $wgValidSkinNames to take ObjectFactory spec Bug: T252760 Change-Id: I189de448c3b2c56dfe6bf49170d7746943cf2417
2020-05-14 11:20:24 +00:00
"type": "object",
"description": "Mapping of skin canonical names to PHP class name using the Object Factory specification. Or historically, the human readable name of the skin."
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
},
"FeedClasses": {
"type": "object",
"description": "Available feeds objects"
},
"SkinOOUIThemes": {
Sync descriptions from extension.schema.v2.json to v1.json Change-Id: I2acb39f4544e2608596f8e76e10ddc516309edec
2020-05-16 02:06:19 +00:00
"type": "object",
"description": "Map of skin names to OOUI themes to use. Same format as ResourceLoaderOOUIModule::$builtinSkinThemeMap."
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
},
Allow skins/extensions to define custom OOUI themes This change follows I39cc2a735d9625c87bf4ede6f5fb0ec441d47dcc. docs/extension.schema.v1.json docs/extension.schema.v2.json includes/registration/ExtensionProcessor.php * The new extension attribute 'OOUIThemePaths' can be used to define custom OOUI themes. See I9187a63e509b601b8558ea82850fa828e5c8cc0a for an example usage. includes/resourceloader/ResourceLoaderOOUIModule.php * Add support for 'OOUIThemePaths'. * Defining 'images' is now optional. I figure custom themes are unlikely to have or need them. * Use ResourceLoaderFilePath objects to allow skin-/extension-defined OOUI module files to use skin/extension's base paths. This was previously used to support $wgResourceModuleSkinStyles, but only for 'skinStyles' - now ResourceLoaderFileModule needs to also handle it for 'skinScripts', and ResourceLoaderImageModule for 'images'). includes/resourceloader/ResourceLoaderFilePath.php * Add getters for local/remote base paths, for when we need to construct a new ResourceLoaderFilePath based on existing one. includes/resourceloader/ResourceLoaderFileModule.php includes/resourceloader/ResourceLoaderImageModule.php includes/resourceloader/ResourceLoaderOOUIImageModule.php * Add or improve handling of ResourceLoaderFilePaths: * Replace `(array)` casts with explicit array wrapping, to avoid casting objects into associative arrays. * Use getLocalPath() instead of string concatenation. tests/phpunit/includes/resourceloader/ResourceLoaderFileModuleTest.php tests/phpunit/includes/resourceloader/ResourceLoaderImageModuleTest.php * Some basic checks for the above. Bug: T100896 Change-Id: I74362f0fc215b26f1f104ce7bdbbac1e106736ad
2017-03-17 02:14:05 +00:00
"OOUIThemePaths": {
"type": "object",
"description": "Map of custom OOUI theme names to paths to load them from. Same format as ResourceLoaderOOUIModule::$builtinThemePaths.",
"patternProperties": {
"^[A-Za-z]+$": {
"type": "object",
"additionalProperties": false,
"properties": {
"scripts": {
"type": "string",
"description": "Path to script file."
},
"styles": {
"type": "string",
"description": "Path to style files. '{module}' will be replaced with the module's name."
},
"images": {
"type": [ "string", "null" ],
"description": "Path to images (optional). '{module}' will be replaced with the module's name."
}
}
}
}
},
registration: Support setting $wgPasswordPolicy in extension.json Bug: T149597 Change-Id: I56c0b8932fcd42ec9b748529daa32a998fb19bf8
2016-10-31 17:12:56 +00:00
"PasswordPolicy": {
"type": "object",
"description": "Password policies"
},
registration: Set "FileExtensions" to $GLOBALS Change-Id: Ie52004d25ebc06c81cd7d8d7de60479ff365ccea
2016-11-17 22:36:09 +00:00
"FileExtensions": {
registration: FileExtensions should be an array, not an object Change-Id: Iff44a4c241ab953906a7b0611f09e66856b1f7dc
2016-11-21 02:43:50 +00:00
"type": "array",
"description": "Preferred file extensions for uploading",
"items": {
"type": "string"
}
registration: Set "FileExtensions" to $GLOBALS Change-Id: Ie52004d25ebc06c81cd7d8d7de60479ff365ccea
2016-11-17 22:36:09 +00:00
},
Require editsitecss/editsitejs for editing raw messages Bug: T45646 Change-Id: Ib16db04e499ad28216ee08b8cccccf3f141e2bad
2018-07-31 22:19:40 +00:00
"RawHtmlMessages": {
"type": "array",
"description": "Messages which are rendered as raw HTML",
"items": {
"type": "string"
}
},
Add $wgReauthenticateTime to extension.json Change-Id: I9722c065d522e18b6bf488c721f48ee7b7b9e494
2018-11-15 23:39:58 +00:00
"ReauthenticateTime": {
"type": "object",
"patternProperties": {
".*": {
"type": "integer"
}
}
},
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
"callback": {
"type": [
"array",
"string"
],
"description": "A function to be called right after MediaWiki processes this file"
},
"config": {
"type": "object",
"description": "Configuration options for this extension",
"properties": {
"_prefix": {
"type": "string",
"default": "wg",
"description": "Prefix to put in front of configuration settings when exporting them to $GLOBALS"
}
},
"patternProperties": {
"^[a-zA-Z_\u007f-\u00ff][a-zA-Z0-9_\u007f-\u00ff]*$": {
"properties": {
"_merge_strategy": {
"type": "string",
"enum": [
"array_merge_recursive",
Added array_replace_recursive merge strategy For extension registry, add array_replace_recursive merge strategy, as some extensions/configuration may prefer that to array_merge_recursive. In some cases, configuration is merged from multiple extensions, such as JsonConfig's $wgJsonConfigs configuration: ZeroBanner defines "JsonZeroConfig": { "namespace": 480, "nsName": "Zero", "isLocal": false, "cacheKey": "1" } and mobile.php overrides it with $wgJsonConfigs['JsonZeroConfig']['isLocal'] = false; $wgJsonConfigs['JsonZeroConfig']['remote'] = [ 'url' => 'https://zero.wikimedia.org/w/api.php', 'username' => $wmgZeroPortalApiUserName, 'password' => $wmgZeroPortalApiPassword, ]; Having identical value 'isLocal' would be converted into an array if array_merge_recursive is used, but the replace strategy fixes it. Change-Id: Ica6ddd0ae76f23e60de9b6235c6e2a3f2754a95d
2016-10-18 05:23:56 +00:00
"array_replace_recursive",
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
"array_plus_2d",
"array_plus",
"array_merge"
],
"default": "array_merge"
}
}
}
}
},
"ParserTestFiles": {
"type": "array",
registration: Deprecate ParserTestFiles in extension.json Warnings will be emitted whenever validation is checked or unit tests are run. Bug: T192154 Change-Id: Ib968f696890667841d850ef5562e05989cb4f431
2019-06-03 01:33:24 +00:00
"description": "DEPRECATED: Parser test suite files to be run by parserTests.php when no specific filename is passed to it"
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
},
registration: Sync v2 and v1 schemas Unless it's an intentional deviation, everything in v2 should also be in v1. This copies over: * e71e025aba41: Add 'ParsoidModules' ... * 7abd828ea3a2: Extension schema updates for HookContainer * 34bff221badd: Introduce 'MessagePosterModule' extension attribute * e97f2943f2f7: QUnitTestModule should support packageFiles and templates ** d50c7f5b5689: Fix schemas for 'packageFiles' ** ee1f4f8ea380: Fix schemas for 'templates' * 3f0056a252da: REST API initial commit Change-Id: I1ae6fed0261ad29ea5cb39b3511b8cde392ab612
2020-07-20 23:27:32 +00:00
"SearchMappings": {
"type": "object",
"description": "Mapping of search canonical names (used in $wgSearchType and $wgSearchTypeAlternatives) using the Object Factory specification"
},
registration: Support 'ServiceWiringFiles' in extension.json Change-Id: Ib413a14cb8e21207264fa1c45d84550b3eab7a4e
2016-08-26 06:00:28 +00:00
"ServiceWiringFiles": {
"type": "array",
"description": "List of service wiring files to be loaded by the default instance of MediaWikiServices"
},
registration: Sync v2 and v1 schemas Unless it's an intentional deviation, everything in v2 should also be in v1. This copies over: * e71e025aba41: Add 'ParsoidModules' ... * 7abd828ea3a2: Extension schema updates for HookContainer * 34bff221badd: Introduce 'MessagePosterModule' extension attribute * e97f2943f2f7: QUnitTestModule should support packageFiles and templates ** d50c7f5b5689: Fix schemas for 'packageFiles' ** ee1f4f8ea380: Fix schemas for 'templates' * 3f0056a252da: REST API initial commit Change-Id: I1ae6fed0261ad29ea5cb39b3511b8cde392ab612
2020-07-20 23:27:32 +00:00
"RestRoutes": {
"type": "array",
"description": "List of route specifications to be added to the REST API",
"items": {
"type": "object",
"properties": {
"method": {
"oneOf": [
{
"type": "string",
"description": "The HTTP method name"
},
{
"type": "array",
"items": {
"type": "string",
"description": "An acceptable HTTP method name"
}
}
]
},
"path": {
"type": "string",
"description": "The path template. This should start with an initial slash, designating the root of the REST API. Path parameters are enclosed in braces, for example /endpoint/{param}."
},
"factory": {
"type": ["string", "array"],
"description": "A factory function to be called to create the handler for this route"
},
"class": {
"type": "string",
"description": "The fully-qualified class name of the handler. This should be omitted if a factory is specified."
},
"args": {
"type": "array",
"description": "The arguments passed to the handler constructor or factory"
},
"services": {
"type": "array",
"description": "If supplied and non-empty, the named services are requested from the service container and prepended before 'args'."
}
}
}
},
"ParsoidModules": {
"type": "array",
"description": "List of extension modules to be registered with the Parsoid wikitext parser",
"items": {
"oneOf": [
{
"type": "string",
"description": "The fully-qualified name of a class implementing Wikimedia\\Parsoid\\Ext\\ExtensionModule"
},
{
"type": "object",
"description": "An object factory specification for a class implementing Wikimedia\\Parsoid\\Ext\\ExtensionModule",
"properties": {
"factory": {
"type": ["string", "array"],
"description": "A factory function to be called to create an ExtensionModule. This should be omitted if a class is specified."
},
"class": {
"type": "string",
"description": "The fully-qualified class name of a class implemeting Wikimedia\\Parsoid\\Ext\\ExtensionModule. This should be omitted if a factory is specified."
},
"args": {
"type": "array",
"description": "The arguments passed to the ExtensionModule constructor or factory"
}
}
},
{
"type": "object",
"description": "A Parsoid extension module configuration array",
"properties": {
"domProcessors": {
"type": "array",
"items": {
"description": "Object factory specification of a class implementing Wikimedia\\Parsoid\\Ext\\DOMProcessor"
}
},
"styles": {
"type": "array",
"items": {
"type": "string",
"description": "Additional ResourceLoader styles to include"
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"description": "An extension tag",
"properties": {
"name": {
"type": "string",
"description": "The name of the extension tag",
"required": true
},
"handler": {
"description": "An object factory specification of a class extending Wikimedia\\Parsoid\\Ext\\ExtensionTagHandler"
},
"options": {
"type": "object",
"description": "Additional Parsoid processing configuration for this extension tag"
}
}
}
}
}
}
]
}
},
registration: Convert "config" into an object with metadata To add extra metadata for "config" options without constantly adding hacky underscore prefixed keys, convert "config" items into an object, where the value is under a "value" key. "_merge_strategy" is now just "merge_strategy", but still has the underscore prefix for the cache structure, to avoid changing it. Since this is a fully breaking change, it only applies to files with manifest_version: 2 set. A conversion script has been added to assist with automated conversion. Bug: T133626 Change-Id: Id1071fc0647892438e5cd0e3ee621fbdaaa64014
2016-06-22 22:33:35 +00:00
"load_composer_autoloader": {
"type": "boolean",
"description": "Load the composer autoloader for this extension, if one is present"
}
}
}
Reference in a new issue Copy permalink