# hipt

> A library to parse indented text files.

Latest version **0.0.3** (published 2023-02-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install hipt
pnpm add hipt
yarn add hipt
bun add hipt
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2023-02-04 |
| First published | 2022-08-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 15.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Komichi |
| Maintainers | k0michi |

## Links

- npm: https://www.npmjs.com/package/hipt
- Repository: https://github.com/k0michi/hipt
- Homepage: https://github.com/k0michi/hipt#readme
- Issues: https://github.com/k0michi/hipt/issues
- npm.io page: https://npm.io/package/hipt

## Recent versions

- 0.0.3 (latest) — 2023-02-04
- 0.0.2 — 2023-02-02
- 0.0.1 — 2022-08-01

## README

# Hierarchically Indented Plain Text

This is a library to parse plain text with indentation like this:

```
abc
  def
    ghi
123
  456
    789
```

## Installation

```bash
$ npm i hipt
$ yarn add hipt
```

## Usage

```js
import * as hipt from 'hipt';

const root = hipt.parse(
`abc
  def
    ghi
123
  456
    789`
);
/*
{
  "children": [
    {
      "value": "abc",
      "children": [
        {
          "value": "def",
          "children": [
            {
              "value": "ghi",
              "children": []
            }
          ]
        }
      ]
    },
    {
      "value": "123",
      "children": [
        {
          "value": "456",
          "children": [
            {
              "value": "789",
              "children": []
            }
          ]
        }
      ]
    }
  ]
}
*/
```

## License
MIT License

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