-### Format of this file
+# ## Format of this file
#
-# The top-level keys are directory names (under resources/lib/).
-# They should match module names (as registered in Resources.php), but there are exceptions.
-# Each top-level key holds a resource descriptor that must have one of
-# the following `type` values:
+# The top-level keys in this file correspond with directories under resources/lib/.
+# These in turn are registered as module bundles in Resources.php.
#
-# - `tar`: For tarball archive (may be gzip-compressed).
-# - `file: For a plain file.
-# - `multi-file`: For multiple plain files.
+# ## How to install an foreign resource
+#
+# 1. Add or update the url(s) for the upstream module to this YAML file.
+#
+# Look at other modules for examples. To install a module from npm,
+# we use the tarball distribution from npmjs.org. This is the same as what
+# the npm CLI uses. For example, to install jquery-client@9.2.0, use:
+# <https://registry.npmjs.org/jquery-client/-/jquery-client-9.2.0.tgz>.
+#
+# 2. If the upstream maintainers publish an integrity hash, set that as well.
+# Otherwise, use manageForeignResources.php to compute the integrity hash.
+#
+# Run `php manageForeignResources.php make-sri "my module name"`
+#
+# This will download the specified file(s) and print their integrity hashes,
+# already formatted in YAML, ready for copying to this file.
#
-### Type tar
+# 3. Last but not least, decide where files go.
+#
+# If you specified a direct url to JavaScript or CSS file, this step is
+# optional. See the corresponding documentation section below for more
+# information and examples for "dest" keys. Once you've set any "dest" keys,
+# run `php manageForeignResources.php update "my module name"`.
+#
+# ## Package formats
+#
+# Each top-level key must use one of these types:
+#
+# - `file`: For a plain file.
+# - `multi-file`: For multiple plain files.
+# - `tar`: For a tarball archive (may be compressed).
#
-# The `src` and `integrity` keys are required.
+# ### The "file" type
#
# * `src`: Full URL to the remote resource.
# * `integrity`: Cryptographic hash (integrity metadata format per <https://www.w3.org/TR/SRI/>).
-# * `dest`: An object mapping paths to files or directory from the remote resource to a destination
-# in the module directory. The value of key in dest may be omitted, which will extract the key
-# directly to the module directory.
+# * `dest`: [optional] The file name to use in the module directory. Default: Basename of URL.
#
-### Type file
+# For example, the following would produce resources/lib/mymodule/x.js:
#
-# The `src` and `integrity` keys are required.
+# mymodule:
+# type: file
+# src: https://mymodule.example/1.2.3/x.js
+# integrity: sha384-Je+NE+saisQuoi
+#
+# ### The "multi-file" type
+#
+# * `files`: An object mapping destination paths to `src` and `integrity` keys.
+#
+# For example:
+#
+# mymodule:
+# type: multi-file
+# files:
+# x.js:
+# src: https://mymodule.example/1.2.3/x.js
+# integrity: sha384-Je+NE+saisQuoi
+# x.css:
+# src: https://mymodule.example/1.2.3/x.css
+# integrity: sha384-Je+NE+saisQuoi
+#
+# ### The "tar" type
#
# * `src`: Full URL to the remote resource.
# * `integrity`: Cryptographic hash (integrity metadata format per <https://www.w3.org/TR/SRI/>).
-# * `dest`: The name of the file in the module directory. Default: Basename of URL.
+# * `dest`: [optional] The default is to extract all files from the package.
+# To only extract some of the files or directories, use "dest" to specify
+# files, directories, and/or glob patterns. You can use a site like https://unpkg.com/
+# to easily inspect an npm package, like <https://unpkg.com/jquery-client@2.0.2/>.
#
-### Type multi-file
+# For example:
#
-# The `files` key is required.
+# mymodule:
+# type: tar
+# src: https://registry.npmjs.org/jquery-client/-/jquery-client-9.2.0.tgz
+# integrity: sha384-Je+NE+saisQuoi
+# dest:
+# package/dist/x.js:
+# package/dist/i18n:
+# package/dist/style/*.css:
+#
+# The would extract the "x.js" file, the "i18n" directory (recursive),
+# and any "*.css" files from the "style" directory.
#
-# * `files`: An object mapping destination paths to an object containing `src` and `integrity`
-# keys.
CLDRPluralRuleParser:
type: file
integrity: sha256-2Kok7MbOyxpgUVvAk/HJ2jigOSYS2auK4Pfzbm7uH60=
dest: jquery.js
+# TODO: jquery.async.js
+
+# TODO: jquery.chosen
+
jquery.client:
type: tar
src: https://registry.npmjs.org/jquery-client/-/jquery-client-2.0.2.tgz
type: file
src: https://raw.githubusercontent.com/jquery-form/form/ff80d9ddf4/jquery.form.js
integrity: sha384-h4G2CrcSbixzMvrrK259cNBYaL/vS1D4+KdUN9NJDzQnTU1bQ6Avluget+Id13M7
- dest: jquery.form.js
jquery.fullscreen:
type: file
src: https://raw.githubusercontent.com/theopolisme/jquery-fullscreen/v2.1.0/jquery.fullscreen.js
integrity: sha384-G4KPs2d99tgcsyUnJ3eeZ1r2hEKDwZfc4+/xowL/LIemq2VVwEE8HpVAWt4WYNLR
- dest: jquery.fullscreen.js
jquery.hoverIntent:
type: file
src: https://raw.githubusercontent.com/briancherne/jquery-hoverIntent/823603fdac/jquery.hoverIntent.js
integrity: sha384-lca0haN0hqFGGh2aYUhtAgX9dhVHfQnTADH4svDeM6gcXnL7aFGeAi1NYwipDMyS
- dest: jquery.hoverIntent.js
+
+# TODO: jquery.i18n
jquery.jStorage:
type: file
src: https://raw.githubusercontent.com/andris9/jStorage/v0.4.12/jstorage.js
integrity: sha384-geMeN8k803kPp6cqRL4VNfuSM1L8DcbKRk0St/KHJzxgpX9S0y9FA6HxA/JgucrJ
- dest: jstorage.js
jquery.throttle-debounce:
type: file
src: https://raw.githubusercontent.com/cowboy/jquery-throttle-debounce/v1.1/jquery.ba-throttle-debounce.js
integrity: sha384-ULOy4DbAghrCqRcrTJLXOY9e4gDpWh0BeEf6xMSL0VtNudXWggcb6AmrVrl4KDAP
- dest: jquery.ba-throttle-debounce.js
+
+# TODO: jquery.ui (!)
moment:
type: tar
type: multi-file
files:
mustache.js:
- src: https://raw.githubusercontent.com/janl/mustache.js/v1.0.0/mustache.js
- integrity: sha384-k2UYqmzoiq/qgIzZvcYBxbXQW4YdPAsXDOTkHTGb9TCZ9sjCkyT4TlaUN0wQRkql
+ src: https://raw.githubusercontent.com/janl/mustache.js/v3.0.1/mustache.js
+ integrity: sha384-YjAj6Nll7fkEWzxTlE9o3NWC9qdZt1Upat6Afjib9eLs8lTODpSKEBHeXq8o/VUH
LICENSE:
- src: https://raw.githubusercontent.com/janl/mustache.js/v1.0.0/LICENSE
- integrity: sha384-MYVwXwula9+YkyXexOJVZ0v0DaVvG22uX57mNq5Di+7u8OH9EG9q3yuXkp1Iehiq
+ src: https://raw.githubusercontent.com/janl/mustache.js/v3.0.1/LICENSE
+ integrity: sha384-j2EDj6YtCRgFvYDtzo6pXzbskIj/K1Yg65BL0j3/L6UIHxbMtRMJwC/W+XoYx0FZ
oojs:
type: tar
ooui:
type: tar
- src: https://registry.npmjs.org/oojs-ui/-/oojs-ui-0.31.1.tgz
- integrity: sha384-M9KdU6u02zSKCVczcw6YJmSvFLhdeagNg9CPhizYVqrybL8bamrF5u6YfrFGEyiv
+ src: https://registry.npmjs.org/oojs-ui/-/oojs-ui-0.31.4.tgz
+ integrity: sha384-wjuecyP+T8lOhBbetLnx02IET5sW71aR0wYRJLBorBhOF6ry7pZOwLTE+XpQtnLu
dest:
# Main stuff
package/dist/oojs-ui-core.js{,.map.json}:
package/dist/themes/wikimediaui/images/icons/*.{svg,png}: themes/wikimediaui/images/icons
package/dist/themes/wikimediaui/images/indicators/*.{svg,png}: themes/wikimediaui/images/indicators
package/dist/themes/wikimediaui/images/textures/*.{gif,svg}: themes/wikimediaui/images/textures
- package/src/themes/wikimediaui/*.json: themes/wikimediaui
+ package/dist/themes/wikimediaui/*.json: themes/wikimediaui
package/dist/wikimedia-ui-base.less:
# Apex theme (icons, indicators, and textures)
- package/src/themes/apex/*.json: themes/apex
+ package/dist/themes/apex/*.json: themes/apex
# Misc stuff
package/dist/AUTHORS.txt:
package/dist/History.md:
dépôts / lhc / web / wiklou.git / blobdiff