Releases: BladeRunnerJS/brjs-appcache
BRJS 1.0 Compatability
AppCache Plugin v3.0.0 - BRJS 1.0 Compatibility
Changes to make the plugin compatible with BRJS 1.0 plugin API changes.
- The version is now configured via the internal BRJS version rather than a separate config file. See below for usage.
- The tokens
$timestamp
and$brjsVersion
are no longer needed or supported as the BRJS model version already provides this.
Usage
Quick start
- Download the latest
appcache-plugin.jar
at https://github.com/BladeRunnerJS/brjs-appcache/releases - Copy the plugin JAR to the BRJS
conf/java
folder. - Add the appcache plugin tag to your HTML element e.g.
<html manifest="<@appcache.url@/>">
Usage
Installation
- Copy the plugin JAR to the BRJS
conf/java
folder.
Enabling
- The plugin provides the
appcache.url
tag handler. This tag will replaced with the URL to the manifest file, so you should set themanifest
attribute on thehtml
element to use the tag as its value.- To do this change the
html
element to<html manifest="<@appcache.url@/>">
- To do this change the
Configuration
- By default the appcache is disabled in 'dev' and a URL that returns a 404 response will be used to disable the cache
- The appcache version is configured via the
BRJS
version property. - To enable the appcache in 'dev' the version should be changed to a numbered version. To do this run the
serve
command
with the 'version' argument, for examplebrjs serve -v 1.2.3
. A timestamp will be appended to the
version to ensure versions are unique.- The timestamp is calculated when the serve is started and will not
change on subsequent reloads. This is to ensure the version remains static in the manifest as browser's
will throw an exception is the manifest file changes while assets are being downloaded. To change the version
the server will need to be restarted for a new timestamp to be generated.
- The timestamp is calculated when the serve is started and will not
- When building an app for production the version can be supplied via the 'version' argument, for example
brjs build-app foo -v 1.2.3
.
As with the serve command a timestamp is also appended to this version.
Better Versioning
AppCache Plugin v2.1.0
A few changes to how versioning is handled by the appcache to allow greater customisation by developers and better version handling in the browser.
- The version config option is now split into
version
for prod anddevVersion
for dev. - The version config options support special variables $timestamp and $brjsVersion. See the readme configuration section for more details.
- The appcache is now disabled in prod unless a version is configured.
- To replicate the old behaviour your appcache configuration should contain
version: $brjsVersion
- To replicate the old behaviour your appcache configuration should contain
- In dev mode the appcache now always uses 'appcache-disabled' as the manifest string if the appcache is not configured. This prevents an issue when connecting to one BRJS instance with multiple devices where appcache would not be disabled properly.
- A $BRJS_APPCACHE_VERSION property is now added to the window object which stores the current appcache version. This allows more powerful version checking via JavaScript.
20140919 Note the originally uploaded JAR was built with Java 8 and may have produced compatibility issues with some systems. This has been replaced with a Java 7 built version. The Java 8 version is still available with the
-java8
suffix.
Instant disable
AppCache Plugin v2.0.1
- When appcache is disabled it no longer tries to recache everything before disabling, making the disable almost instant
AppCache Plugin v2.0.0
AppCache Plugin v2.0.0
- Updated to work with BRJS 0.11
- Updated to match the changes to the url in BRJS 0.11
Due to major changes in BRJS 0.10+ this version of the plugin is not backwards compatible with older BRJS versions.
BRJS 0.8 support
AppCache Plugin v1.0.2
-
Updated to work with BRJS 0.8
-
Fixed a bug where spaces in filenames would break the manifest.
- This was due to the appcache manifest file not supporting spaces. Spaces are now URL encoded before being written to the manifest.
Spaces in filenames may still not work due to a BRJS bug BladeRunnerJS/brjs#715
The build cleanup release
AppCache Plugin v1.0.1
- Removed the
appcache-plugin.jar
artifact that was checked into the repository. This is now available here in GitHub Releases.
Compatability Issues
- DEVELOPERS: Use of the JAR placed in the project root directory is now deprecated. The JAR generated in
build/libs/appcache-plugin.jar
should be used instead.
First release!
At this point we think the appcache plugin is ready to start being used, so go ahead and try it out!