https://github.com/patitotective/kdl-nim
KDL Nim implementation.
https://github.com/patitotective/kdl-nim
document-language kdl nim nim-lang nimlang parser
Last synced: about 1 month ago
JSON representation
KDL Nim implementation.
- Host: GitHub
- URL: https://github.com/patitotective/kdl-nim
- Owner: Patitotective
- License: mit
- Created: 2022-08-26T00:25:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-21T16:47:06.000Z (6 months ago)
- Last Synced: 2025-03-23T18:48:05.316Z (2 months ago)
- Topics: document-language, kdl, nim, nim-lang, nimlang, parser
- Language: Nim
- Homepage: https://patitotective.github.io/kdl-nim/
- Size: 1.01 MB
- Stars: 18
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# kdl-nim
[](https://nim-lang.org)
[](https://github.com/Patitotective/kdl-nim/actions/workflows/tests.yml)
[KDL](https://kdl.dev/) Nim implementation.
## Installation
```
nimble install kdl
```
Or directly from this repository:
```
nimble install https://github.com/Patitotective/kdl-nim
```
## Features
- Pure Nim with no dependencies.
- Streams support
- Compile-time parsing support
- [Decoder/Desializer](https://patitotective.github.io/kdl-nim/kdl/decoder.html)
- [Encoder/Serializer](https://patitotective.github.io/kdl-nim/kdl/encoder.html)
- [JSON-in-KDL](https://github.com/kdl-org/kdl/blob/main/JSON-IN-KDL.md) ([JiK](https://patitotective.github.io/kdl-nim/kdl/jik.html))
- [XML-in-KDL](https://github.com/kdl-org/kdl/blob/main/XML-IN-KDL.md) ([Xik](https://patitotective.github.io/kdl-nim/kdl/xik.html))
- [Prefs](https://patitotective.github.io/kdl-nim/kdl/prefs.html)
## Overview
```nim
import kdl
var doc = parseKdl("""
// Nodes can be separated into multiple lines
title \
"Some title"
// Files must be utf8 encoded!
smile (emoji)"😁" {
upside-down (emoji)"🙃"
}
// Instead of anonymous nodes, nodes and properties can be wrapped
// in "" for arbitrary node names.
"!@#$@$%Q#$%~@!40" "1.2.3" "!!!!!"=true
// The following is a legal bare identifier:
foo123~!@#$%^&*.:'|?+ "weeee"
// And you can also use unicode!
ノード お名前="☜(ﾟヮﾟ☜)"
// kdl specifically allows properties and values to be
// interspersed with each other, much like CLI commands.
foo bar=true "baz" quux=false 1 2 3
""") # You can also read files using parseKdlFile("file.kdl")
# Nodes are represented like:
# type KdlNode* = object
# tag*: Option[string]
# name*: string
# args*: seq[KdlVal]
# props*: Table[string, KdlVal]
# children*: seq[KdlNode]
assert doc[0].args[0].isString() # title "Some title"
assert doc[1].args[0] == "😁" # smile node
assert doc[1].args[0].tag.isSome and doc[1].args[0].tag.get == "emoji" # Type annotation
assert doc[1].children[0].args[0] == "🙃" # smile node's upside-down child
assert doc[2].name == "!@#$@$%Q#$%~@!40"
assert doc[^1]["quux"] == false
doc[0].args[0].setString("New title")
# toKdlNode is a macro that facilitates the creation of `KdlNode`s, there's also toKdl (to create documents) and toKdlVal
doc[1].children[0] = toKdlNode: sunglasses("😎"[emoji], 3.14)
assert $doc[1].children[0] == "\"sunglasses\" (\"emoji\")\"😎\" 3.14"
assert doc[1].children[0].args[1].get(uint8) == 3u8 # Converts 3.14 into an uint8
doc[^1]["bar"].setTo(false) # Same as setBool(false)
writeFile("doc.kdl", doc)
```
## Docs
Documentation is live at https://patitotective.github.io/kdl-nim/.
## TODO
- Implement [KDL schema language](https://github.com/kdl-org/kdl/blob/main/SCHEMA-SPEC.md).
- Implement [KDL query language](https://github.com/kdl-org/kdl/blob/main/QUERY-SPEC.md).
- Support OrderedTables
## About
- GitHub: https://github.com/Patitotective/kdl-nim.
- Discord: https://discord.gg/U23ZQMsvwc.
- Docs: https://patitotective.github.io/kdl-nim/.
Contact me:
- Discord: **Patitotective#0127**.
- Twitter: [@patitotective](https://twitter.com/patitotective).
- Email: **[email protected]**.