Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/liushuping/freetree
A node module free creating tree data structure from text input
https://github.com/liushuping/freetree
Last synced: 3 months ago
JSON representation
A node module free creating tree data structure from text input
- Host: GitHub
- URL: https://github.com/liushuping/freetree
- Owner: liushuping
- License: mit
- Created: 2014-07-15T17:16:57.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-06-23T14:48:10.000Z (over 9 years ago)
- Last Synced: 2024-11-07T20:14:42.607Z (3 months ago)
- Language: JavaScript
- Size: 183 KB
- Stars: 6
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
freetree
========
A node module for creating tree data structure from text input
[](https://travis-ci.org/liushuping/freetree.svg)
This module takes a simplified tree structured input string and build a JavaScript tree object in memory.
A simple tree structured input string (input.txt) example:
```
#root node
##node1
###node11
##node2
```
It illustrates a tree as below:
```
root node
|-- node1
| |--node11
|-- node2
```
## Conventions
Each line represents a node in the tree, it should begins with the leading character (default is \#). The count of leading chracters minus 1 is the level of the node. There should be only 1 root node which has only 1 leading character, and it should be at the first line of the input string.
## Usage
```javascript
var freetree = require('freetree');
var tree = freetree.parse(str, settings);
```
**`settings`** has below listed properties
* `leadingChar`: optional, defines leading character for the tree, defaulted to '#'
* `compact`: optional, output the object in compact mode.
## Code examples
Prepare an `input.txt` file as above demonstrated.
```javascript
var fs = require('fs');
var freetree = require('freetree');
var str = fs.readFileSync('input.txt', 'utf8');
var tree = freetree.parse(str);
```
then, the `tree` object is an in-memory JavaScript object. In this example, the object is in structure:
```javascript
{
"level": 0,
"value": "root",
"nodes": [{
"level": 1,
"value": "node1",
"nodes": [{
"level": 2,
"value": "node11"
}]
}, {
"level": 1,
"value": "node2"
}]
}
```
If the `compact` option is set to `true`, the object will be compressed in below structure:
```javascript
{
"root": [{
"node1": [{
"node11": null
}]
}, {
"node2": null
}]
}
```
## Test
Make sure `mocha` is installed globally
```
npm install mocha -g
```
Run `npm test` to run unit test
## License
MIT