# jml-format

> jml is a custom file format like json, bson or yaml

Latest version **1.1.9** (published 2022-10-03) · ISC license · 0 weekly downloads

## Install

```sh
npm install jml-format
pnpm add jml-format
yarn add jml-format
bun add jml-format
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.9 |
| Published | 2022-10-03 |
| First published | 2022-09-29 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | hz-rd |
| Maintainers | hz-rd |
| Keywords | Typescript, JML, jml-format, jml-file, jml-file-format, .jml |

## Links

- npm: https://www.npmjs.com/package/jml-format
- Repository: https://github.com/Pronum/jml
- Homepage: https://github.com/Pronum/jml#readme
- Issues: https://github.com/Pronum/jml/issues
- npm.io page: https://npm.io/package/jml-format

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.1.9 (latest) — 2022-10-03
- 1.1.8 — 2022-10-02
- 1.1.7 — 2022-10-02
- 1.1.6 — 2022-10-01
- 1.1.5 — 2022-10-01
- 1.1.4 — 2022-09-30
- 1.1.3 — 2022-09-30
- 1.1.2 — 2022-09-30
- 1.1.1 — 2022-09-29
- 1.1.0 — 2022-09-29
- 1.0.9 — 2022-09-29
- 1.0.8 — 2022-09-29
- 1.0.7 — 2022-09-29
- 1.0.6 — 2022-09-29
- 1.0.5 — 2022-09-29
- … 5 more at https://npm.io/package/jml-format/versions

## README

# Author(s)/Creator(s)
<center><img src="https://discord.c99.nl/widget/theme-3/730699395967877160.png"/></center>

# jml
JML is a custom file format like json, bson or yaml.

# To get started :
- At first, JML works with spaces, symbols & you don't need to put double quotes!
- Aswell as always this is just the beta of jml file format, more updates is comming soon!
### Example code for .jml file :
```yml
spacing is avaliable | this is spacing
$ymbols? | $ymb0ls & numb3r$ 4r3 w0rk1ng
```

### Example code in typescript :
```typescript
import { initJMLFile, indexJMLFile, getFromJML } from "jml-format";
import path from "path";

const fpath = path.join(__dirname + "/conf.jml");

(async () => {
    var s: any;

    // 👇 Await here is necessary, Or it wont initialize the JML File,
    // 👇 Await is required to skip using "setTimeout()".
    await initJMLFile(fpath).then( ( ) => s = indexJMLFile() );

    console.log(getFromJML(s.list.items, "spacing is avaliable"));
    console.log(getFromJML(s.list.items, "$ymbols?"));
})();
```

### Output:
-     this is spacing
-     $ymb0ls & numb3r$ 4r3 w0rk1ng

## Pros & cons :
### jml works with :
-   spacing
-   numbers
-   symbols

### jml can not work with :
-   more than space after you finished the field or value, Like :
-     GOOD 👇:
-      this is a test | yep!
-     BAD 👇:
-      this is a test     |     yep!

-   no ability to put comments (Working on it)

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