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

Install with npm:

1$ npm install parse-authors --save

Usage

1var authors = require('parse-authors');
2
3authors('Jon Schlinkert <jon.schlinkert@sellside.com> (https://github.com/jonschlinkert)');
4//=> [{name: 'Jon Schlinkert', email: 'jon.schlinkert@sellside.com', url: 'https://github.com/jonschlinkert'}]
5
6authors('Jon Schlinkert <jon.schlinkert@sellside.com>\nBrian Woodward (https://github.com/doowb)<');
7//=>
8// [
9//  {name: 'Jon Schlinkert', email: 'jon.schlinkert@sellside.com', url: ''},
10//  {name: 'Brian Woodward', email: '', url: 'https://github.com/doowb'}
11// ]

Any of the properties can be used or missing:

1authors()
2//=> {name: '', email: '', url: ''}
3
4authors('Jon Schlinkert (https://github.com/jonschlinkert)');
5//=> [{name: 'Jon Schlinkert', email: '', url: 'https://github.com/jonschlinkert'}]

Related projects

• author-regex: Regular expression for parsing an author string into an object following npm conventions. | homepage
• parse-author: Parse a string into an object with name, email and url properties following npm conventions.… more | homepage
• stringify-author: Stringify an authors object to name <email> (url). | homepage

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:

1$ npm install verb && npm run docs

Or, if verb is installed globally:

1$ verb

Running tests

Install dev dependencies:

1$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016 Jon Schlinkert Released under the MIT license.

---

This file was generated by verb, v0.9.0, on March 21, 2016.