-
-
Notifications
You must be signed in to change notification settings - Fork 303
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
4,223 additions
and
54 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| Copyright (c) 2012 Michelle Tilley | ||
|
|
||
| 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| TOML Parser for Node.js | ||
| ======================= | ||
|
|
||
| [](https://travis-ci.org/BinaryMuse/toml-node) | ||
|
|
||
| [](https://nodei.co/npm/toml/) | ||
|
|
||
| If you haven't heard of TOML, well you're just missing out. [Go check it out now.](https://github.com/mojombo/toml) Back? Good. | ||
|
|
||
| TOML Spec Support | ||
| ----------------- | ||
|
|
||
| toml-node supports version 0.4.0 the TOML spec as specified by [mojombo/toml@v0.4.0](https://github.com/mojombo/toml/blob/master/versions/en/toml-v0.4.0.md) | ||
|
|
||
| Installation | ||
| ------------ | ||
|
|
||
| toml-node is available via npm. | ||
|
|
||
| npm install toml | ||
|
|
||
| toml-node also works with browser module bundlers like Browserify and webpack. | ||
|
|
||
| Usage | ||
| ----- | ||
|
|
||
| ### Standalone | ||
|
|
||
| Say you have some awesome TOML in a variable called `someTomlString`. Maybe it came from the web; maybe it came from a file; wherever it came from, it came asynchronously! Let's turn that sucker into a JavaScript object. | ||
|
|
||
| ```javascript | ||
| var toml = require('toml'); | ||
| var data = toml.parse(someTomlString); | ||
| console.dir(data); | ||
| ``` | ||
|
|
||
| `toml.parse` throws an exception in the case of a parsing error; such exceptions have a `line` and `column` property on them to help identify the offending text. | ||
|
|
||
| ```javascript | ||
| try { | ||
| toml.parse(someCrazyKnuckleHeadedTrblToml); | ||
| } catch (e) { | ||
| console.error("Parsing error on line " + e.line + ", column " + e.column + | ||
| ": " + e.message); | ||
| } | ||
| ``` | ||
|
|
||
| ### Streaming | ||
|
|
||
| As of toml-node version 1.0, the streaming interface has been removed. Instead, use a module like [concat-stream](https://npmjs.org/package/concat-stream): | ||
|
|
||
| ```javascript | ||
| var toml = require('toml'); | ||
| var concat = require('concat-stream'); | ||
| var fs = require('fs'); | ||
|
|
||
| fs.createReadStream('tomlFile.toml', 'utf8').pipe(concat(function(data) { | ||
| var parsed = toml.parse(data); | ||
| })); | ||
| ``` | ||
|
|
||
| Thanks [@ForbesLindesay](https://github.com/ForbesLindesay) for the suggestion. | ||
|
|
||
| ### Requiring with Node.js | ||
|
|
||
| You can use the [toml-require package](https://github.com/BinaryMuse/toml-require) to `require()` your `.toml` files with Node.js | ||
|
|
||
| Live Demo | ||
| --------- | ||
|
|
||
| You can experiment with TOML online at http://binarymuse.github.io/toml-node/, which uses the latest version of this library. | ||
|
|
||
| Building & Testing | ||
| ------------------ | ||
|
|
||
| toml-node uses [the PEG.js parser generator](http://pegjs.majda.cz/). | ||
|
|
||
| npm install | ||
| npm run build | ||
| npm test | ||
|
|
||
| Any changes to `src/toml.peg` requires a regeneration of the parser with `npm run build`. | ||
|
|
||
| toml-node is tested on Travis CI and is tested against: | ||
|
|
||
| * Node 0.10 | ||
| * Node 0.12 | ||
| * Latest stable io.js | ||
|
|
||
| License | ||
| ------- | ||
|
|
||
| toml-node is licensed under the MIT license agreement. See the LICENSE file for more information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| var parser = require('./lib/parser'); | ||
| var compiler = require('./lib/compiler'); | ||
|
|
||
| module.exports = { | ||
| parse: function(input) { | ||
| var nodes = parser.parse(input.toString()); | ||
| return compiler.compile(nodes); | ||
| } | ||
| }; |
Oops, something went wrong.