yini-cli 1.0.1-beta.1 β 1.0.2-beta
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -9
- package/package.json +2 -2
- package/sample.yini +5 -5
package/README.md
CHANGED
|
@@ -11,20 +11,19 @@
|
|
|
11
11
|
- **YINI is an alternative** to other great config formats like INI, JSON, YAML, XML, and TOML β designed for clarity, simplicity, and straightforward section nesting.
|
|
12
12
|
- **Started as a personal project and a research challenge:** Provides structure similar to INI, with features inspired by JSON and YAML.
|
|
13
13
|
- **Built for clarity:**
|
|
14
|
-
* Uses
|
|
15
|
-
* Uses a concise syntax, aims to not have too much syntax noise.
|
|
14
|
+
* Uses concise syntax designed for clarity, especially in nested sections.
|
|
16
15
|
* Supports commonly used configuration structures.
|
|
17
|
-
- *
|
|
16
|
+
- *Developed to meet practical needs, driven by curiosity and a desire **for configuration clarity, simplicity, minimalism, and flexibility**.
|
|
18
17
|
|
|
19
18
|
---
|
|
20
19
|
|
|
21
20
|
## π‘ What is YINI?
|
|
22
21
|
- **INI-inspired** β with added support for typing, comments, and nested sections.
|
|
23
|
-
- **Uses minimal syntax** β
|
|
22
|
+
- **Uses minimal syntax** β yet aims to keep maximum clarity.
|
|
24
23
|
- Section nesting **without requiring indentation or dot-delimited keys**.
|
|
25
24
|
- **Supports strict and lenient modes**, and all major data types.
|
|
26
25
|
- Designed for compatibility with both **manual editing** and **automation**.
|
|
27
|
-
- π See [how YINI
|
|
26
|
+
- π See [how YINI differs from JSON, YAML, INI, and TOML](https://github.com/YINI-lang/yini-parser-typescript/tree/main/examples/compare-formats.md).
|
|
28
27
|
- Want the full syntax reference? See the [YINI Specification](https://github.com/YINI-lang/YINI-spec).
|
|
29
28
|
|
|
30
29
|
---
|
|
@@ -63,10 +62,10 @@ To learn more, see the [Getting Started: Intro to YINI Config Format](https://gi
|
|
|
63
62
|
Create a simple test file, for example: `config.yini`:
|
|
64
63
|
```yini
|
|
65
64
|
^ App
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
65
|
+
name = "My App Title"
|
|
66
|
+
version = "1.2.3"
|
|
67
|
+
pageSize = 25
|
|
68
|
+
darkTheme = off
|
|
70
69
|
```
|
|
71
70
|
|
|
72
71
|
Then run:
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "yini-cli",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2-beta",
|
|
4
4
|
"description": "CLI for parsing and validating YINI config files: type-safe values, nested sections, comments, minimal syntax noise, and optional strict mode.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"yini",
|
|
@@ -68,7 +68,7 @@
|
|
|
68
68
|
"author": "Marko K. SeppΓ€nen",
|
|
69
69
|
"dependencies": {
|
|
70
70
|
"commander": "^14.0.0",
|
|
71
|
-
"yini-parser": "^1.0.
|
|
71
|
+
"yini-parser": "^1.0.2-beta"
|
|
72
72
|
},
|
|
73
73
|
"devDependencies": {
|
|
74
74
|
"@eslint/js": "^9.31.0",
|
package/sample.yini
CHANGED
|
@@ -4,16 +4,16 @@
|
|
|
4
4
|
Example of a YINI document.
|
|
5
5
|
*/
|
|
6
6
|
|
|
7
|
-
^ Service
|
|
7
|
+
^ Service // Defines a section named Service.
|
|
8
8
|
Enabled = true
|
|
9
9
|
|
|
10
|
-
^^ Cache
|
|
11
|
-
Type = "redis"
|
|
10
|
+
^^ Cache // Defines Cache, a sub-section of Server.
|
|
11
|
+
Type = "redis"
|
|
12
12
|
TTL = 3600
|
|
13
13
|
|
|
14
|
-
^^^ Options
|
|
14
|
+
^^^ Options // Defines Options, a sub-section of Cache.
|
|
15
15
|
Host = "127.0.0.1"
|
|
16
16
|
Port = 6379
|
|
17
17
|
|
|
18
|
-
^ Env
|
|
18
|
+
^ Env // Defines a section named Env.
|
|
19
19
|
code = "dev"
|