CLI

Purus CLIはPurusプロジェクトのコンパイル、実行、チェック、管理のためのコマンドを提供します。

クイックリファレンス

コマンド	説明
purus build [file|dir]	PurusファイルをJavaScriptにコンパイル
purus run [file|dir]	ファイルを生成せずにコンパイル＆実行
purus check [file|dir]	構文チェックのみ
purus new [name]	新しいプロジェクトを作成
purus init	現在のディレクトリでプロジェクトを初期化
purus version	バージョンを表示
purus help	ヘルプを表示

エイリアス: compile = build, create = new

コマンド

purus build / purus compile

PurusソースファイルをJavaScriptにコンパイルします。単一ファイル、ディレクトリ、設定ファイルベースのコンパイルに対応しています。

単一ファイル

purus build hello.purus
# 出力: hello.js

purus build app.cpurus
# 出力: app.cjs

purus build lib.mpurus
# 出力: lib.mjs

拡張子	出力	形式
.purus	.js	標準JavaScript
.cpurus	.cjs	CommonJSモジュール
.mpurus	.mjs	ESモジュール

ディレクトリ

ディレクトリ内のすべての .purus、.cpurus、.mpurus ファイルをコンパイルします。出力ディレクトリの構造はソースと同じになります。

# src/ 内のすべてのファイルを dist/ にコンパイル
purus build src

# 出力先ディレクトリを指定
purus build src --output build

# --entryフラグを使用
purus build --entry src
purus build -e src -o build

config.purusを使用

ファイルやディレクトリが指定されていない場合、カレントディレクトリまたは親ディレクトリから config.purus を読み込みます。

# config.purusのentryとoutputの設定を使用
purus build

詳細はconfig.purusを参照してください。

オプション

オプション	エイリアス	説明
--entry <file|dir>	-e	エントリファイルまたはディレクトリを指定
--output <dir>	-o	出力先ディレクトリを指定（config.purusより優先）
--no-header		// Generated by Purus ヘッダーコメントを省略
--stdout		コンパイル結果をファイルではなく標準出力に出力

ファイルやディレクトリは --entry の代わりに位置引数としても渡せます。

使用例

# ヘッダーコメントなしでコンパイル
purus build --no-header hello.purus

# コンパイル結果を標準出力に出力
purus build --stdout hello.purus

# ディレクトリを指定して出力先を変更
purus build src -o build

# --entryフラグを使用
purus build -e src -o build

# config.purusを使用し、出力先を上書き
purus build --output public/js

---

purus run

ファイルを生成せずにPurusファイルをコンパイルして実行します。テストや開発時に便利です。

単一ファイル

purus run hello.purus

ディレクトリ

ディレクトリ内のすべてのPurusファイルを実行:

purus run src

# --entryフラグを使用
purus run --entry src
purus run -e src

config.purusを使用

# config.purusのentry設定を使用
purus run

オプション

オプション	エイリアス	説明
--entry <file|dir>	-e	エントリファイルまたはディレクトリを指定

ファイルやディレクトリは --entry の代わりに位置引数としても渡せます。

---

purus check

コンパイルせずに構文チェックのみ行います。構文が正しければ OK: <file> と表示します。

単一ファイル

purus check hello.purus
# OK: hello.purus

ディレクトリ

ディレクトリ内のすべてのPurusファイルをチェック:

purus check src

# --entryフラグを使用
purus check --entry src
purus check -e src

config.purusを使用

# config.purusのentry設定を使用
purus check

オプション

オプション	エイリアス	説明
--entry <file|dir>	-e	エントリファイルまたはディレクトリを指定

ファイルやディレクトリは --entry の代わりに位置引数としても渡せます。

---

purus new / purus create

新しいPurusプロジェクトを対話形式で作成します。対象ディレクトリは存在しないか、空である必要があります。

# 対話形式で作成
purus new my-project

# すべてのプロンプトをスキップ
purus new my-project -y

