Merge branch 'main' into new-title

Author: na-trium-144

.github/workflows/jseval-tests.yml

@@ -0,0 +1,20 @@
+name: jsEval Tests CI
+on:
+  pull_request:
+    paths:
+      - 'packages/jsEval/**'
+      - '.github/workflows/jseval-tests.yml'
+jobs:
+  test-js-eval:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [22.x]
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm test -w @my-code/js-eval

.github/workflows/node.js.yml

@@ -33,7 +33,7 @@ jobs:
     - run: npm ci
     - run: npm run tsc
 
-  test-js-eval:
+  check-docs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -45,4 +45,4 @@ jobs:
         node-version: ${{ matrix.node-version }}
         cache: 'npm'
     - run: npm ci
-    - run: npm test --workspace=packages/jsEval
+    - run: npm run checkDocs

.github/workflows/runtime-tests.yml

@@ -0,0 +1,20 @@
+name: Runtime Tests CI
+on:
+  pull_request:
+    paths:
+      - 'packages/runtime/**'
+      - '.github/workflows/runtime-tests.yml'
+jobs:
+  test-runtime:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [22.x]
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm test -w @my-code/runtime

.github/workflows/update-docs.yml

@@ -0,0 +1,37 @@
+name: Update Docs Revision And Database
+on:
+  push:
+    branches: [ "main" ]
+permissions:
+  contents: write
+jobs:
+  check-docs:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [22.x]
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npx drizzle-kit migrate
+      env:
+        DATABASE_URL: ${{ secrets.DATABASE_URL }}
+    - run: npx tsx ./scripts/checkDocs.ts --write
+      env:
+        DATABASE_URL: ${{ secrets.DATABASE_URL }}
+    - name: Configure git for push
+      run: |
+        git remote set-url origin "https://github-actions:${GITHUB_TOKEN}@github.com/${{ github.repository }}"
+        git config user.name  "github-actions[bot]"
+        git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    - name: Commit build output
+      run: |
+        git add .
+        git diff --staged --exit-code || (git commit -m "[ci] update revisions.yml" && git push origin main)
+        # The `||` ensures the commit and push only happen if there are changes (git diff exits with non-zero)

.gitignore

@@ -3,11 +3,9 @@
 /.open-next
 /cloudflare-env.d.ts
 
-# generated docs section file lists (regenerated by npm run generateSections)
-/public/docs/**/sections.yml
-
-# generated languages list (regenerated by npm run generateLanguages)
-/public/docs/languages.yml
+# generated docs section file lists (regenerated by npm run generateDocsMeta)
+/public/docs/**/sections.*
+/public/docs/languages.*
 
 # dependencies
 /node_modules
@@ -52,3 +50,4 @@ next-env.d.ts
 
 /public/typescript/
 /app/m-plus-rounded-1c-nohint/
+node_modules

Dockerfile

@@ -6,6 +6,7 @@ WORKDIR /app
 
 COPY package.json package-lock.json ./
 COPY packages/jsEval/package.json ./packages/jsEval/
+COPY packages/runtime/package.json ./packages/runtime/
 
 RUN --mount=type=cache,target=/root/.npm \
     npm ci --no-audit --no-fund
@@ -21,7 +22,8 @@ COPY --from=dependencies /app/node_modules ./node_modules
 # Copy application source code
 COPY . .
 
-ENV NODE_ENV=production
+# Stop if documentation has any change that is not reflected to revisions.yml and database.
+RUN npx tsx ./scripts/checkDocs.ts --check-diff
 
 # Next.js collects completely anonymous telemetry data about general usage.
 # Learn more here: https://nextjs.org/telemetry

README.md

@@ -18,6 +18,8 @@ npx prisma dev
 ルートディレクトリに .env または .env.local という名前のファイルを作成し、以下の内容を記述
 ```dotenv
 API_KEY=GeminiAPIキー
+OPENROUTER_API_KEY=OpenRouterAPIキー
+OPENROUTER_MODEL=foo;bar
 BETTER_AUTH_URL=http://localhost:3000
 DATABASE_URL="postgres://... (prisma devの出力)"
 GOOGLE_CLIENT_ID=
@@ -26,7 +28,9 @@ GITHUB_CLIENT_ID=
 GITHUB_CLIENT_SECRET=
 ```
 
-* `API_KEY` はGeminiのAPIキーを作成して設定します。未設定の場合チャットが使えません
+* チャット用にGeminiのAPIキーまたはOpenRouterのAPIキーのいずれかが必要です。未設定の場合チャットが使えません
+    * OpenRouterを使う場合は使用するモデルをセミコロン区切りで `OPENROUTER_MODEL` に設定してください (エラー時に2番目以降にフォールバックします)
+    * 両方設定されている場合はOpenRouterが使われます
 * `GITHUB_CLIENT_ID` `GITHUB_CLIENT_SECRET` はGitHub OAuthのクライアントIDとシークレットを設定します。未設定の場合「GitHubでログイン」が使えません。
 作り方については https://www.better-auth.com/docs/authentication/github を参照
 * `GOOGLE_CLIENT_ID` `GOOGLE_CLIENT_SECRET` はGoogle OAuthのクライアントIDとシークレットを設定します。未設定の場合「Googleでログイン」が使えません。
