Go to file
bwang 18c65141f9 Remove env option from a11y test to enable tests to run in docs env
Change-Id: Ieef80011996b8e7c5ff11239f2c9ae53da9b3e99
2022-04-07 15:13:17 -05:00
.phan Upgrade to newer phan 2019-03-20 19:37:59 -07:00
.storybook Update Vector menu CSS to use vector-menu-heading instead of h3 2022-03-02 20:05:36 +05:30
dev-scripts [Storybook] Add Header component 2021-09-14 18:33:10 +00:00
i18n Merge "Update sticky header to use ARIA attributes for section collapsing and add accessible label to toggle buttons" 2022-04-07 15:51:56 +00:00
includes Merge "Drop the Vector.Config service" 2022-04-07 16:54:01 +00:00
resources Merge "Update sticky header to use ARIA attributes for section collapsing and add accessible label to toggle buttons" 2022-04-07 15:51:56 +00:00
screenshots Add skin screenshot for the installer 2017-08-11 15:37:34 -04:00
skinStyles Ensure sticky header ULS menu appears in default location right underneath the button 2022-01-19 19:37:25 +00:00
stories Revert "build: Update eslint-config-wikimedia to 0.22.1" 2022-03-16 23:40:42 +00:00
tests Remove env option from a11y test to enable tests to run in docs env 2022-04-07 15:13:17 -05:00
.eslintignore Setup jest unit tests and add basic test cases for AB.js and App.vue 2022-01-31 20:50:33 +00:00
.eslintrc.json [eslint] Disable mediawiki/class-doc 2022-02-11 16:31:33 +00:00
.eslintrcEs6.json [eslint] Disable mediawiki/class-doc 2022-02-11 16:31:33 +00:00
.gitignore Setup jest unit tests and add basic test cases for AB.js and App.vue 2022-01-31 20:50:33 +00:00
.gitreview Use track=1 instead of defaultbranch=master in .gitreview 2016-10-24 17:30:32 -07:00
.nvmrc Update Node version 2022-03-15 14:26:04 -07:00
.phpcs.xml build: Updating mediawiki/mediawiki-codesniffer to 33.0.0 2020-11-17 23:33:50 +01:00
.stylelintignore Setup jest unit tests and add basic test cases for AB.js and App.vue 2022-01-31 20:50:33 +00:00
.stylelintrc.json build: Updating stylelint-config-wikimedia to 0.11.1 2021-09-04 17:38:00 +00:00
.svgo.config.js build: Update 'svgo' to latest v2.8.0 & re-crush images 2022-02-28 00:00:05 +00:00
bundlesize.config.json Add sectionObserver and tableOfContents component JS to respond to intersection changes 2022-01-26 14:11:43 -07:00
CODE_OF_CONDUCT.md build: Updating mediawiki/mediawiki-codesniffer to 22.0.0 2018-09-04 01:45:34 +00:00
composer.json Add composer test:size as shortcut bundle size test 2021-12-10 19:59:19 +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
jest.config.js Sticky header dropdown should not contain gadgets in personal menu 2022-02-18 21:30:29 +00:00
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 Update sticky header to use ARIA attributes for section collapsing and add accessible label to toggle buttons 2022-04-06 17:24:34 -05:00
package.json Remove env option from a11y test to enable tests to run in docs env 2022-04-07 15:13:17 -05:00
README.md End migration mode 2022-03-23 16:46:42 +00:00
skin.json Drop the Vector.Config service 2022-04-07 04:30:20 +00:00
tsconfig.json Setup jest unit tests and add basic test cases for AB.js and App.vue 2022-01-31 20:50:33 +00:00

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

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.