プロジェクト設定
[project]— プロジェクト定義name— プロジェクトの名前version— プロジェクトのバージョンauthors— プロジェクトの作者description— プロジェクトの説明license— プロジェクトのライセンスrepository— プロジェクトのリポジトリの URL
[build]— ビルド設定[format]— フォーマット設定[lint]— リント設定[test]— テスト設定[publish]— 公開設定[dependencies]— ライブラリの依存関係
[project] セクション
Veryl.toml の最初のセクションは [project] です。name と version は必須です。
name フィールド
プロジェクト名は生成されるコードのプレフィックスに使われます。そのためプロジェクト名はアルファベットか _ で始まり、英数字と_ しか使ってはいけません。
version フィールド
プロジェクトのバージョンは セマンティックバージョニングに従います。バージョンは以下の3つの数字からなります。
- メジャー – 互換性のない変更時に上げる
- マイナー – 互換性のある機能追加時に上げる
- バッチ – 互換性のあるバグ修正時に上げる
[project]
version = "0.1.0"
authors フィールド
オプションの authors フィールドにはこのプロジェクトの作者である人や組織を配列にリストアップします。配列内の各文字列のフォーマットは自由です。名前のみ、Eメールアドレスのみ、名前と括弧で囲んだEメールアドレスといった形式がよく使われます。
[project]
authors = ["Fnu Lnu", "anonymous@example.com", "Fnu Lnu <anonymous@example.com>"]
description フィールド
description はプロジェクトの短い説明です。マークダウンではなくプレーンテキスト形式で書きます。
license フィールド
license フィールドはこのプロジェクトがどのライセンスで公開されているかを指定します。指定する文字列はSPDX 2.3 license expressionに従ってください。
[project]
license = "MIT OR Apache-2.0"
repository フィールド
repository フィールドはプロジェクトのソースリポジトリへのURLです。
[project]
repository = "https://github.com/veryl-lang/veryl"
[build] セクション
[build] セクションはコード生成の設定です。詳細はこちら。
[format] セクション
[format] セクションはコードフォーマッターの設定です。詳細はこちら。
[lint] セクション
[lint] セクションはリンタの設定です。詳細はこちら。
[test] セクション
[test] セクションはRTLシミュレータによるテストの設定です。詳細はこちら。
[publish] セクション
[publish] セクションはプロジェクト公開の設定です。詳細はこちら。
[dependencies] セクション
[dependencies] セクションはライブラリの依存関係です。詳細はこちら。