{"_id":"bullets","_rev":"221219","name":"bullets","description":"Generate a plain-text and markdown formatted lists or tables of contents, with proper indentation, bullets, numbers, letters, roman numerals or custom characters.","dist-tags":{"latest":"0.2.2"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"time":{"modified":"2021-06-03T15:40:05.000Z","created":"2015-02-21T16:17:50.718Z","0.2.2":"2016-01-19T14:19:00.517Z","0.2.1":"2016-01-19T14:11:32.869Z","0.2.0":"2015-12-20T18:43:47.219Z","0.1.1":"2015-02-22T00:38:39.555Z","0.1.0":"2015-02-21T16:17:50.718Z"},"users":{},"author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git+https://github.com/jonschlinkert/bullets.git"},"versions":{"0.2.2":{"name":"bullets","description":"Generate a plain-text and markdown formatted lists or tables of contents, with proper indentation, bullets, numbers, letters, roman numerals or custom characters.","version":"0.2.2","homepage":"https://github.com/jonschlinkert/bullets","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"contributors":[{"name":"Anders D. Johnson","url":"https://github.com/adjohnson916"}],"repository":{"type":"git","url":"git+https://github.com/jonschlinkert/bullets.git"},"bugs":{"url":"https://github.com/jonschlinkert/bullets/issues"},"license":"MIT","files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"is-number":"^2.1.0","list-item":"^1.1.1"},"devDependencies":{"gulp-format-md":"^0.1.5","mocha":"*","romanize":"^0.1.0","should":"*"},"keywords":["bullet","format","item","list","list-item","markdown","numbered","numerals","ordered","roman","test","unordered"],"verb":{"related":{"list":["list-item"]},"plugins":["gulp-format-md"],"layout":"default","option":{"toc":false},"reflinks":["list-item"]},"gitHead":"ec0881986a24a0ac8712c308fa21a11edc86af4a","_id":"bullets@0.2.2","_shasum":"1a6984277ae565774bf07d6d0711780c59b7b1a5","_from":".","_npmVersion":"3.3.12","_nodeVersion":"5.3.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"1a6984277ae565774bf07d6d0711780c59b7b1a5","size":2975,"noattachment":false,"key":"/bullets/-/bullets-0.2.2.tgz","tarball":"http://registry.cnpm.dingdandao.com/bullets/download/bullets-0.2.2.tgz"},"directories":{},"publish_time":1453213140517,"_cnpm_publish_time":1453213140517,"_hasShrinkwrap":false},"0.2.1":{"name":"bullets","description":"Generate a plain-text and markdown formatted lists or tables of contents, with proper indentation, bullets, numbers, letters, roman numerals or custom characters.","version":"0.2.1","homepage":"https://github.com/jonschlinkert/bullets","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"contributors":[{"name":"Anders D. Johnson","url":"https://github.com/adjohnson916"}],"repository":{"type":"git","url":"git+https://github.com/jonschlinkert/bullets.git"},"bugs":{"url":"https://github.com/jonschlinkert/bullets/issues"},"license":"MIT","files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"list-item":"^1.1.1"},"devDependencies":{"gulp-format-md":"^0.1.5","mocha":"*","romanize":"^0.1.0","should":"*"},"keywords":["bullet","format","item","list","list-item","markdown","numbered","numerals","ordered","roman","test","unordered"],"verb":{"related":{"list":["list-item"]},"plugins":["gulp-format-md"],"layout":"default","option":{"toc":false},"reflinks":["list-item"]},"gitHead":"ec0881986a24a0ac8712c308fa21a11edc86af4a","_id":"bullets@0.2.1","_shasum":"bdc432bc019c0baa7b709880d301a9cbc8eac4d6","_from":".","_npmVersion":"3.3.12","_nodeVersion":"5.3.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"bdc432bc019c0baa7b709880d301a9cbc8eac4d6","size":2917,"noattachment":false,"key":"/bullets/-/bullets-0.2.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/bullets/download/bullets-0.2.1.tgz"},"directories":{},"publish_time":1453212692869,"_cnpm_publish_time":1453212692869,"_hasShrinkwrap":false},"0.2.0":{"name":"bullets","description":"Generate a plain-text and markdown formatted lists or tables of contents, with proper indentation, bullets, numbers, letters, roman numerals or custom characters.","version":"0.2.0","homepage":"https://github.com/jonschlinkert/bullets","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"contributors":[{"name":"Anders D. Johnson","url":"https://github.com/adjohnson916"}],"repository":{"type":"git","url":"git+https://github.com/jonschlinkert/bullets.git"},"bugs":{"url":"https://github.com/jonschlinkert/bullets/issues"},"license":"MIT","files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"expand-range":"^1.8.1","list-item":"^1.1.1","pad-left":"^2.0.0"},"devDependencies":{"mocha":"*","romanize":"^0.1.0","should":"*"},"keywords":["bullet","format","item","list","list-item","markdown","numbered","numerals","ordered","roman","test","unordered"],"verb":{"related":{"list":[]},"plugins":["gulp-format-md"],"layout":"default","option":{"toc":false}},"gitHead":"ef1d794d9f96a61bc400c6af061d03f7184bfb78","_id":"bullets@0.2.0","_shasum":"bc01200dbf40c08fc1cf1410cd4eaab65262b501","_from":".","_npmVersion":"3.3.6","_nodeVersion":"5.0.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"bc01200dbf40c08fc1cf1410cd4eaab65262b501","size":2801,"noattachment":false,"key":"/bullets/-/bullets-0.2.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/bullets/download/bullets-0.2.0.tgz"},"directories":{},"publish_time":1450637027219,"_cnpm_publish_time":1450637027219,"_hasShrinkwrap":false},"0.1.1":{"name":"bullets","description":"Generate a plain-text and markdown formatted lists or tables of contents, with proper indentation, bullets, numbers, letters, roman numerals or custom characters.","version":"0.1.1","homepage":"https://github.com/jonschlinkert/bullets","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"https://github.com/jonschlinkert/bullets"},"bugs":{"url":"https://github.com/jonschlinkert/bullets/issues"},"license":"MIT","files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"expand-range":"^1.8.1","list-item":"^0.1.0","pad-left":"^1.0.1"},"devDependencies":{"mocha":"*","romanize":"^0.1.0","should":"*"},"keywords":["bullet","format","item","list","list-item","markdown","numbered","numerals","ordered","roman","test","unordered"],"gitHead":"e6feeb89cd2b4f1d78c11f8040c017b4363abe88","_id":"bullets@0.1.1","_shasum":"610683eec17337da70fbf8d9c9ab1811bb16b710","_from":".","_npmVersion":"2.5.1","_nodeVersion":"0.12.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"610683eec17337da70fbf8d9c9ab1811bb16b710","size":2643,"noattachment":false,"key":"/bullets/-/bullets-0.1.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/bullets/download/bullets-0.1.1.tgz"},"directories":{},"publish_time":1424565519555,"_cnpm_publish_time":1424565519555,"_hasShrinkwrap":false},"0.1.0":{"name":"bullets","description":"Generate a plain-text or markdown formatted list, with proper indentation, bullets, numbers, letters, roman numerals or custom characters.","version":"0.1.0","homepage":"https://github.com/jonschlinkert/bullets","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"https://github.com/jonschlinkert/bullets"},"bugs":{"url":"https://github.com/jonschlinkert/bullets/issues"},"license":"MIT","files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"expand-range":"^1.8.1","list-item":"^0.1.0","pad-left":"^1.0.1"},"devDependencies":{"mocha":"*","should":"*"},"keywords":["bullet","format","item","list","list-item","markdown","numbered","numerals","ordered","roman","test","unordered"],"gitHead":"6d87bfbad1a8988c2aa86ef9691f15af7abcceca","_id":"bullets@0.1.0","_shasum":"a2c62788bc0bfa21d4c9ec68ed7bcdf4859c0728","_from":".","_npmVersion":"2.5.1","_nodeVersion":"0.12.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"a2c62788bc0bfa21d4c9ec68ed7bcdf4859c0728","size":2089,"noattachment":false,"key":"/bullets/-/bullets-0.1.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/bullets/download/bullets-0.1.0.tgz"},"directories":{},"publish_time":1424535470718,"_cnpm_publish_time":1424535470718,"_hasShrinkwrap":false}},"readme":"# bullets [![NPM version](https://img.shields.io/npm/v/bullets.svg)](https://www.npmjs.com/package/bullets) [![Build Status](https://img.shields.io/travis/jonschlinkert/bullets.svg)](https://travis-ci.org/jonschlinkert/bullets)\n\n> Generate a plain-text and markdown formatted lists or tables of contents, with proper indentation, bullets, numbers, letters, roman numerals or custom characters.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm i bullets --save\n```\n\n## Usage\n\n```js\nvar bullets = require('bullets');\n```\n\n## Examples\n\n**Roman numerals**\n\n```js\nvar list = [\n  {text: 'Item a...', lvl: 0}, \n  {text: 'Item b...', lvl: 1}, \n  {text: 'Item c...', lvl: 2},\n  {text: 'Item d...', lvl: 2},\n  {text: 'Item e...', lvl: 2},\n];\n\n// let's generate 100 numerals, in case our list grows.\nvar actual = bullets(list, {chars: '1..100'}, function (ch) {\n  return romanize(ch) + '.';\n});\n```\n\nResults in:\n\n```\nI. Item a...\n  II. Item b...\n    III. Item c...\n    III. Item d...\n    III. Item e...\n```\n\n## API\n\n### [bullets](index.js#L56)\n\nPass an array of list-item objects to generate a formatted list or table of contents. Uses [list-item](https://github.com/jonschlinkert/list-item) for generating the actual items.\n\nNote that `lvl` or `level` may be passed as the property name in the\nfollowing examples.\n\n**Params**\n\n* `list` **{Array}**: Array of item objects with `text` and `lvl` properties\n* `list.text` **{String}**: The text for the list item.\n* `list.lvl` **{Number}**: The level of the list item to be used for indenting the list.\n* `opts` **{Object}**: Options to pass to [list-item](https://github.com/jonschlinkert/list-item).\n* `fn` **{Function}**: pass a function to modify the bullet for an item as it's generated.\n\n**Example**\n\n```js\nvar list = [\n  {text: 'This is item 1', lvl: 0},\n  {text: 'This is item 2', lvl: 0},\n  {text: 'This is item 3', lvl: 0},\n  {text: 'This is sub-item A', lvl: 2},\n  {text: 'This is sub-item B', lvl: 2},\n  {text: 'This is sub-item C', lvl: 2},\n];\nbullets([{text: 'This is a list item', lvl: 0}]);\n\n// Results in\n// '- This is item 1'\n// '- This is item 2'\n// '- This is item 3'\n// '  * This is sub-item A'\n// '  * This is sub-item B'\n// '  * This is sub-item C'\n```\n\n## Related projects\n\n[list-item](https://www.npmjs.com/package/list-item): Generate a single formatted list item, allowing you to easily generate lists with proper indentation,… [more](https://www.npmjs.com/package/list-item) | [homepage](https://github.com/jonschlinkert/list-item)\n\n## Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm i -d && npm test\n```\n\n## Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/bullets/issues/new).\n\n## Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n## License\n\nCopyright © 2016 [Jon Schlinkert](https://github.com/jonschlinkert)\nReleased under the MIT license.\n\n***\n\n_This file was generated by [verb](https://github.com/verbose/verb) on January 19, 2016._","_attachments":{},"homepage":"https://github.com/jonschlinkert/bullets","bugs":{"url":"https://github.com/jonschlinkert/bullets/issues"},"license":"MIT"}