Reading from YAML File in Javascript

javascript parsing yaml

67,405

Solution 1

js-yaml does. I found this by Googling "node js yaml" because reading from files in JavaScript is done server side with node.js (or something like it), not from a browser.

The README for js-yaml begins

usage: js-yaml [-h] [-v] [-c] [-j] [-t] file

Positional arguments:

file File with YAML document(s)

That is pretty strong evidence that it does process YAML directly from files.

Solution 2

It seemed to be hard to find a good example of using js-yaml from a browser. Probably because they emphasize the use of the parser in node.js.

The parser is at https://github.com/nodeca/js-yaml. Use NPM to install it

npm install js-yaml

and grab the js-yaml.js file from the node_modules/js-yaml/bin directory.

Here is a quick, simple demo that loads a YAML file, uses js-yaml to parse it into objects, and then (for verification) it does a native JSON.stringify to convert the JSON into a string and finally uses jquery $.parseJSON to verify the resulting JSON.

(function () {
"use strict";
    $(document).ready(function () {
        $.get('/common/resources/LessonContentsLv01Ln01.yml')
        .done(function (data) {
          console.log('File load complete');
          console.log(jsyaml.load(data));
          var jsonString = JSON.stringify(data);
          console.log(jsonString);
          console.log($.parseJSON(jsonString));
      });
    });
}());

And the HTML

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <title>Read YAML</title>
                 <script src="//code.jquery.com/jquery-2.1.0.js">
        </script><script src='/vendor/js/js-yaml.js'>
        </script><script src='/test/readYaml.js'>
    </script>
</head>
<body>
</body>
</html>

Github repository https://github.com/nodeca/js-yaml

Solution 3

If you want to parse it in web browser, you can load the yaml file you want to parse in script tag and read it's content using js code, which will provide you string result. And if you want to parse yaml in nodejs environment, you can read file directly and also got string. I don't think this is a problem from directly parse yaml or parse yaml from string.

67,405

Author by

nsax91

Updated on July 09, 2022

Comments

nsax91 almost 2 years

I am trying to read parameters from a YAML file into Javascript. Is there any good library to do this?

I've tried these libraries: https://github.com/nodeca/js-yaml and http://code.google.com/p/javascript-yaml-parser/

but both libraries only have functions that parse YAML when it is given as a string, instead of parsing straight out of a .yml or .yaml file. Are there any parsers that read YAML from a file and convert them to JS objects?
nsax91 over 11 years

js-yaml used a "require" call though. I have little to no experience with node.js or anything server-side, and for this project I'm just looking for a client-side parser that will run in the browser.
Ray Toal over 11 years

I don't know of any client-side solutions for reading yaml files. I think the best you can do is combine file reading techniques in client-side JavaScript (see [stackoverflow.com/questions/4950567/… question) for some of these techniques) then combine them with the yaml parsing of strings.