jonschlinkert/write-yaml

Basic node.js utility for converting JSON to YAML and writing formatting YAML files to disk.

write-yaml

Write YAML. Converts JSON to YAML writes it to the specified file.

Install

Install with npm:

$ npm install --save write-yaml

Install with yarn:

$ yarn add write-yaml

Usage

Add to your javascript/node.js application with the following line of code:

var yaml = require('write-yaml');

async

var data = {language: 'node_js', node_js: ['0.10', '0.11']};

yaml('.travis.yml', data, function(err) {
  // do stuff with err
});

Would write .travis.yml to disk with the following contents:

language: node_js
node_js:
  - "0.10"
  - "0.11"

sync

yaml.sync('.travis.yml', data);

Would write .travis.yml to disk with the following contents:

language: node_js
node_js:
  - "0.10"
  - "0.11"

About

Related projects

• read-data: Read JSON or YAML files. | homepage
• read-yaml: Very thin wrapper around js-yaml for directly reading in YAML files. | homepage
• write-data: Write a YAML or JSON file to disk. Automatically detects the format to write based… more | homepage
• write-json: Write a JSON file to disk, also creates intermediate directories in the destination path if… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Contributors

Commits	Contributor
12	jonschlinkert
2	shinnn

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.5.0, on April 12, 2017.