Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/metonym/hash-static
Utility to hash static assets
https://github.com/metonym/hash-static
cache hash posthtml static-assets utility
Last synced: 25 days ago
JSON representation
Utility to hash static assets
- Host: GitHub
- URL: https://github.com/metonym/hash-static
- Owner: metonym
- License: mit
- Created: 2019-10-06T15:33:04.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T16:20:31.000Z (almost 2 years ago)
- Last Synced: 2023-11-03T17:44:39.511Z (about 1 year ago)
- Topics: cache, hash, posthtml, static-assets, utility
- Language: TypeScript
- Size: 1.68 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# hash-static
[![NPM][npm]][npm-url]
[![Build][build]][build-badge]
[![Coverage][codecov-shield]][codecov]
> Utility to hash static assets.
`hash-static` provides a CLI to minify and hash static assets using [htmlnano](https://github.com/posthtml/htmlnano) and [posthtml-hash](https://github.com/posthtml/posthtml-hash).
## Install
```bash
yarn add -D hash-static
```
## Usage
The entry must be an `index.html` file. The path is relative from the current directory.
### CLI
```bash
yarn run hash-static 'dist/index.html'
```
You can use the CLI as a postbuild script to `package.json`.
```diff
"scripts": {
"build": "rollup -c",
+ "postbuild": "hash-static dist/index.html"
}
```
Then, running `yarn build` will automatically run the `postbuild` script.
### Node
```js
const { hashStatic } = require('hash-static');
hashStatic({ entry: 'dist/index.html' });
```
### Options
| Name | Kind | Description |
| -------- | -------------------------------------- | -------------------------------------------------------------- |
| `entry` | **required** `string` | Relative path from the current directory to entry `index.html` |
| `minify` | optional `boolean` (default is `true`) | Minify `index.html` markup |
## [Changelog](CHANGELOG.md)
## License
[MIT](LICENSE)
[npm]: https://img.shields.io/npm/v/hash-static.svg?color=blue
[npm-url]: https://npmjs.com/package/hash-static
[build]: https://travis-ci.com/metonym/hash-static.svg?branch=master
[build-badge]: https://travis-ci.com/metonym/hash-static
[codecov]: https://codecov.io/gh/metonym/hash-static
[codecov-shield]: https://img.shields.io/codecov/c/github/metonym/hash-static.svg