https://github.com/ryanburnette/hashref

https://github.com/ryanburnette/hashref

Last synced: 17 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/ryanburnette/hashref
• Owner: ryanburnette
• License: mpl-2.0
• Created: 2023-05-15T14:24:37.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-19T03:19:00.000Z (3 months ago)
• Last Synced: 2024-11-19T04:17:41.759Z (3 months ago)
• Language: Go
• Size: 37.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [hashref](https://github.com/ryanburnette/go-hashref)

![hashrefs](https://github.com/ryanburnette/go-hashref/assets/2252601/fb9ae441-0461-4989-8fee-9ddbb31ee0fb)

hashref is a command-line tool designed to simplify cache busting for generated `.html`, `.css`, and `.js` files. It simplifies the process of cache busting by adding a short hash to the filenames of generated assets such as .css and .js files. By incorporating the hash in the filenames, hashref enables cache busting when the content of the assets changes.

## Features

-   Cache busting: hashref adds a hash to the filenames of generated assets, allowing for reliable cache busting when the assets change.

-   Compatible with cache strategy: hashref seamlessly integrates with cache strategies that rely on HTTP server configurations to handle asset caching. It leverages the hash in the filenames to trigger cache updates when changes occur.

-   Support for various asset references: hashref handles absolute, relative, and base style asset references within HTML, ensuring consistent cache busting across different reference types.

-   Internal references only: hashref operates exclusively on internal asset references within the generated HTML, CSS, and JS files. It does not modify or process external references.

By utilizing hashref, developers can effortlessly incorporate cache busting into their build process and enhance the efficiency of asset caching, ensuring that updated assets are served to end users when changes occur.

## Usage

```shell

Usage:

	hash-assets -dir  [-d] [-hash-len] [-asset-exts] [-markup-exts]

Options:

	-dir string

		Specify the working directory path (required).

	-d

		Perform a dry run without making any changes.

	-hash-len string

		Specify the length of the hash string (default "10").

	-asset-ext string

		Specify the asset file extensions (default ".css,.js").

	-markup-ext string

		Specify the markup file extensions (default ".html,.htm").

```