grunt-codename

Utility to include a codename for your application based on version.

grunt-codename

Utility to include a codename for your application based on version (up-to v10.X.X-X).

This works great alongside version bump utility: grunt-bumpx for keeping your version numbers and names up-to-date with each build.

Included codenames and patchNames created with the help of the excellent codenamegenerator.com website.

This plugin requires Grunt ~0.4.1

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-codename --save-dev

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

grunt.loadNpmTasks('grunt-codename');

The project follows the SemVer guidelines for version numbers; specifically following: 1.2.3-1 being MAJOR.MINOR.PATCH-BUILD.

N.B. The supplied codenames and patchNames only include suport for single-digit numbers used for minor and patch of the version field (and major up to 10) - you must supply your own custom codenames and patchNames if you can't handle this restriction (but that's a lot of names)!

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

grunt.initConfig({
    codename: {
        options: {
            // Task-specific options go here. 
        },
        src: [
            // Target-specific files go here. 
        ]
    }
})

codename allows to set the codename and patchName based on the version number of the configuration files (package.json, manifest.json, etc.) in your project. Only JSON files are supported, and each file must have a version field compliant to SemVer guidelines; specifically following: 1.2.3-1 being MAJOR.MINOR.PATCH-BUILD.

Remember: The supplied codenames and patchNames only include suport for single-digit numbers used for minor and patch of the version field (and major up to 10) - you must supply your own custom codenames and patchNames if you can't handle this restriction (but that's a lot of names)!

codename is designed to update your package.json, manifest.json or any other JSON file with a "version" field (configured as noted above).

An example of a manifest.json file is below:

{
    "name": "My Test Application",
    "version": "1.3.2-16",
    "codename": "",
    "patchName": "",
    "description": "A test application for me."
}

Once codename has been used (with patchNames enabled); the manifest.json file would be updated automatically as follows:

{
    "name": "My Test Application",
    "version": "1.3.2-16",
    "codename": "Honiara Nimitz",
    "patchName": "Ithomiid",
    "description": "A test application for me."
}
options.*TypeDefaultDescription
patchBooleanfalseGenerate a name for the patch version as well as the main codename.
dataJSONUse custom JSON for the codenames (and patchNames as required).
codenamesObjectUse a custom object for codenames.
patchNamesObjectUse a custom object for patchNames.

Running the task in this way, the codename field of each source file will be automatically changed to the correct codename for the build release.

grunt.initConfig({
    codename: {
        src: ["package.json", "manifest.json"]
    }
})

Running the task in this way, the codename and patchName fields of each traget file will be changed to the correct codename and patchName for the next minor release based on the names contained within the user-supplied codenames.json file.

grunt.initConfig({
    codename: {
        options: {
            patch: true,
            data: grunt.file.readJSON ("codenames.json")
        },
        src: ["package.json", "manifest.json"]
    }
})

Any contribution to improve the project and/or expand it is welcome.

If you're interested in contributing to this project, take care to maintain the existing coding style.

To contribute:

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Changes, bug fixes and enhancements made to grunt-codename.

"Bronze Marklar" (Ithomiid)

  • [ENHANCEMENT] Updated codename JSON to break apart codenames for future development/simplify editing.
    • [ENHANCEMENT] Updated code to use the new JSON structure.
  • [ENHANCEMENT] Code name error checking implemented - will now throw an error if codename is not found for the given version string.
  • [ENHANCEMENT] Cleaned up getCodeName and getPatchName methods.

"Bronze Marklar" (Saiga)

  • [BUGFIX] Fixed issue where patchName would be written even if not required.
  • [FEATURE] If patchName is not required it is removed (if present) from the JSON file.
    • [ENHANCEMENT] Grunt log will correctly reflect this.
  • [ENHANCEMENT] Updated comments within codename.js.
  • [ENHANCEMENT] Minor code cleanup and year references updated to 2014.

"Bronze Marklar"

  • [ENHANCEMENT] Included codenames up to v10.X.X-X.

"Perseus Amber" (Zokor)

  • [BUGFIX] Fixed issue with incorrect version data.

"Perseus Amber" (Balbul)

  • [BUGFIX] Fixed issue that displayed incorrect messages within the GruntJS log output.
  • [BUGFIX] Removed incorrect code from the included GruntFile.js for demonstration purposes.

"Perseus Amber" (Malbrouck)

  • [BUGFIX] Fixed issue that caused patchName to stop functioning correctly.

"Perseus Amber" (Anoa)

  • [ENHANCEMENT] Updated this documentation a little to make the current version restrictions clear.
  • [ENHANCEMENT] Updated the demo GruntFile.js (included) to demonstrate our own autoBump method which ensures that single-digit bump occurs when using the utility.
    • When using the configuration as per our demo GruntFile.js bumping the patch part of the version will automatically switch to the minor part of the version and in-turn the major part of the version. For example (always bumping patch):
      • Version 0.8.8-12 becomes 0.8.9-0 which in turn becomes 0.9.0-0.
      • Version 0.9.8-12 becomes 0.9.9-0 which in turn becomes 1.0.0-0.

For more information, please see the included GruntFile.js.

"Perseus Amber" (Uromastix)

  • [ENHANCEMENT] Included this README.md.
  • [ENHANCEMENT] Updated documentation.

"Perseus Amber" (Tayra)

  • [ENHANCEMENT] Included this README.md.
  • [ENHANCEMENT] Updated documentation.

"Perseus Amber" (Pangolin)

  • [ENHANCEMENT] Moved codenames and patchNames to external JSON file.
  • [FEATURE] Added options to allow for better configuration.

"Perseus Amber" (Ithomiid)

  • [BUGFIX] Fixed issue with codename.

"Perseus Amber" (Saiga)

  • Initial commit.

See the LICENSE distributed with the project.