naruse666 / pkl-sandbox

What is pkl?

Appleが開発した構成言語でCLIツール, ソフトウェアライブラリ, ビルドプラグインとして使用できる。
発音はpickle(ピックル).

「設定ファイルを生成する。」というイメージ？

Use case

静的構成の生成

json, yamlなどで構成されたサービスにおいて、冗長性の軽減, 再利用, テンプレート化, 抽象化が可能。

2024/2　時点ではJVMランタイム, Swift / Goのライブラリを提供している。

Concepts

抽象化

構成が時間の経過とともに複雑になり、維持と理解が大変になるのを軽減する

評価

構成を評価し、変換が正常に完了するとステータスコード0で終了。

不変性

pklデータは不変で、値を変えると元の値は変更されず新しい値が返ります。

分離

pklのコード評価はサンドボックス化されます。

レンダリング

以下の形式のレンダラーがある。
カスタムレンダラーの作成も可能。

• JSON
• Jsonnet
• Pcf (pklのサブセット)
• Properties (Java)
• Property List
• XML
• YAML

類似性

pklは生成される構成に構造的, 視覚的に似る傾向があるため読み書きが簡単になる。

再利用

モジュールはローカル/リモートからインポートできる。

スキーマ

デフォルト、型、制約を定義するクラスの表現が可能。
以下のような利点がある。

• ドキュメントの自動生成
• 開発時, 実行時の両方で構成を検証
• プログラミング言語から構成への型指定されたアクセス
• コード補完やエディターなどの開発ツール

テンプレート化

デフォルトのオーバーライドが可能でモジュールの共有で複雑なタスクを効率化

Comparison

json, yaml, xmlなどと比べて

• ネスト可能なコメント
• モジュールのインポート
• 全てのオブジェクトが他のオブジェクトのテンプレートとして機能できる
• スキーマ検証の強力なサポート
• コード補完のサポート

汎用言語と比べて

• 式指向で副作用がないため、潜在的なエラーの原因を排除
• 生成される構成に似ている
• スキーマ検証の強力なサポート
• サンドボックス化による安全性