node package manager

parse-author

parse-author NPM version NPM monthly downloads NPM total downloads Linux Build Status

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 install --save parse-author

Usage

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

Supported formats

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)

Examples

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(''));
//=> {} 

About

Related projects

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Contributors

Commits Contributor
14 slang800
12 jonschlinkert
1 MitMaro

Building docs

(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 && verb

Running tests

Running 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 test

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.4.3, on March 08, 2017.

Private packages for the whole team

It’s never been easier to manage developer teams with varying permissions and multiple projects. Learn more about Private Packages and Organizations…

how? learn more

Collaborators list

Stats

Try it out

Keywords

author, authors, contributor, exec, expression, extract, maintainer, maintainers, match, package, parse, person, pkg, re, regex, regexp, regular, somebody

Dependencies (1)

author-regex

Dependents (67)

generator-ecmascript-proposal, skpm, prettier-package-json, updater-package, generator-phovea, electron-installer-redhat, generator-bonestorm, oc-info, repo-utils, generator-electrode, generator-canner-template, helper-copyright, generator-node, pob, expand-pkg, generator-oniyi, generator-frans-react, generator-speedcontrol, generator-mnm, vitaminjs-cli, @trails/generator-node, update-copyright, generator-cf-module, verb-data, generator-devebot, authors-to-markdown, pj2md, generator-esnext-project, generator-sillpa-node, generator-ats-node-webapp, generator-nom, ember-cli-fxos, update-banner, publish-dist, generator-beyond, generator-node-ext, generator-sillpa, slush-n, generator-krew, generator-butler, pretty-banner, verb-context, parse-authors, generator-typescript-npm-bower, generator-nodecg, generator-atom-package-plus, publish-repo, generator-starhackit, raise-oc, verb, and more