# html-ls

> html ls

Latest version **2.1.0** (published 2020-07-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install html-ls
pnpm add html-ls
yarn add html-ls
bun add html-ls
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.1.0 |
| Published | 2020-07-18 |
| First published | 2013-06-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 8.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | jesse keane |
| Maintainers | jarofghosts |
| Keywords | ls, html, stream |

## Links

- npm: https://www.npmjs.com/package/html-ls
- Repository: https://github.com/jarofghosts/html-ls
- Homepage: https://github.com/jarofghosts/html-ls#readme
- Issues: https://github.com/jarofghosts/html-ls/issues
- npm.io page: https://npm.io/package/html-ls

## Dependencies (2)

- [through2](https://npm.io/package/through2.md) ^0.6.5
- [ls-stream](https://npm.io/package/ls-stream.md) 1.0.0

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 2.1.0 (latest) — 2020-07-18
- 2.0.0 — 2015-04-16
- 1.0.1 — 2014-07-07
- 1.0.0 — 2014-05-01
- 0.1.1 — 2014-01-17
- 0.1.0 — 2013-12-21
- 0.0.8 — 2013-12-21
- 0.0.7 — 2013-08-27
- 0.0.6 — 2013-07-12
- 0.0.5 — 2013-07-12
- 0.0.4 — 2013-06-30
- 0.0.3 — 2013-06-30
- 0.0.2 — 2013-06-30
- 0.0.1 — 2013-06-30

## README

# html-ls

[![Build Status](http://img.shields.io/travis/jarofghosts/html-ls.svg?style=flat)](https://travis-ci.org/jarofghosts/html-ls)
[![npm install](http://img.shields.io/npm/dm/html-ls.svg?style=flat)](https://www.npmjs.org/package/html-ls)

pretty print directory list in html

## usage

```js
var htmlls = require("html-ls")

htmlls("/var/www").pipe(process.stdout)
```

## options

the optional second argument can contain an options object looking something
like this (with defaults noted):

```js
{
    hideDot: false // hide dotfiles from list
  , showUp: false // show `..` at the top
  , dirsFirst: false // put dirs at the top of the list, then files
  , parentTag: 'ul' // opening tag for list
  , childTag: 'li' // child element tag
  , transformHref: str => str // function to transform href values
  , transformLinkText: str => str // function to transform link text
}
```

## license

MIT

---
_Source: https://npm.io/package/html-ls · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._