wikimedia/mediawiki-skins-Vector
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/skins/Vector.git synced 2024-11-28 09:30:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
Mirror of https://gerrit.wikimedia.org/g/mediawiki/skins/Vector
1656 commits 14 branches 21 tags 95 MiB
PHP 39.7%
JavaScript 36.6%
Less 18.4%
Mustache 4.3%
Vue 1%
Go to file
Stephen Niedzielski cf17aee48b [build] Make the pre-commit hook optional 
Add a new NPM script, `pre-commit`, which _conditionally_ invokes
`npm test`. Previously, the pre-commit hook was configured by default to
invoke `npm test`. Now it is configured explicitly to invoke the new
`pre-commit` script.

The rationale for this change is that some folks may prefer workflows
that defer all validation until CI. Supporting these workflows is a
small change, most of it documentation.

This change isn't necessary for T257647 but supports and seems like an
overall improvement to the repo regardless of whether code is built or
not.

Bug: T257647
Change-Id: I19a78e0e677026cd6887245d96e63a414397a3db
2020-08-03 18:23:42 +00:00
.phan Upgrade to newer phan 2019-03-20 19:37:59 -07:00
.storybook Add storybook to Vector 2020-01-31 16:59:15 +08:00
dev-scripts [dev][Storybook] move to start script; report errors not status 2020-05-12 13:42:01 -07:00
i18n Localisation updates from https://translatewiki.net. 2020-07-30 08:38:20 +02:00
includes Cleanup: Drop unnecessary isLegacy checks 2020-07-30 15:10:57 -07:00
resources Collapse media print query 2020-07-29 11:16:29 -07:00
screenshots Add skin screenshot for the installer 2017-08-11 15:37:34 -04:00
skinStyles Replace deprecated @colorFieldBorder variable and use others 2020-04-28 01:42:09 +00:00
stories Cleanup: Drop unnecessary isLegacy checks 2020-07-30 15:10:57 -07:00
tests Merge SkinVector and VectorTemplate (step 2/2) 2020-07-30 12:20:13 -07:00
.eslintignore Replace Grunt tasks with npm scripts in package.json 2020-02-27 16:32:12 +01:00
.eslintrc.json [dev] [JS] Move JavaScript to package modules 2020-04-10 09:39:25 -06:00
.gitignore Drop wgVectorResponsive support from modern Vector 2020-07-02 22:08:37 +03:00
.gitreview Use track=1 instead of defaultbranch=master in .gitreview 2016-10-24 17:30:32 -07:00
.phpcs.xml Add method scope visibility 2018-11-01 21:01:32 +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.yml build: Add 'svgo', SVG minifier script and unify SVGO rules 2020-03-07 19:47:58 -08:00
bundlesize.config.json Implement Page, Workspace, Content, and Article Toolbar Containers 2020-07-07 18:34:38 -06:00
CODE_OF_CONDUCT.md build: Updating mediawiki/mediawiki-codesniffer to 22.0.0 2018-09-04 01:45:34 +00:00
composer.json build: Updating npm dependencies 2020-06-12 05:51:50 +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
jsdoc.json [feature] add menu button to toggle panel visibility 2020-05-28 02:14:13 +00:00
package-lock.json build: Updating elliptic to 6.5.3 2020-07-29 23:19:53 +00:00
package.json [build] Make the pre-commit hook optional 2020-08-03 18:23:42 +00:00
README.md [build] Make the pre-commit hook optional 2020-08-03 18:23:42 +00:00
skin.json Merge SkinVector and VectorTemplate (step 2/2) 2020-07-30 12:20:13 -07:00
tsconfig.json [JavaScript] Validate types 2020-03-16 09:10:08 -06:00
variables.less less: Remove duplicated variables from mediawiki.ui 2020-07-15 17:55:59 -07:00

README.md

Vector Skin

Installation

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

Configuration options

See skin.json.

Development

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.