version-brunch: A CoffeeScript repository from jacquarg

version-brunch

Adds application version support to brunch.io

Installation

Install the plugin via npm with npm install --save version-brunch.

Or, do manual install by adding text below to your package file inside your brunch application: Install plugin manually by adding text below to your package file inside your brunch application:

"version-brunch": "git+https://github.com/andrejd/version-brunch.git".

Usage

Plugin will create version.json file inside brunch public folder where it will store extended application version. Extended Application version is in sync with package.json file and in addition it also contains build number.

{
    "versionExt": "1.5.0.22"
}

Plugin also scans generated source files inside public folder after each bulid and replaces {!major!} {!minor!} {!maintenance!} {!build!} strings with parsed values from version.json file.

Or replace the version field value in any specified JSON file.

Configuration

There are some options that allow changing plugin defaults. You can add these settings to brunch-config.json file:

config =
    plugins:
        version:
            versionFile: "version.json"
            fileRegExp: /(app\.js|index\.html)$/
            fileVersionField: ""

After compilation all files in public folder are tested against fileRegExp and if test passes, file is updated with version details. versionFile allows changing file name where version details are persisted.

Live reload and version-brunch

Build number is increased after every compilation process and output files in public folder are inspected after every compilation for version strings.

In case when style sheet changes triggered compilation process, script files do not get regenerated and as a consequence version numbers in them points to the previous build. Keep that in mind when using live reload in browser.

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.