jonschlinkert / write-yaml Goto Github PK

View Code? Open in Web Editor NEW

41.0 5.0 7.0 21 KB

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

Home Page: https://github.com/jonschlinkert

License: MIT License

JavaScript 100.00%

yaml file fs disk write file-system data

write-yaml's Introduction

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

License

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

write-yaml's People

Contributors

Stargazers

Watchers

Forkers

flyeven mohamedaittaleb marshmallory medmrgh aaronbeall tiwarisanjay joshuaburgner

write-yaml's Issues

Write markdown files with content

Hi,
how can I specify a content in the json source object that is not a frontmatter ? I want to generate a markdown file with frontmatter and a content like this :

---
title: myTitle
date: myDate
---
myContent

Not support variables call

I need this file

service: ApiFile
custom:
  dev: ${file(variables.json):dev}
  prod: ${file(variables.json):prod}
  beta: ${file(variables.json):beta}
provider:
  name: aws
  stage: ${opt:stage, 'dev'}
  runtime: nodejs6.10
  region: ${opt:region, 'us-east-2'}
  timeout: 10
  deploymentBucket:
    name: ${opt:bukect, 'translate-elixir-node-functions'}
  environment:
    HOST_DB: ${self:custom.${opt:stage, 'dev'}.HOST_DB}
    USER_DB: ${self:custom.${opt:stage, 'dev'}.USER_DB}
    PWD_DB: ${self:custom.${opt:stage, 'dev'}.PWD_DB}
    NAME_DB: ${self:custom.${opt:stage, 'dev'}.NAME_DB}
    PORT_DB: ${self:custom.${opt:stage, 'dev'}.PORT_DB}
    PEM: ${self:custom.${opt:stage, 'dev'}.PEM}
    STAGE: ${opt:stage, 'dev'}
functions:
  getEsriToken:
    handler: EsriToken
    description: This function get token from esri
    events:
      - http:
          path: esriToken
          method: get

But when put

{
  "service": "ApiFile",
  "custom": {
    "dev": "${file(variables.json):dev}",
    "prod": "${file(variables.json):prod}",
    "beta": "${file(variables.json):beta}"
  },
  "provider": {
    "name": "aws",
    "stage": "${opt:stage, 'dev'}",
    "runtime": "nodejs6.10",
    "region": "${opt:region, 'us-east-2'}",
    "timeout": 10,
    "deploymentBucket": {
      "name": "${opt:bukect, ''translate-elixir-node-functions''}"
    },
    "environment": {
      "HOST_DB": "${self:custom.${opt:stage, 'dev'}.HOST_DB}",
      "USER_DB": "${self:custom.${opt:stage, 'dev'}.USER_DB}",
      "PWD_DB": "${self:custom.${opt:stage, 'dev'}.PWD_DB}",
      "NAME_DB": "${self:custom.${opt:stage, 'dev'}.NAME_DB}",
      "PORT_DB": "${self:custom.${opt:stage, 'dev'}.PORT_DB}",
      "PEM": "${self:custom.${opt:stage, 'dev'}.PEM}",
      "STAGE": "${opt:stage, 'dev'}"
    }
  },
  "functions": {
    "getEsriToken": {
      "handler": "compiled/lidar.getEsriToken",
      "description": "This function get token from esri",
      "events": [
        {
          "http": {
            "path": "getEsriToken",
            "method": "get"
          }
        }
      ]
    }
  }
}

Its gen

service: ApiFile
custom:
  dev: '${file(variables.json):dev}'
  prod: '${file(variables.json):prod}'
  beta: '${file(variables.json):beta}'
provider:
  name: aws
  stage: '${opt:stage, ''dev''}'
  runtime: nodejs6.10
  region: '${opt:region, ''us-east-2''}'
  timeout: 10
  deploymentBucket:
    name: '${opt:bukect, ''''translate-elixir-node-functions''''}'
  environment:
    HOST_DB: '${self:custom.${opt:stage, ''dev''}.HOST_DB}'
    USER_DB: '${self:custom.${opt:stage, ''dev''}.USER_DB}'
    PWD_DB: '${self:custom.${opt:stage, ''dev''}.PWD_DB}'
    NAME_DB: '${self:custom.${opt:stage, ''dev''}.NAME_DB}'
    PORT_DB: '${self:custom.${opt:stage, ''dev''}.PORT_DB}'
    PEM: '${self:custom.${opt:stage, ''dev''}.PEM}'
    STAGE: '${opt:stage, ''dev''}'
functions:
  getEsriToken:
    handler: compiled/lidar.getEsriToken
    description: This function get token from esri
    events:
      - http:
          path: getEsriToken
          method: get

Code with ' in the vars, what I can to do?
thanks

Write an 8-character field in yml that starts with 0 in quotation marks

I have a value in my YML file which is composed of 8 numbers and the value of this field varies according to the configuration needs of it.
Is there any way to write fields with 8 digits and that start with 0 using quotation marks?
The field is a String however whenever I write the YML file the library leaves the field without quotes.
If I try to concatenate a String with the quotation marks and the information I have the library places 2 additional quotation marks at the beginning and end of the file.
Is there any way to differentiate this in the library?
So that it does not consider my String to be an octal?

How to write !Ref ?

Title

jonschlinkert / write-yaml Goto Github PK

write-yaml's Introduction

write-yaml

Install

Usage

async

sync

About

Related projects

Contributing

Contributors

Building docs

Running tests

Author

License

write-yaml's People

Contributors

Stargazers

Watchers

Forkers

write-yaml's Issues

Recommend Projects

Recommend Topics

Recommend Org