Code Monkey home page Code Monkey logo

whodidwhat's Introduction

Who Did What

A tiny script to reformat, filter, and transform the output of name-your-contributors.

Install

$ npm install -g whodidwhat

Or you can clone it locally:

$ git clone https://github.com/mntnr/whodidwhat

Use

Pipe JSON output into this script and it spits out transformed JSON to stdout. use -u, --user to pick out just a single user.

From the project root run:

$ name-your-contributors -u mntnr -r name-your-contributors | whodidwhat

$ name-your-contributors -u mntnr -r name-your-contributors | whodidwhat -u tgetgood

Or you can save the output from nyc and pipe it through separately:

$ name-your-contributors -u mntnr -r name-your-contributors > nyc.json
$ cat nyc.json | whodidwhat > who.json

List of Contributors

With the --md option, whodidwhat will output the list of contributors as a markdown list ready to be pasted into your README or contributors file.

Think of it as the who without the what.

$ name-your-contributors -u mntnr -r name-your-contributors -b 2018 | whodidwhat --md

Will output

- [@RichardLitt](https://github.com/RichardLitt)
- [@tgetgood](https://github.com/tgetgood)
- [@jywarren](https://github.com/jywarren)
- [@gr2m](https://github.com/gr2m)
- [@diasdavid](https://github.com/diasdavid)
- [@kentcdodds](https://github.com/kentcdodds)
- [@greenkeeper](undefined)
- [@dignifiedquire](https://github.com/dignifiedquire)
- [@jozefizso](https://github.com/jozefizso)
- [@jbenet](https://github.com/jbenet)

That's all for now.

License

MIT

whodidwhat's People

Contributors

berkmann18 avatar richardlitt avatar tgetgood avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

berkmann18

whodidwhat's Issues

Unable to publish

npm ERR! You do not have permission to publish "whodidwhat". Are you logged in as the correct user? : whodidwhat

@tgetgood Any ideas?

Take config file instead of piped output

The config file format of name-your-contributors solves our cli duplication conundrum.

Add a --config option which takes an nyc config file, sends it through nyc, and postprocesses the results.

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

bug: Map is undefined

> name-your-contributors -u mntnr -r name-your-contributors | src/cli.js
TypeError: Cannot read property 'map' of undefined
    at cat (/Users/richard/src/whodunnit/src/index.js:20:19)
    at loopField (/Users/richard/src/whodunnit/src/index.js:23:30)
    at typeMap.map (/Users/richard/src/whodunnit/src/index.js:46:27)
    at Array.map (native)
    at byUser (/Users/richard/src/whodunnit/src/index.js:46:11)
    at <anonymous>
    at process._tickCallback (internal/process/next_tick.js:169:7)

Feedback would be nice

@RichardLitt I think this is what you're looking for.

Anything else you can think of that would be useful in this vein?

Maybe a better name is in order.

Error on example code

When I run

name-your-contributors -u mntnr -r name-your-contributors -t $GITHUB_TOKEN > nyc.json
cat nyc.json | whodidwhat

I get this (same output as name-your-... | whodidwhat):

TypeError: Cannot read property 'map' of undefined
  at cat (/usr/lib/node_modules/whodidwhat/src/index.js:20:20)
  at loopField (/usr/lib/node_modules/whodidwhat/src/index.js:23:30)
  at typeMap.map (/usr/lib/node_modules/whodidwhat/src/index.js:46:27)
  at Array.map (<anonymous>)
  at byUser (/usr/lib/node_modules/whodidwhat/src/index.js:46:11)
  at process._tickCallback (internal/process/next_tick.js:68:7)

I had a quick look at the code but couldn't really understand why that was happening.

To reproduce this, do the following:

npm i -g name-your-contributors whodidwhat
export GITHUB_TOKEN=yourTokenHere
name-your-contributors -u mntnr -r name-your-contributors -t $GITHUB_TOKEN > nyc.json
cat nyc.json | whodidwhat

EDIT: This doesn't happen when using cli.js on a repo clone.

Commits overwrites other counts in loopField

I'm struggling to understand this code, quite a lot. After trying for an hour and a half this morning, this is where I am stopping.

loopField hardcoding commits is where I started to be confused, and where I started refactoring most of the functions, without resolution.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.