Newfangled Package Modernizer
Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

stringify-authors

0.2.0 • Public • Published

stringify-authors NPM version Build Status

Converts an author object or array of author objects into an array of strings. Useful for adding authors, maintainers or contributors to documentation, package.json or a readme.

Install

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: 'jon.schlinkert@sellside.com',
  url: 'https://github.com/jonschlinkert'
}, {
  name: 'Brian Woodward',
  url: 'https://github.com/doowb',
  email: 'brian.woodward@sellside.com'
}]
// default separator is ', '
stringify(authors, {sep: '\n'});

results in:

Jon Schlinkert <jon.schlinkert@sellside.com> (https://github.com/jonschlinkert)
Brian Woodward <brian.woodward@sellside.com> (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)

Related

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

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

Author

Jon Schlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.


This file was generated by verb-cli on November 16, 2015.

Install

npm i stringify-authors

DownloadsWeekly Downloads

1

Version

0.2.0

License

MIT

Last publish

Collaborators

  • avatar
  • avatar