Package Exports

parse-author

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (parse-author) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

parse-author

Parse a string into an object 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 i parse-author --save

Usage

var authors = require('parse-author');

authors('Jon Schlinkert <jon.schlinkert@sellside.com> (https://github.com/jonschlinkert)');
//=> {name: 'Jon Schlinkert', email: 'jon.schlinkert@sellside.com', url: 'https://github.com/jonschlinkert'}

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'}

Generate docs

Generate readme and API documentation with verb:

$ npm i -d && npm run docs

Or, if verb is installed globally:

$ verb

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

This file was generated by verb, v0.9.0, on February 20, 2016.