golem
/
VectorGOLEM
9
0
Fork 0
Code Issues 1 Pull Requests Releases Wiki Activity
Custom Vector theme/skin for GolemWiki, our instance of MediaWiki
1,833 Commits 2 Branches 6 Tags 4.5 MiB
PHP 36.4%
Less 29.9%
JavaScript 26.5%
Mustache 6.5%
Shell 0.7%
Go to file
Nikki Nikkhoui 193cd1c2d7 Add nvm to README 
Recommend using nvm in the README
so development environments are consistent.

Bug: T265682
Change-Id: I9dc4d67a6221fca9db883c216850a545e3c4b444
 		2020-10-19 18:07:12 +00:00
.phan Upgrade to newer phan 2019-03-20 19:37:59 -07:00
.storybook Set strictUnits to true for LESS, and fix units in the code 2020-10-16 23:42:57 +00:00
dev-scripts [Storybook] Fix PNG/SVG asset resolution. 2020-09-25 12:52:05 +02:00
i18n Localisation updates from https://translatewiki.net. 2020-10-15 08:40:19 +02:00
includes Use SkinMustache value for user messages 2020-10-09 11:38:38 -07:00
resources Merge "Add client-side performance metrics for searchLoader" 2020-10-15 08:47:18 +00: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 Fix storybook instance display of footer and personal menu 2020-10-08 16:08:43 -07:00
tests Drop unsupported skin CSS classes 2020-10-01 19:50:24 +00: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 [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] Add NVM configuration 2020-07-31 02:25:21 +00: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
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 Allow for expansion of styles with addition of table of contents code 2020-09-21 21:06:02 +00:00
composer.json build: Updating npm dependencies 2020-06-12 05:51:50 +00:00
jsdoc.json Adds loading indicator for new search module 2020-09-08 13:59:41 +00:00
package-lock.json build: Updating node-fetch to 2.6.1 2020-09-10 23:28:46 +00:00
package.json Windows compat in package.json scripts 2020-10-17 01:41:02 +02:00
skin.json Make VectorIsSearchInHeader the default 2020-09-29 22:15:14 +00:00
tsconfig.json [JavaScript] Validate types 2020-03-16 09:10:08 -06:00
variables.less Merge "Set strictUnits to true for LESS, and fix units in the code" 2020-10-19 17:40:24 +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.