Skip to content

Commit

Permalink
Add nodei.co badge.
Browse files Browse the repository at this point in the history
  • Loading branch information
uid11 committed Sep 19, 2016
1 parent 124bc95 commit f7e4eff
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 9 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# full-git-history #

[![NPM version][npm-image]][npm-url] ![node][node-image] ![dependencies][dependencies-image] [![License MIT][license-image]](LICENSE)
[![NPM version][npm-image]][npm-url] ![node][node-image] ![dependencies][dependencies-image] [![License MIT][license-image]](LICENSE)

**full-git-history** extract all raw history (not only from the current branch) in an asynchronous non-blocking manner from the local git-repository (by path) and stores it into the json-file with the given name.
After this, the json-data can be used for plotting graphs, calculating statistics, searching commits, and so on.
Raw history include all information from repository except blobs and trees objects (i.e. all commits, tags, local and remote branches, symbolic refs, stash).
[![NPM](https://nodei.co/npm/full-git-history.png)](https://nodei.co/npm/full-git-history/)

**full-git-history** extract all raw history (not only from the current branch) in an asynchronous non-blocking manner from the local git-repository (by path) and stores it into the json-file with the given name.
After this, the json-data can be used for plotting graphs, calculating statistics, searching commits, and so on.
Raw history include all information from repository except blobs and trees objects (i.e. all commits, tags, local and remote branches, symbolic refs, stash).

## Usage ##
You need a node version >=6.0.0. Of course, you must have installed Git.
Expand Down Expand Up @@ -271,7 +273,7 @@ $ npm run get-and-check /path/to/foo-project
```

## License ##
[MIT](LICENSE)
[MIT](LICENSE)

[license-image]: https://img.shields.io/badge/license-MIT-blue.svg "license-image"
[dependencies-image]: https://img.shields.io/gemnasium/mathiasbynens/he.svg?maxAge=2592000 "dependencies-image"
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "full-git-history",
"version": "1.2.1",
"version": "1.2.2",
"description": "Get and save a complete history of git-repository in file in JSON format.",
"main": "src/full-git-history.js",
"scripts": {
Expand Down Expand Up @@ -30,7 +30,7 @@
],
"dependencies": {},
"devDependencies": {
"mocha": ">=2.0.0"
"mocha": "^3.0.2"
},
"engines": {
"node": ">= 6.0.0"
Expand Down
2 changes: 1 addition & 1 deletion test/check-history.js
Original file line number Diff line number Diff line change
Expand Up @@ -628,7 +628,7 @@ const plurale = number => plural(number) ? 'es' : '';
/**
* Sync reading JSON from filesystem.
* @param {string} name Filename.
* @return {?Object} Parsed JSON value (null if no such file).
* @return {?Object} Parse JSON value (null if no such file).
*/
const readJSON = name => {
try {
Expand Down
7 changes: 6 additions & 1 deletion test/test.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,12 @@ const fs = require('fs'),
fullGitHistory = require('../src/full-git-history'),
checkHistory = require('./check-history');


/**
* Throw error, if value in not true.
* @param {*} value
* @param {string} msg
* @throws {Error}
*/
const assert = (value, msg) => {
if (value !== true) throw Error('Assert ' + (msg || ''));
};
Expand Down

0 comments on commit f7e4eff

Please sign in to comment.