Parse a string into an array of objects with name, email and url properties following npm conventions. Useful for the authors property in package.json or for parsing an AUTHORS file into an array of authors objects.
Install
Install with npm:
$ npm install parse-authors --save
Usage
var authors = require('parse-authors');
authors('Jon Schlinkert <jon.schlinkert@sellside.com> (https://github.com/jonschlinkert)');
//=> [{name: 'Jon Schlinkert', email: 'jon.schlinkert@sellside.com', url: 'https://github.com/jonschlinkert'}]
authors('Jon Schlinkert <jon.schlinkert@sellside.com>\nBrian Woodward (https://github.com/doowb)<');
//=>
// [
// {name: 'Jon Schlinkert', email: 'jon.schlinkert@sellside.com', url: ''},
// {name: 'Brian Woodward', email: '', url: 'https://github.com/doowb'}
// ]
Any of the properties can be used or missing:
authors()
//=> {name: '', email: '', url: ''}
authors('Jon Schlinkert (https://github.com/jonschlinkert)');
//=> [{name: 'Jon Schlinkert', email: '', url: 'https://github.com/jonschlinkert'}]
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Building docs
Generate readme and API documentation with verb:
$ npm install verb && npm run docs
Or, if verb is installed globally:
$ verb
Running tests
Install dev dependencies:
$ npm install -d && npm test
Author
Jon Schlinkert
License
Copyright © 2016 Jon Schlinkert
Released under the MIT license.
This file was generated by verb, v0.9.0, on March 21, 2016.
