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.
npm install parse-authors> 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 with npm:
``sh`
$ npm install parse-authors --save
`js
var authors = require('parse-authors');
authors('Jon Schlinkert
//=> [{name: 'Jon Schlinkert', email: 'jon.schlinkert@sellside.com', url: 'https://github.com/jonschlinkert'}]
authors('Jon Schlinkert
//=>
// [
// {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:
`js
authors()
//=> {name: '', email: '', url: ''}
authors('Jon Schlinkert (https://github.com/jonschlinkert)');
//=> [{name: 'Jon Schlinkert', email: '', url: 'https://github.com/jonschlinkert'}]
`
* author-regex: Regular expression for parsing an author string into an object following npm conventions. | homepagename
* parse-author: Parse a string into an object with , email and url properties following npm conventions.… more | homepagename
* stringify-author: Stringify an authors object to . | homepage
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Generate readme and API documentation with verb:
`sh`
$ npm install verb && npm run docs
Or, if verb is installed globally:
`sh`
$ verb
Install dev dependencies:
`sh``
$ npm install -d && npm test
Jon Schlinkert
* github/jonschlinkert
* twitter/jonschlinkert
Copyright © 2016 Jon Schlinkert
Released under the MIT license.
*
_This file was generated by verb, v0.9.0, on March 21, 2016._