軽量な祝日判定JSライブラリを作った
背景
日本の祝日を取得・判定したいことはしばしばあると思いますが、JavaScript の祝日関連ライブラリにはサイズが大きいものが多く、より軽量なものが欲しかったので実装しました。
軽量化のための工夫
2022 年以前のデータについては、思い切って省略しています（厳密には、判定はできるが正確ではない）
例えば、最近の祝日である日をカレンダーに反映したいだけの場合、高々前後 1 年だけ正確であれば十分と思われます。
また、年ごとの祝日をすべてベタ書きすることは避けています。
さらに、ロジックについても最小限にしています。結果として、現状 5KB 程度のサイズに収まっています。ただし、関数が少ないため、今後使い勝手の良い関数を増やす予定です。
アルゴリズム
以下の方法で祝日を計算しています。
- 固定の祝日を定数として定義
- 移動する祝日を計算する関数を定義（成人の日、春分の日など）
- 振替休日を計算する関数を定義
- 与えられた
yearに対し、1, 2, 3 の結果を結合し、返す
外部ライブラリを使っていないため、他言語でも容易に実装可能と思われます。
実装
GitHub で公開しています。
to-na/holiday-jp-since
インストール
npm i holiday-jp-since
or
bun install holiday-jp-since
使い方
import { getHolidaysOfYear, getHolidaysBetweenYears } from "holiday-jp-since";
// 2024年の祝日の一覧を返す
const hoildays2024 = getHolidaysOfYear(2024);
// 2024年から2099年までの祝日の一覧を返す
const holidays2024To2099 = getHolidaysBetweenYears(2024, 2099);
返り値のフォーマットは、
[{
holidayType: "fixed",
name: "元日",
year: 2024,
month: 1,
day: １,
}, ...]
のようにしています。
holidayType: "fixed" は年によらず固定の祝日であることを表しています。他にも、moving, furikae などがありますが、そもそもholidayType の使用頻度は多くないかもしれません。
また、特定の日付が祝日か判定したい場合、 isHoliday 関数が使えます。
import { isHoliday } from "holiday-jp-since";
const is20240101Holiday = isHoliday(2024, 1, 1); // => true
課題
祝日は変動することがあるため、何らかの方法で更新をかける必要があります。例えば、ケンオールが公開している祝日 APIを定期的に叩いて、差分があれば通知する GitHub Actions を作ると良いと思われます（祝日はそうそう変わらないので、動作確認が難しそうですが）
Discussion