stringify-authors

stringify-authors

Stringify an array or object of authors. Useful for adding authors, maintainers or contribuors to documentation or a readme.

Install with npm

npm i stringify-authors --save

Usage

var authors = require('stringify-authors');

Given an array of author objects:

var authors = [{
  name: 'Jon Schlinkert',
  email: '[e-mail]',
  url: 'https://github.com/jonschlinkert'
}, {
  name: 'Brian Woodward',
  url: 'https://github.com/doowb',
  email: '[e-mail]'
}]

// default separator is ', '
stringify(authors, {sep: '\n'});

results in:

Jon Schlinkert <[e-mail]> (https://github.com/jonschlinkert)
Brian Woodward <[e-mail]> (https://github.com/doowb)

Filter with glob patterns

stringify(authors, {filter: 'name'});
//=> Jon Schlinkert, Brian Woodward

stringify(authors, {filter: '{name,url}', sep: '\n'});
// Jon Schlinkert (https://github.com/jonschlinkert)
// Brian Woodward (https://github.com/doowb)

Run tests

Install dev dependencies:

node i -d && mocha

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright (c) 2015 Jon Schlinkert
Released under the MIT license

This file was generated by verb on January 12, 2015.