Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
JavaScript (Node.js and browser) meets TOML.
CoffeeScript JavaScript Shell
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
script
src
test
.gitignore
.npmignore
.travis.yml
Cakefile
README.md
package.json

README.md

topl

Build Status NPM version

JavaScript (Node.js and browser) meets TOML.

Supports most recent TOML spec (v0.2.0).

What?

It's Tom's Obvious, Minimal Language.

Why?

Why not?

Okay, but why in Node.js and the browser?

Because it's time to have a simple config language that works across all platforms, not just one.

How to install

npm install topl

How to use

Node.js

Bootstrap it

./script/bootstrap

Require it

var topl = require('topl');

Parse it

require('fs').readFile('<path to toml file>', function(err, data) {
  var parsedObject = topl.parse(data);

  console.log(parsedObject);
});

Browser

Load it

<script src="topl.min.js" type="text/javascript"></script>

Parse it

topl.parse('hello = "world"');

Tests

Simply run the helper script:

./script/test

You can also run the examples in test/fixtures through topl with:

cake test

Want to see the output as a string? Go for it:

cake -s test

topl also supports running the toml-test test suite. Pass test/toml-test.js to toml-test to run it:

export GOPATH=$HOME/go
go get github.com/BurntSushi/toml-test
~/go/bin/toml-test ./test/toml-test.js

Build

You can compile the CoffeeScript source into the JavaScript files in lib by running:

cake build

Contribute

  1. Fork
  2. Create
  3. Code
  4. Test
  5. Push
  6. Submit
  7. Yay!

License

(The MIT License)

Copyright (c) 2014 Ian Lollar

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.