amphtml-autoscript
Advanced tools
Readme
A Gulp plugin for automating the import of required custom-element <script/> tags in AMPHTML files.
Install package with NPM and add it to your development dependencies:
npm install --save-dev amphtml-autoscript
Add placeholder to your source files:
<!doctype html>
<html amp lang="en">
<head>
<meta charset="utf-8">
${ampjs}
<title>Hello, amphtml-autoscript!</title>
<!-- ..... -->
Incorporate the package in your gulpfile:
const autoScript = require('amphtml-autoscript').create();
gulp.task('tag', () => {
return gulp.src('*.html')
.pipe(autoScript())
.pipe(gulp.dest('dist/'));
});
Generated AMP HTML now includes any required custom-element <script/> tags:
<!doctype html>
<html amp lang="en">
<head>
<meta charset="utf-8">
<script async src="https://cdn.ampproject.org/v0.js"></script>
<script async custom-element="amp-bind" src="https://cdn.ampproject.org/v0/amp-bind-latest.js"></script>
<title>Hello, amphtml-autoscript!</title>
<!-- ..... -->
Options can be passed to .create(options) to change the operation in the following ways:
{
// Alternative placeholder to replace, e.g. [AMPJS], ${ampjs}, <<AMP-JS>>
placeholder: '...',
// Mode to operate in, either autoScript.MODES.PLACEHOLDER or autoScript.MODES.HEADER_INSERTION
// either replacing a string, or placing the elements at the end of the <head/> tag.
mode: autoScript.MODES.<value>,
// Force the update of the AMP components map, which will otherwise not be fetched again.
updateComponentsMap: true,
// Force use of 'latest' for all components
forceLatest: true
}
Under normal operation, the component version will be read from components.json, part of the
module. This will not update unless forced using the options above.
To specify a version local to your project, create a amp-versions.json file
in your build working directory, specifying desired versions e.g.
{
"amp-carousel": "0.2"
}
NOTE: versions in amp-versions.json will take precedence over forceLatest.
forceLatest and local component versions override.HEADER_INSERTION mode.FAQs
Imports required AMP HTML custom-elements into source files.
The npm package amphtml-autoscript receives a total of 13 weekly downloads. As such, amphtml-autoscript popularity was classified as not popular.
We found that amphtml-autoscript 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.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.