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-export-filerev

v0.1.5

Published

Calculate a revision value for each file based on file content, and export revision values by callback and `grunt.config()` for your custom usage, such as rename file, archive all files' revisions

Downloads

9

Readme

grunt-export-filerev

Calculate a revision value for each file based on file content, and export revision values by callback and grunt.config() for your custom usage, such as rename file, archive all files' revisions

Getting Started

This plugin requires Grunt ~0.4.5

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-export-filerev --save-dev

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

grunt.loadNpmTasks('grunt-export-filerev')

The "export-filerev" task

Overview

This task will calculate a revision value for each file based on file content, and export revision values by callback and grunt.config() for your custom usage, such as rename file, archive all files' revisions

var fs = require('fs')
var pkg = requrie('./packge.json')

grunt.initConfig({
  'export-filerev': {
    options: {
      algorithm: 'md5', // default: 'md5'
      length: 8,
      onFileDone: function (revision, file, done) {
        // custom usage about revision value of a certain file
        fs.rename(file, path.join(revision, file), function (error) {
          if (error) {
            grunt.fail.warn(error)
          }
          done()
        })
      },
      onAllFilesDone: function (summary, done) {
        // custom usage about revisions summary
        var archiveFile = path.join('archive', pkg.version, 'revision-summary.json')
        summary = JSON.stringify(summary, null, 2)
        fs.writeFile(archive, summary, function (error) {
          if (error) {
            grunt.fail.warn(error)
          }
          done()
        })
      }
    },
    target1: {
      src: ['a.js', 'b.css', 'c.png'],
    }
  }
})

Options

option.algorithm

Type: string

Default: 'md5'

algorithm supported by crypto.createHash(algorithm), such as 'md5', 'sha1', 'sha256', 'sha512'

option.length

Type: number

Default: 8

The number of characters of revision value

option.onFileDone

Type: function (revision, file, done)

Default: function (revision, file, done) { done() }

Params:

  • revision: string Revision value based on file content
  • file: string Path to a certain src file
  • done: function Invoke this callback when you finish your custom operation, designed to support asynchronize

This callback will be invoked for each file after their revision value is calculated.

option.onAllFilesDone

Type: function (summary, done)

Default: function (summary, done) { done() }

Params:

  • summary: object A map from src files to corresponding revision values
  • done: function The same with the param done of option.onFileDone

This callback will be invoked after revision values of all src files are calculated. Notice directories are ignore internally.

Share revision values across multiple tasks

Apart from callback, this task also export revision summary on grunt.option() with the key as the name of the task, including any colon-separated arguments or flags specified on the command-line, actually this.nameArgs inside tasks is used as the key.