【yaml.js】jsオブジェクトをYAML形式に変換

jsオブジェクトをyamlに変換したときの備忘録を書きます。

使うのはyaml.jsというライブラリです。これを使うとyamlとjsオブジェクトの相互変換が簡単にできます。

https://www.npmjs.com/package/yamljs

インストール方法

まず、プロジェクトにyaml.jsをインストールする必要があります。以下のコマンドを使ってインストールできます。

npm install yamljs

また、CDNからもライブラリを読み込むことが可能です。

<script src="https://cdn.jsdelivr.net/npm/yamljs@0.3.0/dist/yaml.min.js"></script>

基本的な使用方法

YAMLをJavaScriptオブジェクトに変換

YAML文字列をJavaScriptのオブジェクトに変換する場合、YAML.parse()メソッドを使用します。

const nativeObject = YAML.parse(yamlString);

JavaScriptオブジェクトをYAMLに変換

逆に、JavaScriptオブジェクトをYAML文字列に変換する場合、YAML.stringify()メソッドを使います。

const yamlString = YAML.stringify(nativeObject, depth);

以下のように書くことでdummyDataというオブジェクトを簡単にYAMLに変換することができます

import YAML from "yamljs";

const dummyData = [
  {
    id: 1,
    title: "📝今からやること",
    tasks: [
      {
        id: 2,
        title: "Reactの勉強",
      },
      {
        id: 3,
        title: "Youtubeで勉強",
      },
      {
        id: 4,
        title: "散歩",
      },
    ],
  },
  {
    id: 5,
    title: "🚀今後やること",
    tasks: [
      {
        id: 6,
        title: "コーディング",
      },
      {
        id: 7,
        title: "転職活動",
      },
    ],
  },
  {
    id: 8,
    title: "🌳終わったこと",
    tasks: [
      {
        id: 9,
        title: "読書",
      },
    ],
  },
];

const conv = (() => {
  const yamlString = YAML.stringify(dummyData, 4);
  console.log(yamlString);
})();