wikimedia/mediawiki-skins-Vector
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/skins/Vector.git synced 2024-11-24 07:43:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Mirror of https://gerrit.wikimedia.org/g/mediawiki/skins/Vector
2755 commits 240 branches 5 tags 93 MiB
PHP 39.7%
JavaScript 36.6%
Less 18.4%
Mustache 4.3%
Vue 1%
Go to file
Nicholas Ray 6b73bd2b41 Fix jsdoc comments for sectionObserver.js 
Move jsdoc comment closer to the methods they are describing. This also
enables better typehint support.

I36b3ae7f9f633877683bc17a9444c970d7fa7293 will handle revising tableOfContents.js.

Change-Id: Ifcac7cfd88cd3f1c0405611c880a0d101d2aed3b
2022-02-11 12:17:38 -07:00
.phan
.storybook
dev-scripts
i18n Localisation updates from https://translatewiki.net. 2022-02-11 08:44:49 +01:00
includes
resources Fix jsdoc comments for sectionObserver.js 2022-02-11 12:17:38 -07:00
screenshots
skinStyles
stories
tests Move REST search client out of WVUI into Vector 2022-02-10 10:17:10 -06:00
.eslintignore
.eslintrc.json
.eslintrcEs6.json Limit WVUI search to ES6 browsers 2022-02-09 22:10:11 +00:00
.gitignore
.gitreview
.nvmrc
.phpcs.xml
.stylelintignore
.stylelintrc.json
.svgo.config.js
bundlesize.config.json
CODE_OF_CONDUCT.md
composer.json
COPYING
Doxyfile
jest.config.js
jest.setup.js Move REST search client out of WVUI into Vector 2022-02-10 10:17:10 -06:00
jsdoc.json Move REST search client out of WVUI into Vector 2022-02-10 10:17:10 -06:00
package-lock.json Move REST search client out of WVUI into Vector 2022-02-10 10:17:10 -06:00
package.json Move REST search client out of WVUI into Vector 2022-02-10 10:17:10 -06:00
README.md
skin.json Move REST search client out of WVUI into Vector 2022-02-10 10:17:10 -06:00
tsconfig.json

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.