coolaj86/json2yaml

A command-line utility to convert a JSON file (.json) to YAML (.yml)

Unmaintained Mirror

Please go to the real repo at https://git.coolaj86.com/coolaj86/json2yaml.js

json2yaml

A command-line utility to convert JSON to YAML (meaning a .json file to a .yml file)

The purpose of this utility is to pretty-print JSON in the human-readable YAML object notation (ignore the misnomer, YAML is not a Markup Language at all).

Installation

npm install -g json2yaml

Note: To use npm and json2yaml you must have installed NodeJS.

Usage

Specify a file:

json2yaml ./example.json > ./example.yml

yaml2json ./example.yml | json2yaml > ./example.yml

Or pipe from stdin:

curl -s http://foobar3000.com/echo/echo.json | json2yaml

wget -qO- http://foobar3000.com/echo/echo.json | json2yaml

Or require:

(function () {
  "use strict";

  var YAML = require('json2yaml')
    , ymlText
    ;

    ymlText = YAML.stringify({
      "foo": "bar"
    , "baz": "corge"
    });

    console.log(ymlText);
}());

Example

So, for all the times you want to turn JSON int YAML (YML):

{ "foo": "bar"
, "baz": [
    "qux"
  , "quxx"
  ]
, "corge": null
, "grault": 1
, "garply": true
, "waldo": "false"
, "fred": "undefined"
}

becomes

---
  foo: "bar"
  baz:
    - "qux"
    - "quxx"
  corge: null
  grault: 1
  garply: true
  waldo: "false"
  fred: "undefined"

Note: In fact, both of those Object Notations qualify as YAML because JSON technically is a proper subset of YAML. That is to say that all proper YAML parsers parse proper JSON.

YAML can use either whitespace and dashes or brackets and commas.

For human readability, the whitespace-based YAML is preferrable. For compression and computer readability, the JSON syntax of YAML is preferrable.

Alias

json2yaml has the following aliases:

• jsontoyaml
• json2yml
• jsontoyml

json2yaml's Issues

Unnecessary linebreaks with array of objects

When the first element of an array is an object, it should't begin with '\n'.

This:
yaml.stringify([{frank: 12, arno: 13},{ben: 211, karl: 21}])

Should return that:

---
  - frank: 12
    arno: 13
  - ben: 211
    karl: 21

Instead of:

---
  - 
    frank: 12
    arno: 13
  - 
    ben: 211
    karl: 21

Git repository is unreachable due to HTTPS certificate common name error

The Git repository is unreachable due to an error in the HTTPS certificate (or because the URL is outdated). Example in Firefox 62:

The URL https://gitlab.daplie.com/coolaj86/json2yaml does not cause this error to appear, but the repository seems to be private as it requires the user to sign in to view it.

Use GruntJS to build browser and node versions

Since there's no nice boilerplate that works well for both, might as well figure out how other projects are using GruntJS to do the same.

unsafe-eval error if used with Content Security Policy directive

The remedial dependency that the library is using has these lines of code:

var global = Function('return this')()

This would not execute if 'unsafe-eval' CSP is off.
Any suggestions?
I understand that this is a dependency issue but that project doesn't seem to have a way to report issues/questions.

Thanks,
Diana

Bug: empty JSON key not rendered correctly in YAML

Hi!
Running:

echo '{"something": {"": "empty"}}' | json2yaml

returns:

---
  something: 
    : "empty"

Should return:

---
  something: 
    "": "empty"

yaml2json broken on windows with git-bash (git-scm.org)

Confirmed this is only affecting the git-bash shell on windows, but a lot of people use it.

I'll work on a fix, but I think the best fix might be moving to a more standard command-line tool library.

Here's the test.sh failing on windows:

Actually you can close this. Looks like the package everyone is using (including Gulp and Grunt) is js-yaml and js-yaml-cli which work on windows bash without a problem.

Remove trailing spaces

The whole file is indent two spaces.
Is it possible to remove those spaces?

So the file will not be longer:

---
  param1:
    name: test

but

---
param1:
  name: test

Even an Option to remove the trailing --- would be nice.

Key starting with @ should be quoted

Converting the following json to yaml:

{
  "dependencies": {
    "@scope": "test"
  }
}

should produce:

dependencies:
  "@scope": test

but currently produces the following (which is invalid):

dependencies:
  @scope: test

The fix for this probably needs to protect against other special characters as well.

jsontoyaml.com needs a code prettifier

The code blocks just aren't pretty enough.

Maybe include ./assets/widgets/syntax/javascripts/prettify.js as ruhoh does.

QUESTION: is there a way to add comments?

I'd like to add a line at the begging indicating that the file was generated with a toot

Pretty multiline strings

Currently a line with newline characters will be saved as a single line with the newline characters encoded

foo: "1\n2\n3"

However, there are many ways to save a multiline string in the yaml format. Would be nice to support them. Maybe by passing an option.

YAML.stringify({foo: "1\n2\n3"}, {prettyMultiline: true})
//> foo: |
//    1
//    2
//    3

Add social links to jsontoyaml.com

• twitter share
• facebook send
• g+

not all cases are supported (please close. my fault)

{ "dual word": "compiles into wrong yaml" }

Monetize jsontoyaml.com

• flattr?
• gittip?
• ads?

allow jsontoyaml.com to get JSON from a url

way good idea

split jsontoyaml.com into own repo and add fork banner

this quickly outgrew itself

drag 'n' drop json file for jsontoyaml.com

it's just a good idea

Add JSONLint to jsontoyaml.com

It would be rather useful to have the JSONLint-ing happen on this page, rather that instructing the user to visit http://jsonlint.com.

Support for date objects

Right now it just crashes with Error: what the crap: date (lol). Searched around a bit, and though I couldn't find any official date representation on the spec, Symfony suggests ISO-8601 strings, which is a pretty sensible recommendation and a simple one to implement given JS dates have that nice .toISOString() method.

Thoughts?