@@ -54,8 +58,10 @@ npm run lint
 ```
 でコードをチェックします。出てくるwarningやerrorはできるだけ直しましょう。
 
+### データベースのスキーマ
+
 * データベースのスキーマ(./app/schema/hoge.ts)を編集した場合、 `npx drizzle-kit generate` でmigrationファイルを作成し、 `npx drizzle-kit migrate` でデータベースに反映します。
-    * また、mainにマージする際に本番環境のデータベースにもmigrateをする必要があります
+    * 本番環境のデータベースのmigrateはmainにpushされた際にGitHub Actionで実行されます
 * スキーマのファイルを追加した場合は app/lib/drizzle.ts でimportを追加する必要があります(たぶん)
 * `npx prisma dev` で立ち上げたデータベースは `npx prisma dev ls` でデータベース名の確認・ `npx prisma dev rm default` で削除ができるらしい
 
@@ -72,6 +78,11 @@ Cloudflare Worker のビルドログとステータス表示が見れますが
 
 ## ドキュメント
 
+```bash
+npm run checkDocs
+```
+でドキュメントの読み込み時にエラーにならないか確認できます (index.ymlの間違いなど)
+
 * ドキュメントはセクション(見出し)ごとにわけ、 public/docs/言語id/ページid/並び替え用連番-セクション名.md に置く。
 * ページはディレクトリの名前によらず 言語id/index.yml に書かれている順で表示される。
 * セクションはセクションIDによらずファイル名順で表示される。
@@ -111,6 +122,8 @@ Cloudflare Worker のビルドログとステータス表示が見れますが
 * REPLのコード例は1セクションに最大1つまで。
     * コードエディターとコード実行ブロックはいくつでも置けます。
 * ページ0以外の各ページの最後はレベル2見出し「この章のまとめ」と、レベル3見出し「練習問題n」を置く
+* 編集したドキュメントにローカルの開発環境でアクセスする際は `npx tsx ./scripts/checkDocs.ts --write` でrevisions.ymlを更新してください。チャットを正しく動作させるために必要です。基本的には手動でこのファイルを編集する必要はありません。
+    * 本番環境ではドキュメントの変更がmainブランチにpushされた際に自動で更新されます。gitのコミットidを参照して更新するため、ローカルで更新したrevisions.ymlはpushしないでください。
 
 ### ベースとなるドキュメントの作り方
 
@@ -141,18 +154,17 @@ Cloudflare Worker のビルドログとステータス表示が見れますが
     - Canvasを使われた場合はやり直す。(Canvasはファイル名付きコードブロックで壊れる)
     - 太字がなぜか `**キーワード**` の代わりに `\*\*キーワード\*\*` となっている場合がある。 `\*\*` → `**` の置き換えで対応
     - 見出しの前に `-----` (水平線)が入る場合がある。my.code();は水平線の表示に対応しているが、消す方向で統一
-    - `言語名-repl` にはページ内で一意なIDを追加する (例: `言語名-repl:1`)
     - REPLの出力部分に書かれたコメントは消えるので修正する
         - ダメな例
         ````
-        ```js-repl:1
+        ```js-repl
         > console.log("Hello")
         Hello  // 文字列を表示する
         ```
         ````
         - 以下のようにすればok
         ````
-        ```js-repl:1
+        ```js-repl
         > console.log("Hello")  // 文字列を表示する
         Hello
 
@@ -162,10 +174,11 @@ Cloudflare Worker のビルドログとステータス表示が見れますが
         ```
         ````
     - 練習問題のファイル名は不都合がなければ `practice(章番号)_(問題番号).拡張子` で統一。空でもよいのでファイルコードブロックとexecコードブロックを置く
-- 1章にはたぶん練習問題要らない。
 
 ## markdown仕様
 
+実行環境の説明は ./packages/runtime/README.md を参照
+
 ````
 ```言語名-repl
 >>> コマンド
@@ -174,10 +187,7 @@ Cloudflare Worker のビルドログとステータス表示が見れますが
 ````
 
 でターミナルを埋め込む。
-* ターミナル表示部は app/terminal/terminal.tsx
-* コマンド入力処理は app/terminal/repl.tsx
-* 各言語の実行環境は app/terminal/言語名/ 内に書く。
-* 実行結果はSectionContextにも送られ、section.tsxからアクセスできる
+* 実行結果はEmbedContextにも送られ、チャットフォームが参照できる
 
 ````
 ```言語名:ファイル名
@@ -186,13 +196,12 @@ Cloudflare Worker のビルドログとステータス表示が見れますが
 ````
 
 でテキストエディターを埋め込む。
-* app/terminal/editor.tsx
-* editor.tsx内で `import "ace-builds/src-min-noconflict/mode-言語名";` を追加すればその言語に対応した色付けがされる。
+* app/terminal/editor.tsx内で `import "ace-builds/src-min-noconflict/mode-言語名";` を追加し、packages/runtime/src/languages.tsにも追加すればその言語に対応した色付けがされる。
     * importできる言語の一覧は https://github.com/ajaxorg/ace-builds/tree/master/src-noconflict
 * 編集した内容は app/terminal/file.tsx のFileContextで管理される。
     * 編集中のコードはFileContextに即時送られる
     * FileContextが書き換えられたら即時すべてのエディターに反映される
-* 編集したファイルの一覧はSectionContextにも送られ、section.tsxからアクセスできる
+* 編集したファイルの一覧はEmbedContextにも送られ、チャットフォームが参照できる
 
 ````
 ```言語名-readonly:ファイル名
@@ -210,8 +219,7 @@ Cloudflare Worker のビルドログとステータス表示が見れますが
 
 で実行ボタンを表示する
 * 実行ボタンを押した際にFileContextからファイルを読み、実行し、結果を表示する
-* app/terminal/exec.tsx に各言語ごとの実装を書く (それぞれ app/terminal/言語名/ 内に定義した関数を呼び出す)
-* 実行結果はSectionContextにも送られ、section.tsxからアクセスできる
+* 実行結果はEmbedContextにも送られ、チャットフォームが参照できる
 
 
 ## 技術スタック・ドキュメント・メモ