yaeda.github.io

YAML の timestamp と gray-matter の挙動

(over 1 year ago)

YAML の timestamp 周りでややハマった.

このブログは Markdown で書いていて，先頭に以下のようなデータを front matter として付与している．

title: ライフログ
date: 2020-10-02 21:30

このdateをシンプルにしたいと思った．

一日に複数のポストがあったときにそれらの順序を決定するためにdateに「時分」を入れているが，書き始め・書き終わり・投稿で時間差があるため，どの時間に設定するか悩むときがある．時間をそこまで厳密に管理する必要もないし，一日に一回しかポストしないケースの方が大半なのでシンプルに「年月日」と書けたほうが楽．

ということで試しにdate: 2020-10-02としてみたらソートに失敗した．原因は gray-matter のパース結果の型に以下のような違いがあったため．

  • date: 2020-10-02 21:30:00 => Date オブジェクト
  • date: 2020-10-02 21:30 => string
  • date: 2020-10-02 => Date オブジェクト
  • date: "2020-10-02" => string

YAML はデータ型に timestamp という型があって，gray-matter は timestamp として正しいフォーマットの時は Date オブジェクトを返し，そうでないときは string を返すようになっている様子．

Language-Independent Types for YAML™ Version 1.1

型を揃えたいが front matter の書き方に制約を加えるのは，書き手が人間であることを考えると良くない仕様と思われる．そこで gray matter の変換結果を以下のようにすべて string に変換するようにした．

// Use gray-matter to parse the post metadata section
const matterResult = matter(fileContents);
if (
  typeof matterResult.data.date === "object" &&
  typeof matterResult.data.date.toISOString === "function"
) {
  matterResult.data.date = matterResult.data.date.toISOString();
}

雑だがとりあえずはいいだろう．もっとも，ファイル名にも日付を入れていて重複を感じているので front matter の運用自体を変更するかもしれない．

このポスト書くの主に以下の２つの理由で非常に時間がかかった．

  • 書き始めたら脳内が整理され，検証が不十分な点が見えてきて再調査
  • 簡潔でわかりやすい説明や順序を推敲

続けていくと良い訓練になりそう．

← Back to home