This script automatically updates the CDN version inside of the HTML based on the version specified in package.json.
Run node scripts to execute the runner. This will give you info about each command.
This script allows users to create their own custom Skin bundle.
In order to view all the avaialbe options and subcommands you can run scripts bundle --help. Also eash subcommand has it's own help.
| Command | Description |
|---|---|
scripts list |
Lists the available modules for use with the --modules option |
scripts bundle ebay --modules global carousel |
Creates a bundle called ebay which consists of the global and carousel modules |
scripts bundle ebay --scope-class ebay-wrap |
Creates a bundle called ebay which has all styles wrapped by .ebay-wrap |
Generates top level imports. See generate-imports/README.md
This creates multiple files. We create a {module}.browser.json a {module}.js a {module}.css and a {module}.mjs file, where the module is each skin module.
These are easy improts to all dist files, which include all of each of the modules dependencies.
A js file is included as a way to import in any bundler (lasso, wepack, or vite). This allows a common way for bundlers to import the modules and not duplicate any imports. However, CSS and MJS files are also available if needed for different bundlers or imports directly form less files or module imports.
Cleans top level improts. See generate-imports/README.md
Generates less files with width/height styles for all icons located in src/svg directory. See the configuration section for more info on how to configure.
Configuration for this script is located at docs/_data/icons.yaml
This contains a list of icon modules to generate. Each key will look up an icon file, if that exists then it will generate css for those.
| Global Config | Description |
| skip | The id of icons to not generate config for |
| Icon specific config | Description |
|---|---|
prefix |
The prefixed name, this will be used as the beginning part of the icon name as well as the default output directory if output is not defined |
size |
Default size for these icons. Defaults to 24px for regular sizes, and 16px for small. |
postfix |
The postfix name, this will be used as the end part of the icon name |
file |
The src/svg filename to pull icons from |
output |
The file directory to output the generated css file to. Defaults to the src/sass/icon directory. |
Script used to import an SVG into the icon file. It will try to optimize the SVG and remove any unused tags.
It is recommended to run scripts gen script after running the scripts importSVG script
scripts importSVG path/to/svg.svg svgID skinSvgFileName
Example
scripts importSVG ~/Downloads/newSvg.svg icon-new-large-icon large