Format a list of authors, contributors, or collaborators.
npm install format-people> Format a list of authors, contributors, or collaborators.
Please consider following this project's author, Brian Woodward, and consider starring the project to show your :heart: and support.
Install with npm:
``sh`
$ npm install --save format-people
Requires Node.js v8.0 or higher.
`js`
const format = require('format-people');
Params
* arr {Array}: Array of people objects.format
* {String}: The format "type" to use. Valid types are table, list and aligned. If no type is passed, table will be used automatically.returns
* {String}: Formatted
Example
`js`
const people = [ { name: 'Brian Woodward' } ];
const table = format(people, 'table');
console.log(table);
Returns the array of people formatted as a markdown table.
Params
* arr {Array}: Array of people to format.returns
* {String}: Markdown table
Example
`js`
const people = [
{ login: 'doowb', contributions: 100, html_url: 'https://github.com/doowb' },
{ login: 'jonschlinkert', contributions: 50, html_url: 'https://github.com/jonschlinkert' }
];
console.log(format.table(people));
//=> | Commits | Contributor
|
//=> | --- | --- |
//=> | 100 | doowb |
//=> | 50 | jonschlinkert |
Returns the array of people formatted as a markdown list.
Params
* arr {Array}: Array of people to format.returns
* {String}: Markdown list
Example
`js`
const people = [
{ login: 'doowb', contributions: 100, html_url: 'https://github.com/doowb' },
{ login: 'jonschlinkert', contributions: 50, html_url: 'https://github.com/jonschlinkert' }
];
console.log(format.list(people));
//=> Commits / Contributor
//=> + 100 doowb
//=> + 50 jonschlinkert
Returns the array of people formatted as a GitHub Flavored Markdown fenced code block, with aligned columns.
Params
* arr {Array}: Array of people to format.returns
* {String}: Markdown code block with aligned columns.
Example
`js`
const people = [
{ login: 'doowb', contributions: 100, html_url: 'https://github.com/doowb' },
{ login: 'jonschlinkert', contributions: 50, html_url: 'https://github.com/jonschlinkert' }
];
console.log(format.aligned(people));
//=> COMMITS / CONTRIBUTOR
//=> ------- | -----------
//=> 100 doowb
//=> 50 jonschlinkert
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guide for advice on opening issues, pull requests, and coding standards.
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
`sh`
$ npm install && npm test
Building docs
_(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)_
To generate the readme, run the following command:
`sh``
$ npm install -g verbose/verb#dev verb-generate-readme && verb
You might also be interested in these projects:
* github-base: Low-level methods for working with the GitHub API in node.js/JavaScript. | homepage
* github-contributors: Generate a markdown or JSON list of contributors for a project using the GitHub API. | homepage
| Commits | Contributor |
| --- | --- |
| 11 | doowb |
| 8 | jonschlinkert |
Brian Woodward
* GitHub Profile
* Twitter Profile
* LinkedIn Profile
Copyright © 2018, Brian Woodward.
Released under the MIT License.
*
_This file was generated by verb-generate-readme, v0.6.0, on August 14, 2018._