Skip to content

Commit c44abe2

Browse files
committed
removing history
0 parents  commit c44abe2

File tree

850 files changed

+133531
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

850 files changed

+133531
-0
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
src/node_modules
2+
.DS_Store
3+
.package.json

.travis.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
language: node_js
2+
node_js:
3+
- 0.10
4+
5+
notifications:
6+
irc: irc.freenode.org#jklb
7+
email:
8+
recipients:
9+
10+
on_success: change
11+
on_failure: change

README.md

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
#Contributor [![Build Status](https://travis-ci.org/jakeleboeuf/contributor.png)](https://travis-ci.org/jakeleboeuf/contributor)
2+
3+
A simple [node](http://nodejs.org) module to add git contributors to your package.json. Private repos are available as of 0.1.6!
4+
5+
[![NPM](https://nodei.co/npm/contributor.png)](https://nodei.co/npm/contributor/)
6+
7+
## Install from [npm](https://www.npmjs.org/package/contributor)
8+
9+
$ npm install contributor -g
10+
11+
or add it as one of your projects `package.json` dependencies like this:
12+
13+
14+
```json
15+
{
16+
...
17+
"dependencies": {
18+
"contributor": "0.1.x"
19+
}
20+
}
21+
```
22+
23+
## Usage
24+
25+
To get a record of your project's contribution info from your github repo, `cd` into the directory containing your `package.json` and run:
26+
27+
$ contributor
28+
29+
Bingo! Your `package.json` will be appended with something like this:
30+
31+
```json
32+
{
33+
...
34+
"contributors": [
35+
{
36+
"name": "Jake LeBoeuf",
37+
"email": "[email protected]",
38+
"url": "https://github.com/jakeleboeuf",
39+
"contributions": 20,
40+
"hireable": true
41+
}
42+
]
43+
}
44+
```
45+
46+
### Behind the scenes
47+
48+
[Contributor](https://www.npmjs.org/package/contributor) hunts for repository.url in your your `package.json`. If it finds a valid repo url, it requests collaborator info from the github api and adds it to your `package.json`. Super simple.
49+
50+
It will make a backup of your original json to `.package.json`, so all your secret codes are safe.
51+
52+
53+
#### Pro tip: Add a git push alias and kill a couple birds.
54+
55+
$ git config alias.pushc \!git push $1 $2 && contributor
56+
57+
This will simply add the pushc alias to your .git/config file like so:
58+
59+
[alias]
60+
pushc = !git push $1 $2 && contributor
61+
62+
Then you can run `git pushc origin master`, and voila! Give it a try on your next project and let me know what you think!
63+
64+
--
65+
###Examle output
66+
67+
68+
Before `contributor`:
69+
70+
71+
```json
72+
{
73+
"author": "Jake LeBoeuf",
74+
"name": "contributor",
75+
"description": "Example package.json.",
76+
"version": "0.1.1",
77+
"homepage": "https://github.com/jakeleboeuf/contributor",
78+
"repository": {
79+
"type": "git",
80+
"url": "https://github.com/jakeleboeuf/contributor.git"
81+
},
82+
"bugs": {
83+
"url": "https://github.com/jakeleboeuf/contributor/issues"
84+
},
85+
"engines": {
86+
"node": "0.10.x",
87+
"npm": "1.4.x"
88+
},
89+
"dependencies": {
90+
"request": "2.34.x",
91+
"ansi-color": "0.2.x",
92+
"github": "0.1.x",
93+
"prompt": "0.2.x"
94+
}
95+
}
96+
```
97+
98+
After `contributor`:
99+
100+
```json
101+
{
102+
"author": "Jake LeBoeuf",
103+
"name": "contributor",
104+
"description": "Example package.json.",
105+
"version": "0.1.1",
106+
"homepage": "https://github.com/jakeleboeuf/contributor",
107+
"repository": {
108+
"type": "git",
109+
"url": "https://github.com/jakeleboeuf/contributor.git"
110+
},
111+
"bugs": {
112+
"url": "https://github.com/jakeleboeuf/contributor/issues"
113+
},
114+
"engines": {
115+
"node": "0.10.x",
116+
"npm": "1.4.x"
117+
},
118+
"dependencies": {
119+
"request": "2.34.x",
120+
"ansi-color": "0.2.x",
121+
"github": "0.1.x",
122+
"prompt": "0.2.x"
123+
},
124+
"contributors": [
125+
{
126+
"name": "Jake LeBoeuf",
127+
"email": "[email protected]",
128+
"url": "https://github.com/jakeleboeuf",
129+
"contributions": 20,
130+
"hireable": true
131+
}
132+
]
133+
}
134+
```
135+
[![Support via Gittip](https://rawgithub.com/twolfson/gittip-badge/0.2.0/dist/gittip.png)](https://www.gittip.com/jakeleboeuf/)

node_modules/.bin/_mocha

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

node_modules/.bin/mocha

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

node_modules/ansi-color/LICENSE

Lines changed: 24 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

node_modules/ansi-color/README.md

Lines changed: 50 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

node_modules/ansi-color/lib/ansi-color.js

Lines changed: 39 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

node_modules/ansi-color/package.json

Lines changed: 36 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

node_modules/chai/.npmignore

Lines changed: 14 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)