https://github.com/PolymerLabs/crisper
https://github.com/PolymerLabs/crisper
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/PolymerLabs/crisper
- Owner: PolymerLabs
- License: bsd-3-clause
- Archived: true
- Created: 2015-04-07T22:53:01.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2017-08-01T21:57:14.000Z (almost 9 years ago)
- Last Synced: 2025-09-02T04:13:19.370Z (10 months ago)
- Language: JavaScript
- Size: 46.9 KB
- Stars: 106
- Watchers: 40
- Forks: 22
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-polymer - Crisper
README
# Crisper
> Split inline scripts from an HTML file for CSP compliance
## Usage
Command line usage:
```
cat index.html | crisper -h build.html -j build.js
crisper --source index.html --html build.html --js build.js
crisper --html build.html --js build.js index.html
```
The output html file will load the output js file at the top of `` with a `` element.
Optional Flags:
- `--script-in-head=false`
- In the output HTML file, place the script at the end of `<body>`
- **Note**: Only use this if you need `document.write` support.
- `--only-split`
- Do not write a `<script>` tag in the output HTML
file.
- `--always-write-script`
- Always create a .js file, even without any `<script>`
elements.
- `--csp-hashable-script-loader`
- Create a hashable script loader that supports hash-based CSP with strict-dynamic.
- A strict CSP could look like this:
```
script-src 'strict-dynamic' 'sha256-mUZwR5zj1qMvnzisSvfmC8JczLB0BUKW0Ohr3euDoIA=';
object-src 'none';
base-uri 'self';
```
- `-v` | `--version`
- Prints version number.
Library usage:
```js
var output = crisper({
source: 'source HTML string',
jsFileName: 'output js file name.js',
scriptInHead: true, //default true
onlySplit: false, // default false
alwaysWriteScript: false // default false
});
fs.writeFile(htmlOutputFileName, output.html, 'utf-8', ...);
fs.writeFile(jsOutputFileName, output.js, 'utf-8', ...);
```
## Usage with Vulcanize
When using [vulcanize](https://github.com/Polymer/vulcanize), crisper can handle
the html string output directly and write the CSP separated files on the command
line
```
vulcanize index.html --inline-script | crisper --html build.html --js build.js
```
Or programmatically
```js
vulcanize.process('index.html', function(err, cb) {
if (err) {
return cb(err);
} else {
var out = crisper({
source: html,
jsFileName: 'name of js file.js',
scriptInHead: true, // default true
onlySplit: false, // default false
alwaysWriteScript: false //default false
})
cb(null, out.html, out.js);
}
});
```
## Breaking Changes from 1.x
- Deprecated `split` API was removed
- `require('crisper').split()`
- Default value of `script-in-head` flag changed to true
- This improves load performance by parallelizing HTML and script parsing
- This will break `document.write` calls
- If you experience problems, you can use `--script-in-head=false` argument or
`scriptInHead: false` in library usage.
## Build Tools
- [gulp-crisper](https://npmjs.com/package/gulp-crisper)
- [grunt-crisper](https://www.npmjs.com/package/grunt-crisper)