Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Generate a single formatted list item, allowing you to easily generate lists with proper indentation, bullets, numbers or other leading characters.
Generate a single formatted list item, allowing you to easily generate lists with proper indentation, bullets, numbers or other leading characters.
(TOC generated by verb)
Install with npm
$ npm i list-item --save
var listitem = require('list-item');
Basic list
Generate a list using default bullets and indentation:
var listitem = require('list-item');
var li = listitem();
var res = '';
['a', 'b', 'c', 'd', 'e'].forEach(function (ele, i) {
res += li(i, ele) + '\n';
});
Results in:
- a
* b
+ c
- d
* e
Roman numerals
Generate roman numerals in increments of 10.
var listitem = require('list-item');
var romanize = require('romanize');
// specify `chars` to be passed to expand-range (lib),
// and use the callback to modify generated numerals
var li = listitem({chars: '1..100..10'}, function (ch) {
return romanize(ch) + '.';
});
// generate a formatted list!
['a', 'b', 'c', 'd', 'e'].forEach(function (ele, i) {
res += li(i, ele) + '\n';
});
Results in:
I. a
XI. b
XXI. c
XXXI. d
XLI. e
Returns a function to generate a plain-text/markdown list-item, allowing options to be cached for subsequent calls.
Params
options
{Object}: pass options to customize list item characters, indentation, etc.options.nobullet
{Boolean}: Pass true if you only want the list iten and identation, but no bullets.options.indent
{String}: The amount of leading indentation to use. default is ``.options.chars
{String|Array}: If a string is passed, expand-range will be used to generate an array of bullets (visit expand-range to see all options.) Or directly pass an array of bullets, numbers, letters or other characters to use for each list item. Default ['-', '*', '+']
fn
{Function}: pass a function expand-range to modify the bullet for an item as it's generated. See the examples.returns
{String}: returns a formatted list itemExample
var li = listitem(options);
li(0, 'Level 0 list item');
//=> '- Level 0 list item'
li(1, 'Level 1 list item');
//=> ' * Level 1 list item'
li(2, 'Level 2 list item');
//=> ' + Level 2 list item'
Install dev dependencies:
$ npm i -d && npm test
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Jon Schlinkert
Copyright © 2015 Jon Schlinkert Released under the MIT license.
This file was generated by verb on December 20, 2015.
FAQs
Generate a single formatted list item, allowing you to easily generate lists with proper indentation, bullets, numbers or other leading characters.
The npm package list-item receives a total of 76,009 weekly downloads. As such, list-item popularity was classified as popular.
We found that list-item demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.