Parse a string into an object with
name,urlproperties following npm conventions. Useful for theauthorsproperty in package.json or for parsing an AUTHORS file into an array of authors objects.
Install with npm:
$ npm install --save parse-authorvar parse = require('parse-author');Works with a flexible range of formats, any of the properties can be used or missing:
Name
Name <email> (url)
Name <email>(url)
Name<email> (url)
Name<email>(url)
Name (url) <email>
Name (url)<email>
Name(url) <email>
Name(url)<email>
Name (url)
Name(url)
Name <email>
Name<email>
<email> (url)
<email>(url)
(url) <email>
(url)<email>
<email>
(url)
var author = parse('Jon Schlinkert <jon.schlinkert@sellside.com> (https://github.com/jonschlinkert)');
console.log(author);
//=> {name: 'Jon Schlinkert', email: 'jon.schlinkert@sellside.com', url: 'https://github.com/jonschlinkert'}
console.log(parse('Jon Schlinkert (https://github.com/jonschlinkert)'));
//=> {name: 'Jon Schlinkert', url: 'https://github.com/jonschlinkert'}
console.log(parse('Jon Schlinkert <jon.schlinkert@sellside.com>'));
//=> {name: 'Jon Schlinkert', email: 'jon.schlinkert@sellside.com'}
console.log(parse(''));
//=> {}- author-regex: Regular expression for parsing an
authorstring into an object following npm conventions. | homepage - parse-authors: Parse a string into an array of objects with
name,emailandurlproperties following… more | homepage - stringify-author: Stringify an authors object to
name <email> (url). | homepage - stringify-authors: Converts an author object or array of author objects into an array of strings. Useful… more | homepage
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
| Commits | Contributor |
|---|---|
| 14 | slang800 |
| 12 | jonschlinkert |
| 1 | MitMaro |
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verbRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm testJon Schlinkert
Copyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.4.3, on March 08, 2017.