Package Exports

stringify-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 (stringify-author) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

stringify-author

Stringify an authors object to name <email> (url).

Install

Install with npm

$ npm i stringify-author --save

Usage

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

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

console.log(authors);
//=> 'Jon Schlinkert <jon.schlinkert@sellside.com> (https://github.com/jonschlinkert)'

Any of the properties can be used or missing:

var authors = [
  {name: 'Brian Woodward', url: 'https://github.com/doowb'},
  {name: 'Jon Schlinkert', url: 'https://github.com/jonschlinkert'}
];

console.log(authors.map(stringify));
//=> [ 'Brian Woodward (https://github.com/doowb)', 'Jon Schlinkert (https://github.com/jonschlinkert)' ]

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
parse-authors: Parse a string into an array of objects with name, email and url properties following… more | homepage
stringify-authors: Stringify an array or object of authors. Useful for adding authors, maintainers or contribuors to… more | homepage

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-cli on November 16, 2015.