✨ add a limit param to increase the contributors list

A new CLI parameter `--limit, -l` has been introduced. The various API functions now
also accept a `limit` option. Note that the maximum limit for now is 100.

Closes #32

Author: ngryman

cli.js

@@ -11,13 +11,15 @@ const cli = meow(
 
   Options
     --exclude, -e   Exclude contributors, glob.
+    --limit, -l     Limit the number of contributors (default: 30).
 
   Examples
     $ contributor-faces --exclude "*-bot"
 `,
   {
     alias: {
       e: 'exclude',
+      l: 'limit'
     }
   }
 )

fixtures/lots-of-contributors/package.json

@@ -0,0 +1,3 @@
+{
+  "repository": "facebook/react"
+}

index.js

@@ -18,7 +18,11 @@ function getRepo(baton) {
 }
 
 function fetch(baton) {
-  return gh(`repos/${baton.repo}/contributors`).then(res => {
+  const searchParams = {
+    ['per_page']: baton.limit
+  }
+
+  return gh(`repos/${baton.repo}/contributors`, { searchParams }).then(res => {
     baton.contributors = res.body
     return baton
   })
@@ -77,6 +81,7 @@ function end(prop) {
 function core(dir, opts) {
   opts = opts || {}
   opts.dir = dir || '.'
+  opts.limit = opts.limit || 30
   return Promise.resolve(opts).then(getRepo).then(fetch).then(filter)
 }
 

test.js

@@ -10,6 +10,20 @@ test('list contributors', async t => {
   t.true(Array.isArray(contribs))
 })
 
+test('limit contributors to 30 by default', async t => {
+  const repoDir = path.join('fixtures', 'lots-of-contributors')
+  const contribs = await contributors(repoDir)
+
+  t.is(contribs.length, 30)
+})
+
+test('accept a limit parameter', async t => {
+  const repoDir = path.join('fixtures', 'lots-of-contributors')
+  const contribs = await contributors(repoDir, { limit: 100 })
+
+  t.is(contribs.length, 100)
+})
+
 test.serial('use current directory by default', async t => {
   process.chdir('fixtures')
   const contribs = await contributors()