appcache-brunch's Introduction

appcache-brunch

Brunch plugin which generates a cache manifest as part of the brunch build process.

Usage

Install the plugin via npm with npm install --save-dev appcache-brunch.

Or, do manual install:

Add "appcache-brunch": "x.y.z" to package.json of your brunch app. Pick a plugin version that corresponds to your minor (y) brunch version.
If you want to use git version of plugin, add "appcache-brunch": "git+ssh://[email protected]:brunch/appcache-brunch.git".

Specify plugin settings in config.coffee. For example:

exports.config =
  # ...
  plugins:
    appcache:
      staticRoot: '/static'
      network: ['*']
      fallback: {}

Link to the manifest from each template. For example:

<html manifest="/static/appcache.appcache">

Settings

appcache.staticRoot

The static media root, such as ".", "/static" or "http://static.example.com".

Default value : '.'

appcache.ignore

A regular expression specifying paths to omit from the manifest.

Default value : /[/][.]/ (hidden files and files in hidden directories are ignored)

appcache.externalCacheEntries

An array of additionals URIs added to CACHE section. For example:

externalCacheEntries: [
  'http://other.example.org/image.jpg'
  # ...
]

Default value : []

appcache.network

An array of resource URIs which require a network connection added to NETWORK section. For example:

network: [
  'login.php'
  '/myapi'
  'http://api.twitter.com'
]

Default value : ["*"]

appcache.fallback

An object mapping resource URIs to fallback URIs added to FALLBACK section. For example:

fallback:
  '/main.py': '/static.html'
  'images/large/': 'images/offline.jpg'
  '*.html': '/offline.html'

Default value : {}

appcache.manifestFile

Output filename. For example:

manifestFile: "appcache.appcache"

Default value : "appcache.appcache"

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

appcache-brunch's People

Contributors

Stargazers

Watchers

appcache-brunch's Issues

list all static files in cache manifest, not just generated files

I created davidchambers/appcache-brunch-2 because this plugin does not provide the functionality I require:

I need to list all static files in the cache manifest, not just generated files. For example, app/assets/images/example.png gets copied to public/images/example.png, and this file is required for the app to run offline.
I need the cache manifest to change if any static file changes. If, for example, the aforementioned image file is tweaked, the cache manifest must change in some way to ensure that the browser checks for new versions of the listed files.

The strategy is as follows:

walk the public directory to generate a list of file paths
sort the list of paths
hash each of the files
concatenate the (sorted) hashes
hash the result
add the resulting hash to the cache manifest in a comment

If you're interested in adding this functionality, I'll open a pull request to essentially replace the existing code with the code from appcache-brunch-2. If you'd prefer not to change this project, I'll add appcache-brunch-2 to the list of plugins in the wiki. Ideally, though, there should be just one Brunch plugin for generating a cache manifest.

brunch / appcache-brunch Goto Github PK