Go to file
Jan Drewniak 6907c81a15 [Storybook] Fix PNG/SVG asset resolution.
Fixes the missing images in the Logo story.

The current method of downloading the images into
docs/ui/assets and treating them as static assets
(with the start-storybook -s option) could be problematic
if that directory is deleted or "cleaned" before the
storybook build.

Instead, the images are now downloaded into
./storybook/resolve-imports and imported explicitly in the
code in Logo.stories.data.js.

* ./storybook/resolve-less-imports renamed to resolve-imports
* .gitignore is updated to reflect that
* Webpack config is updated with the `resolve-imports` path
* static option (-s) is removed from npm start script
* Images are explicitly imported in Logo.stories.data.js
* Type definitions are added for .svg and .png files

Change-Id: I242d229242c86a5784d6d4611d0b9c7049712dac
2020-09-25 12:52:05 +02:00
.phan Upgrade to newer phan 2019-03-20 19:37:59 -07:00
.storybook [Storybook] Fix PNG/SVG asset resolution. 2020-09-25 12:52:05 +02: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-09-22 08:37:00 +02:00
includes Merge "Clarify documentation of SkinVector::__construct()" 2020-09-21 21:04:00 +00:00
resources Merge "[styles] Make Trident workaround value a variable" 2020-09-22 15:06:25 +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 [Storybook] Fix PNG/SVG asset resolution. 2020-09-25 12:52:05 +02:00
tests Tests: name option is now required 2020-09-18 08:55:45 -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 [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
bundlesize.config.json Allow for expansion of styles with addition of table of contents code 2020-09-21 21:06:02 +00: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 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 [Storybook] Fix PNG/SVG asset resolution. 2020-09-25 12:52:05 +02:00
README.md [build] Make the pre-commit hook optional 2020-08-03 18:23:42 +00:00
skin.json Merge "Vector should use opt-in policy for ResourceLoaderSkinModule features" 2020-09-21 09:33:16 +00:00
tsconfig.json [JavaScript] Validate types 2020-03-16 09:10:08 -06:00
variables.less Merge "[styles] Make Trident workaround value a variable" 2020-09-22 15:06:25 +00:00

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.