生成されるファイル

ファイル	説明
src/main.purus	Hello Worldサンプル付きのエントリポイント
config.purus	ビルドとリンターの設定
.prettierrc	Purus用のPrettier設定
README.md	スクリプトリファレンス付きのREADME
.gitignore	Gitの無視ルール
package.json	スクリプト付きのnpmパッケージ

package.jsonスクリプト

スクリプト	コマンド	説明
purus	purus	purus CLIの実行
build	purus build	プロジェクトをコンパイル
compile	purus compile	プロジェクトをコンパイル（エイリアス）
exec	purus run	プロジェクトを実行
format	prettier --write ./src	ソースファイルをフォーマット
lint	purus-lint	ソースファイルをリント

オプションのdevDependencies

プロンプトで確認（または -y で自動インストール）:

• purus — コンパイラ
• @puruslang/linter — リンター
• @puruslang/prettier-plugin-purus — Prettierプラグイン
• prettier — コードフォーマッター

---

purus init

現在のディレクトリでPurusプロジェクトを初期化します。src/ と src/main.purus が存在しなければ作成します。

purus init

---

purus version

インストールされているPurusのバージョンを表示します。

purus version
# purus v0.4.0

エイリアス: purus --version, purus -v

---

purus help

すべてのコマンドを含むヘルプメッセージを表示します。

purus help

エイリアス: purus --help, purus -h

---

config.purus

プロジェクトルートに config.purus を配置して、ビルド・実行・リンターの設定を行います。ファイルはPurusの構文自体で記述します。

-- Purus Configuration

const entry be ///src///
const output be ///dist///
const header be true

-- Linter settings
const lint.no-var be ///warn///
const lint.no-nil be ///off///
const lint.indent-size be 2
const lint.max-line-length be ///off///
const lint.no-trailing-whitespace be ///warn///
const lint.no-unused-import be ///warn///
const lint.consistent-naming be ///off///

ビルド設定

キー	型	デフォルト	説明
entry	string	"src"	ソースディレクトリ
output	string	"dist"	出力先ディレクトリ
header	boolean	true	// Generated by Purus ヘッダーコメントを含める

リンター設定

キー	型	デフォルト	説明
lint.no-var	string	"warn"	var 使用時に "warn" または "error"
lint.no-nil	string	"off"	nil 使用時に "warn" または "error"
lint.indent-size	number	2	期待されるインデントサイズ
lint.max-line-length	string/number	"off"	最大行長（"off" で無効化）
lint.no-trailing-whitespace	string	"warn"	末尾の空白に "warn" または "error"
lint.no-unused-import	string	"warn"	未使用インポートに "warn" または "error"
lint.consistent-naming	string	"off"	命名規則チェックに "warn" または "error"

config.purusの使われ方

以下のコマンドはファイル引数がない場合、自動的に config.purus を読み込みます:

• purus build — entry、output、header 設定を使用
• purus run — entry 設定を使用
• purus check — entry 設定を使用
• purus-lint — lint.* 設定と entry によるファイル検出を使用

コマンドラインオプション（例: --output、--entry）は設定ファイルの値を上書きします。

---

プログラマティックAPI

PurusはNode.jsライブラリとしても使用できます。

const { compile, check, version } = require("purus");

compile(source, options?)

PurusソースコードをJavaScriptにコンパイルします。

const js = compile("const x be 42");
// => "// Generated by Purus 0.4.0\nconst x = 42;\n"

const js = compile("const x be 42", { header: false });
// => "const x = 42;\n"

オプション	型	デフォルト	説明
header	boolean	true	ヘッダーコメントを含める

check(source)

Purusソースコードの構文エラーをチェックします。有効であれば true を返し、エラーがあれば例外を投げます。

check("const x be 42");    // => true
check("const x be");        // throws Error

version

現在のPurusバージョン文字列です。

console.log(version);  // => "0.4.0"