# lampenfieber

> text parser for parameterized content blocks within text files

Latest version **1.1.0** (published 2020-03-21) · Apache-2.0 license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2020-03-21 |
| First published | 2020-01-27 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 0 |
| Unpacked size | 10.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | FND |
| Maintainers | fnd |

## Links

- npm: https://www.npmjs.com/package/lampenfieber
- Repository: https://github.com/FND/lampenfieber
- Issues: https://github.com/FND/lampenfieber/issues
- npm.io page: https://npm.io/package/lampenfieber

## Recent versions

- 1.1.0 (latest) — 2020-03-21
- 1.0.1 — 2020-01-27

## README

Lampenfieber
============

text parser for parameterized content blocks within text files

    lorem ipsum
    dolor sit amet

    ```formula caption="mass-energy equivalence"
    E = mc^2
    ```

    consectetur adipisicing elit,
    sed do eiusmod tempor

    ```
    …
    ```

parsing the above results in a list of segments, each either a string (default)
or a `{ type, params, content }` object (fenced blocks):

```javascript
[
    "lorem ipsum\ndolor sit amet\n",
    {
        type: "formula",
        params: {
            caption: "mass-energy equivalence"
        },
        content: "E = mc^2"
    },
    "\nconsectetur adipisicing elit,\nsed do eiusmod tempor\n",
    {
        type: null,
        params: {},
        content: "…"
    }
]
```

each segment can then be processed separately, e.g. rendering via different
markup languages


Getting Started
---------------

*   `npm install lampenfieber`
*   usage:

    ```javascript
    let txtParse = require("lampenfieber");

    let segments = txtParse("…", { delimiter: "~~~" });
    ```


Contributing
------------

* ensure [Node](https://nodejs.org) is installed
* `npm install` downloads dependencies
* `npm test` runs the test suite and checks code for stylistic consistency


Release Process
---------------

NB: version numbers are incremented in accordance with
    [semantic versioning](https://semver.org)

1. update version number in `package.json`
2. commit as "v#.#.#"

        $ git commit -m "v`node -p -e 'require("./package.json").version'`"

    the commit description should also include a rationale, e.g. why a major
    version was required, and a list of significant changes

3. `./release` publishes the new version


License
-------

Lampenfieber is licensed under the Apache 2.0 License.

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