paquettea / node-svn-info

Parses and normalizes your svn info

svn-info

Parse svn info.

Getting Started

Install the module with: npm install svn-info

Documentation

This module exports itself as a method you may use to asynchronously get svn info for a given path and revision:

require('svn-info')('path/to/folder/under/svn', 'HEAD', function(err, info) {
  if(err) {
    throw err;
  }
  do_something_with(info);
});

The first argument, the repo path, is optional and will default to the current working directory.

The second argument, the revision, is optional will default to 'HEAD'. Note that if you specify a revision you must also specify a path.

There's also an synchronous flavor:

var info = require('svn-info').sync('my/repo/path', 194);
do_something_with(info);

As with the async version you can optionally leave off the path and revision arguments.

NOTE: You must have the svn command line tool in your path.

NOTE: The data is in the form returned by xml2js from svn info --xml command output. This ensure that the data is always accessible using the same keys (os language independent)

Release History

• v0.2.0 2014-07-11 Allow users to specify revision

License

Copyright (c) 2013 jtrussell
Licensed under the MIT license.