enhance: ファイル実行の調整 (#748)

* execute file

* docs

* ignore main.ais

* fix doc

* changelog

.gitignore

@@ -7,6 +7,6 @@
 /src/parser/parser.js
 /src/parser/parser.mjs
 npm-debug.log
-test.is
+main.ais
 pnpm-lock.yaml
 tsdoc-metadata.json

docs/execution.md

@@ -0,0 +1,38 @@
+# 実行方法
+## 1. Playgroundから実行
+自分でホストする場合は、以下のコマンドを実行し表示されたリンクをブラウザで開きます。
+```
+cd playground
+npm run build
+npm run serve
+```
+
+PlaygroundはGitHubでもホストされています：\
+https://aiscript-dev.github.io/aiscript/
+
+## 2. スクリプトファイルから実行
+ファイルの内容を解析して実行します。
+
+プロジェクトルートに`main.ais`を作成し、以下の内容を記述しファイルに保存します。
+```
+<: "Hello world!"
+```
+
+以下のコマンドを実行します。
+```
+$ npm run start
+```
+
+## 3. スクリプトファイルを解析する (パーサーのデバッグ向け)
+ファイルの内容を解析してASTを表示することができます。
+主にパーサーのデバッグ向けで、インタプリタの実装状況に関わらずASTの内容を表示することができます。
+
+プロジェクトルートに`main.ais`を作成し、以下の内容を記述しファイルに保存します。
+```
+<: "Hello world!"
+```
+
+以下のコマンドを実行します。
+```
+$ npm run parse
+```

package.json

@@ -18,8 +18,8 @@
 		}
 	},
 	"scripts": {
-		"start": "node ./run",
-		"parse": "node ./parse",
+		"start": "node ./scripts/start.mjs",
+		"parse": "node ./scripts/parse.mjs",
 		"ts": "npm run ts-esm && npm run ts-dts",
 		"ts-esm": "tsc --outDir built/esm",
 		"ts-dts": "tsc --outDir built/dts --declaration true --emitDeclarationOnly true --declarationMap true",

parse.js → scripts/parse.mjs

@@ -2,6 +2,6 @@ import fs from 'fs';
 import { Parser } from '@syuilo/aiscript';
 import { inspect } from 'util';
 
-const script = fs.readFileSync('./test.is', 'utf8');
+const script = fs.readFileSync('./main.ais', 'utf8');
 const ast = Parser.parse(script);
 console.log(inspect(ast, { depth: 10 }));

run.js → scripts/start.mjs

@@ -39,7 +39,7 @@ const interpreter = new Interpreter({}, {
 	}
 });
 
-const script = fs.readFileSync('./test.is', 'utf8');
+const script = fs.readFileSync('./main.ais', 'utf8');
 try {
 	const ast = Parser.parse(script);
 	await interpreter.exec(ast);

unreleased/script-file.md

@@ -0,0 +1,2 @@
+- AiScriptのスクリプトファイルを表す拡張子が`.is`から`.ais`に変更されました。
+- ファイル実行機能により読み取られるファイルの名前が`test.is`から`main.ais`へ変更されました。