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-githash

v0.1.3

Published

Grunt plugin to get the current git hash, branch and tag

Downloads

2,925

Readme

grunt-githash

Build Status NPM version Dependency Status

Grunt plugin to get the current git hash, git branch and git tag

Getting Started

This plugin requires Grunt.

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

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

grunt.loadNpmTasks('grunt-githash');

The "githash" task

Overview

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

grunt.initConfig({
  githash: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
})

Options

options.dir

Type: String Default value: '.'

options.fail

Type: Boolean Default value: true Reports a warning if not inside a git respository

Available values

githash.{target}.branch

Type: String Value: branch name

githash.{target}.tag

Type: String Value: tag name

githash.{target}.hash

Type: String Value: the full hash value

githash.{target}.short

Type: String Value: the short git hash value

Usage Examples

Default Options

In this example, the default options are used to get the git status.

grunt.initConfig({
  githash: {
    main: {
      options: {},
    }
  },

   anotherTask: {
     options: {
       exampleOptions1: '<%= githash.main.hash %>',
       exampleOptions2: '<%= githash.main.hash %> <%= githash.main.tag %> <%= githash.main.branch %>',
       exampleOptions3: '<%= githash.main.short %>'
     }
   }
})

Custom Options

In this example, we define the git repository location

grunt.initConfig({
  githash: {
    submodule: {
      options: {
        // Git repository path (e.g. a git sub module)
        dir: 'sub/repository/'
      }
    }
  },

  anotherTask: {
    options: {
      someProp: '<%= githash.submodule.hash %>'
    }
  }
})

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.

License

Copyright (c) 2015 Jan Nicklas. Licensed under the MIT license.