Custom Vector theme/skin for GolemWiki, our instance of MediaWiki
Go to file
Nicholas Ray 49f2b25737 Create A/B test harness for Language in header feature
* Adds ab test config to enable/disable the ab test. Defaults to `false`
(ab test disabled).

* Adds a `languageinheader` query param which only takes effect when the
ab test is enabled. The query param is cast to a bool and determines
which treatment is shown. For example, set query param to
`languageinheader=1` to see the new treatment. Set query param to
`languageinheader=0` to see the old treatment. To bucket based on the
user's id or global user's id, don't set the query param.

* Moves the language in header config work that was previously in
ServiceWiring into a `LanguageInHeaderTreatmentRequirement` class so
that unit tests can be done on most of the logic that determines whether
the language in header will show.

* Adds logic to bucket user based on [global] user id.

Bug: T280825
Change-Id: Id538fe6e09002fae6c371109769f3b7d61e7ac6d
2021-05-04 14:41:53 -06:00
.phan Upgrade to newer phan 2019-03-20 19:37:59 -07:00
.storybook Reorganize LESS files to match ResourceLoader conventions 2021-04-08 15:47:56 +01:00
dev-scripts Language button is quiet with focus, active and hover states 2021-03-01 20:01:45 +00:00
i18n Localisation updates from https://translatewiki.net. 2021-05-03 08:41:02 +02:00
includes Create A/B test harness for Language in header feature 2021-05-04 14:41:53 -06:00
resources search: Prevent double-escaping of messages passed to typeahead-search 2021-04-29 11:34:48 -07:00
screenshots Add skin screenshot for the installer 2017-08-11 15:37:34 -04:00
skinStyles Reorganize LESS files to match ResourceLoader conventions 2021-04-08 15:47:56 +01:00
stories Language button is quiet with focus, active and hover states 2021-03-01 20:01:45 +00:00
tests Create A/B test harness for Language in header feature 2021-05-04 14:41:53 -06:00
.eslintignore Replace Grunt tasks with npm scripts in package.json 2020-02-27 16:32:12 +01:00
.eslintrc.json build: Updating eslint-config-wikimedia to 0.19.0 2021-03-15 04:57:07 +00:00
.gitignore [Storybook] Fix PNG/SVG asset resolution. 2020-09-25 12:52:05 +02:00
.gitreview Use track=1 instead of defaultbranch=master in .gitreview 2016-10-24 17:30:32 -07:00
.nvmrc build: Switch node version to 10.24.0 now CI is on buster 2021-04-30 11:46:37 -07:00
.phpcs.xml build: Updating mediawiki/mediawiki-codesniffer to 33.0.0 2020-11-17 23:33:50 +01:00
.stylelintignore Replace Grunt tasks with npm scripts in package.json 2020-02-27 16:32:12 +01:00
.stylelintrc.json build: Bump devDependencies to latest 2018-02-26 10:29:23 -08:00
.svgo.config.js build: Update SVGO to latest v2.2.2 and re-crush SVGs 2021-03-25 09:19:42 -07:00
CODE_OF_CONDUCT.md build: Updating mediawiki/mediawiki-codesniffer to 22.0.0 2018-09-04 01:45:34 +00:00
COPYING Use the plain-text GPL and fix 'license-name' to match SPDX conventions 2015-01-29 17:04:29 +01:00
Doxyfile docs: Generate documentation with Doxygen 2020-02-24 16:49:38 +00:00
README.md Add nvm to README 2020-10-19 18:07:12 +00:00
bundlesize.config.json Round up to nearest kb 2021-02-11 16:51:41 +00:00
composer.json build: Updating composer dependencies 2021-05-04 12:41:27 +00:00
jsdoc.json Integrate WVUI search into Vector 2020-12-08 13:27:12 -08:00
package-lock.json build: Updating composer dependencies 2021-05-04 12:41:27 +00:00
package.json build: Update 'svgo' to latest 2021-04-18 14:51:48 -07:00
skin.json Create A/B test harness for Language in header feature 2021-05-04 14:41:53 -06:00
tsconfig.json build: Updating eslint-config-wikimedia to 0.19.0 2021-03-15 04:57:07 +00:00

README.md

Vector Skin

Installation

See https://www.mediawiki.org/wiki/Skin:Vector.

Configuration options

See skin.json.

Development

Node version

It is recommended to use nvm to use the version of node defined in .nvmrc during local development. This ensures consistency amongst development environments.

Coding conventions

We strive for compliance with MediaWiki conventions:

https://www.mediawiki.org/wiki/Manual:Coding_conventions

Additions and deviations from those conventions that are more tailored to this project are noted at:

https://www.mediawiki.org/wiki/Reading/Web/Coding_conventions

URL query parameters

Skin preferences

Vector defines skin-specific user preferences. These are exposed on Special:Preferences when the VectorShowSkinPreferences configuration is enabled. The user's preference state for skin preferences is used for skin previews and any other operation unless specified otherwise.

Version

Vector defines a "version" preference to enable users who prefer the December 2019 version of Vector to continue to do so without any visible changes. This version is called "Legacy Vector." The related preference defaults are configurable via the configurations prefixed with VectorDefaultSkinVersion. Version preference and configuration may be overridden by the useskinversion URL query parameter.

Pre-commit tests

A pre-commit hook is installed when executing npm install. By default, it runs npm test which is useful for automatically validating everything that can be in a reasonable amount of time. If you wish to defer these tests to be executed by continuous integration only, set the PRE_COMMIT environment variable to 0:

$ export PRE_COMMIT=0
$ git commit

Or more succinctly:

$ PRE_COMMIT=0 git commit

Skipping the pre-commit tests has no impact on Gerrit change identifier hooks.

Hooks

See hooks.txt.