Named for the Vulcanization process that turns polymers into more durable materials.
vulcanize is available on npm. For maximium utility, vulcanize should be installed globally.
sudo npm install -g vulcanize
This will install vulcanize to /usr/local/bin/vulcanize.
vulcanize index.html
At the simplest, vulcanize only requires an html file as an argument. The optimized output file will be named
vulcanized.html.
If you want to control the output name, use the -o flag
vulcanize -o build.html index.html
Most URLs will be automatically adjusted by the vulcanizer.
--output, -o--verbose, -v--help, -v, -?--config
--strip, -s
--csp<output file name>.js)--inline--inline --csp
<output file name>.js--abspath, -p
--no-strip-excludes
--version, -V
JSON file for additional options
{
"excludes": {
"imports": [
"regex-to-exclude"
]
}
}
Say we have three html files: index.html, x-app.html, and x-dep.html.
index.html:
<!DOCTYPE html>
<link rel="import" href="x-app.html">
<x-app></x-app>
x-app.html:
<link rel="import" href="path/to/x-dep.html">
<polymer-element name="x-app">
<template>
<x-dep></x-dep>
</template>
<script>Polymer('x-app')</script>
</polymer-element>
x-dep.html:
<polymer-element name="x-dep">
<template>
<img src="x-dep-icon.jpg">
</template>
<script>
Polymer('x-dep');
</script>
</polymer-element>
Running vulcan on index.html, and specifying build.html as the output:
vulcanize -o build.html index.html
Will result in build.html that appears as so:
<!DOCTYPE html>
<div hidden><polymer-element name="x-dep" assetpath="path/to/">
<template>
<img src="http://www.polymer-project.org/images/logos/p-logo.svg">
</template>
<script>
Polymer('x-dep');
</script>
</polymer-element>
<polymer-element name="x-app" assetpath="">
<template>
<x-dep></x-dep>
</template>
<script>Polymer('x-app')</script>
</polymer-element>
</div>
<x-app></x-app>
Content Security Policy, or CSP, is a Javascript security model that aims to prevent XSS and other attacks. In so doing, it prohibits the use of inline scripts.
To help automate the use of Polymer element registration with CSP, the --csp flag to vulcan will remove all scripts
from the HTML Imports and place their contents into an output javascript file.
Using the previous example, the output from vulcanize --csp -o build.html index.html will be
build.html:
<!DOCTYPE html>
<div hidden><polymer-element name="x-dep" assetpath="path/to/">
<template>
<img src="http://www.polymer-project.org/images/logos/p-logo.svg">
</template>
</polymer-element>
<polymer-element name="x-app" assetpath="">
<template>
<x-dep></x-dep>
</template>
</polymer-element>
</div>
<x-app></x-app>
<script src="build.js"></script>
build.js:
Polymer('x-dep');
;
Polymer('x-app')
The JS files can become a bit messy without reformatting, and semi-colons are inserted between script contents as a precaution.
Vulcanize includes a set of size reducing heuristics to remove unnecessary whitespace and comments in HTML, JS, and CSS.
This can be activated by using the --strip option.
Using the previous example, the output from vulcanize --csp -o build.html --strip index.html will be
build.html:
<!DOCTYPE html>
<div hidden><polymer-element name="x-dep" assetpath="path/to/"><template><img src="http://www.polymer-project.org/images/logos/p-logo.svg"></template></polymer-element><polymer-element name="x-app" assetpath=""><template><x-dep></x-dep></template></polymer-element></div>
<x-app></x-app>
<script src="build.js"></script>
Polymer("x-dep");Polymer("x-app");
0.6.2
<template> support is completeFAQs
Process Web Components into one output file
The npm package vulcanize receives a total of 4,514 weekly downloads. As such, vulcanize popularity was classified as popular.
We found that vulcanize demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.