npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

grunt-appcache-versioner

v1.0.2

Published

Versions your appcache manifest files with a checksum based on the contents of your CACHE header

Downloads

3

Readme

grunt-appcache-versioner

Versions your appcache manifest files with a checksum based on the contents of your CACHE header

Getting Started

This plugin requires Grunt ~0.4.5

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-appcache-versioner --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-appcache-versioner');

The "appcache_versioner" task

Overview

In your project's Gruntfile, add a section named appcache_versioner to the data object passed into grunt.initConfig().

grunt.initConfig({
  appcache_versioner: {
    manifests: {
      src: ["**/*.manifest", "**/*.appcache"],
      dest: "."
    },
  },
});

The Checksum

You might be wondering how the checksum is generated. This plugin iterates over all the files located in your CACHE header and creates a sha1 hash of their contents. This ensures that your appcache manifest file changes each time a file it's responsible for changes.

Usage Examples

Normal Use Case

This describes a common use case: simply adding a version to your currently existing manifest files.

grunt.initConfig({
  appcache_versioner: {
    manifests: {
      src: ["**/*.manifest", "**/*.appcache"],
      dest: "."
    },
  },
});

Let's say you have the following cache manifest file in the root directory of your project:

example.manifest
CACHE MANIFEST
#Version 1.0.0

CACHE:
some/file.html
some/other/script.js

NETWORK:
*

FALLBACK:
#No fallbacks

Running the above configuration will overwrite this file with the following:

example.manifest
CACHE MANIFEST
#ea91533aa7cebc582decb5c7c7ba573b3d7ebc2e

CACHE:
some/file.html
some/other/script.js

NETWORK:
*

FALLBACK:
#No fallbacks

Note by changing the dest property of your target the file will be written to the dest directory. For example, with dest: "build" your versioned manifest file will end up in build/example.manifest, leaving the original intact. The file structure is preserved, so if you had some/dir/example.manifest it would appear as build/some/dir/example.manifest

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

April 16, 2015 Released initial version of the plugin.