Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/frewtypebbles/neat-object-notation
https://github.com/frewtypebbles/neat-object-notation
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/frewtypebbles/neat-object-notation
- Owner: FrewtyPebbles
- Created: 2022-11-09T09:34:25.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2022-11-20T20:15:37.000Z (about 2 years ago)
- Last Synced: 2025-01-11T15:23:29.247Z (11 days ago)
- Language: Rust
- Size: 5.98 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Neat Object Notation 0.3.1
A smart, modular and readable configuration file format for complex multifile solutions.
## Comments
```
| Any lines which are to be commented out must start with a pipe character.
| The pipe must ALWAYS be at the beginning of the line for comments.
```
## Global Scope
By default the global scope of a Neat config file is a dictionary, if you wish to specify otherwise you must put this somewhere in your .neat file on its own line
```
~list
```
## Labeled Structures
```
[This is where you write the key associated with your dictionary]
"This is a key to an inline dictionary":{"This is the key to an inline list":()}
| This [-] token denotes the end of a dictionary.
[-]
| The line below is the 0th index of this labeled list and is a list with a single item,
| That single item is an empty dictionary
({})
| This <-> token denotes the end of a list.
<->
```
## Unlabeled Structures
If you wish to create an unlabeled structure vertically you can do so like this:
```
~list
{
"Some key":29873198273
}
```
Another example:
```
{
[inner section name]
"some key": True
[-]
"another key": "abc"
}
<->
```
## Modules
Importing only specific sections of a module:
```
| This file is called filename.neat
{
[inner section name]
"some key": True
[-]
"another key": "abc"
}
<->
```
```
|this is where we are importing the module
mod filename : 'section name'.0.'inner section name'
| Alternate syntax
* foldername.filename : 'section name'.0.'inner section name'
```
Importing a whole module:
```
|this file is called module.neat
[section]
1:"abc"
[-]
```
```
| This is where we import module.neat
mod module
[another section]
"def":2
[-]
| Result:
| {"module":{"section":{"1":"abc"}},"another section":{"def":2}}
```
## Alias
Aliases can be used to add items to sections outside of that section and its parent.
The left hand side of the : is the alias name. The right hand side of the : is the alias path.
```
{
[inner section name]
"some key": True
[-]
"another key": "abc"
}
<->
| this is the alias declaration
alias alias_name : [section name] 0 [inner section name]
| the name of the alias, in this case alias_name, marks the start of an alias section.
alias_name
"some other key": false
| The /-/ token marks the end of an alias section
/-/
| Result:
| {"section name":[{"inner section name":{"some key":True,"some other key":False},"another key":"abc"}]}
```