next2d-development-mcp 1.1.4 → 1.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/references/framework-specs.md +99 -68
  2. package/package.json +9 -9
package/dist/references/framework-specs.md CHANGED
@@ -513,9 +513,11 @@ src/config/
513
513
  └── routing.json # ルーティング設定
514
514
  ```
515
515
 
516
+ ---
517
+
516
518
  ## stage.json
517
519
 
518
- 表示領域（Stage）の設定を行うJSONファイルです。
520
+ 表示領域（Stage）の設定を行うJSONファイルです。アプリ起動時に一度だけ読み込まれ、Stageの初期パラメータとして使用されます。
519
521
 
520
522
  ```json
521
523
  {
@@ -534,22 +536,30 @@ src/config/
534
536
 
535
537
  | プロパティ | 型 | デフォルト | 説明 |
536
538
  |-----------|------|----------|------|
537
- | `width` | number | 240 | 表示領域の幅 |
538
- | `height` | number | 240 | 表示領域の高さ |
539
- | `fps` | number | 60 | 1秒間に何回描画するか（1〜60） |
540
- | `options` | object | null | オプション設定 |
539
+ | `width` | number | 240 | 表示領域の幅（ピクセル単位）。実際の描画キャンバスの基準幅として使用される |
540
+ | `height` | number | 240 | 表示領域の高さ（ピクセル単位）。実際の描画キャンバスの基準高さとして使用される |
541
+ | `fps` | number | 60 | 1秒間の描画回数。指定可能な範囲は 1〜60 |
542
+ | `options` | object | null | 追加オプション設定。省略可能 |
541
543
 
542
- ### options設定
544
+ ### options 設定
543
545
 
544
546
  | プロパティ | 型 | デフォルト | 説明 |
545
547
  |-----------|------|----------|------|
546
- | `fullScreen` | boolean | false | Stageで設定した幅と高さを超えて画面全体に描画 |
547
- | `tagId` | string | null | IDを指定すると、指定したIDのエレメント内で描画を行う |
548
- | `bgColor` | string | "transparent" | 背景色を16進数で指定。デフォルトは無色透明 |
548
+ | `fullScreen` | boolean | false | `true` にするとウィンドウ全体にStageを拡張して描画する。`false` の場合は `width`・`height` で指定したサイズで固定描画 |
549
+ | `tagId` | string \| null | null | 描画先とするHTML要素のID。指定したIDのエレメント内部にキャンバスが生成される。`null` の場合は `<body>` 直下に生成される |
550
+ | `bgColor` | string | "transparent" | 背景色を16進数カラーコードで指定（例: `"#1461A0"`）。`"transparent"` を指定すると透明になる |
551
+
552
+ > [!WARNING]
553
+ > `stage.json` で有効なプロパティは上記の `width`・`height`・`fps`・`options` のみです。
554
+ > `align`・`scaleMode` などステージ表示に関わる設定であっても、`stage.json` には存在しないプロパティです。
555
+ > これらの設定が必要な場合は `config.json` に記述してください。
556
+ > 上記以外のプロパティを記述しても、フレームワークは一切処理しません。
557
+
558
+ ---
549
559
 
550
560
  ## config.json
551
561
 
552
- 環境ごとの設定を管理するファイルです。`local`、`dev`、`stg`、`prd`、`all`と区切られており、`all`以外は任意の環境名です。
562
+ 環境ごとの設定を管理するファイルです。ビルド時に `--env` オプションで指定した環境名のオブジェクトと `all` オブジェクトがマージされ、アプリケーション全体で参照可能な設定として展開されます。
553
563
 
554
564
  ```json
555
565
  {
@@ -584,20 +594,68 @@ src/config/
584
594
  }
585
595
  ```
586
596
 
587
- ### all設定
597
+ ### 環境キーの仕様
598
+
599
+ `local`・`dev`・`stg`・`prd` などのキー名は任意です（`all` を除く）。ビルド時に `--env=<環境名>` で一致したキーのオブジェクトが読み込まれます。
600
+
601
+ | キー | 説明 |
602
+ |------|------|
603
+ | `all` | すべての環境で共通して読み込まれる設定 |
604
+ | それ以外 | `--env` で指定した環境名と一致したときのみ読み込まれる設定 |
605
+
606
+ ### all 設定（フレームワーク予約済みプロパティ）
588
607
 
589
- `all`はどの環境でも書き出される共通変数です。
608
+ 以下のプロパティはフレームワークが自動的に処理します。
590
609
 
591
610
  | プロパティ | 型 | デフォルト | 説明 |
592
611
  |-----------|------|----------|------|
593
- | `spa` | boolean | true | Single Page ApplicationとしてURLでシーンを制御 |
594
- | `defaultTop` | string | "top" | ページトップのView。設定がない場合はTopViewクラスが起動 |
595
- | `loading.callback` | string | Loading | ローディング画面のクラス名。start関数とend関数を呼び出す |
596
- | `gotoView.callback` | string \| array | ["callback.Background"] | gotoView完了後のコールバッククラス |
612
+ | `spa` | boolean | true | `true` にするとSingle Page Applicationとして動作し、ブラウザのURLと連動してView遷移を管理する |
613
+ | `defaultTop` | string | "top" | アプリ起動時に最初に表示するViewの名前。指定しない場合は `TopView` クラスが起動する |
614
+ | `loading.callback` | string | "Loading" | ローディング画面として使用するクラス名。そのクラスの `start()` と `end()` が自動的に呼び出される |
615
+ | `gotoView.callback` | string \| string[] | — | View遷移完了後に呼び出すコールバッククラス名。配列で複数指定でき、async/awaitで順次実行される |
597
616
 
598
- ### platform設定
617
+ ### ユーザー定義プロパティ
599
618
 
600
- ビルド時の`--platform`で指定した値がセットされます。
619
+ フレームワークの予約済みプロパティ以外に、任意のプロパティをどの環境キーにも追加できます。追加したプロパティはビルド後に `config` オブジェクトから参照できます。
620
+
621
+ エンドポイントURLや機能フラグ、表示設定など、環境ごとに変える必要がある値をここで管理します。
622
+
623
+ ```json
624
+ {
625
+ "local": {
626
+ "api": {
627
+ "endPoint": "http://localhost:3000/"
628
+ }
629
+ },
630
+ "prd": {
631
+ "api": {
632
+ "endPoint": "https://api.example.com/"
633
+ }
634
+ },
635
+ "all": {
636
+ "spa": true,
637
+ "defaultTop": "top",
638
+ "align": "TL",
639
+ "scaleMode": "noScale"
640
+ }
641
+ }
642
+ ```
643
+
644
+ ```typescript
645
+ import { config } from "@/config/Config";
646
+
647
+ // ユーザー定義プロパティへのアクセス
648
+ const align = config.align; // "TL"
649
+ const scaleMode = config.scaleMode; // "noScale"
650
+ ```
651
+
652
+ > [!WARNING]
653
+ > `config.json` でフレームワークが自動処理するプロパティは `spa`・`defaultTop`・`loading`・`gotoView` のみです。
654
+ > それ以外のプロパティはフレームワークが直接処理することはありませんが、`config` オブジェクト経由でアプリケーションコードから自由に参照できます。
655
+
656
+ ### platform 設定
657
+
658
+ ビルド時の `--platform` で指定した値が自動的にセットされます。設定ファイルに記述する必要はなく、読み取り専用です。
601
659
 
602
660
  対応値: `macos`, `windows`, `linux`, `ios`, `android`, `web`
603
661
 
@@ -609,6 +667,8 @@ if (config.platform === "ios") {
609
667
  }
610
668
  ```
611
669
 
670
+ ---
671
+
612
672
  ## routing.json
613
673
 
614
674
  ルーティングの設定ファイルです。詳細は[ルーティング](/ja/reference/framework/routing)を参照してください。
@@ -630,45 +690,13 @@ if (config.platform === "ios") {
630
690
  }
631
691
  ```
632
692
 
633
- ## 設定値の取得
634
-
635
- コード内で設定値を取得するには`config`オブジェクトを使用します。
636
-
637
- ### Config.tsの例
693
+ ---
638
694
 
639
- ```typescript
640
- import stageJson from "./stage.json";
641
- import configJson from "./config.json";
642
-
643
- interface IStageConfig {
644
- width: number;
645
- height: number;
646
- fps: number;
647
- options: {
648
- fullScreen: boolean;
649
- tagId: string | null;
650
- bgColor: string;
651
- };
652
- }
695
+ ## 設定値の取得
653
696
 
654
- interface IConfig {
655
- stage: IStageConfig;
656
- api: {
657
- endPoint: string;
658
- };
659
- content: {
660
- endPoint: string;
661
- };
662
- spa: boolean;
663
- defaultTop: string;
664
- platform: string;
665
- }
697
+ `Config.ts` は `npm start` 実行時に自動生成されるファイルです。手動で作成・編集する必要はありません。
666
698
 
667
- export const config: IConfig = {
668
- stage: stageJson,
669
- ...configJson
670
- };
671
- ```
699
+ コード内で設定値を取得するには、自動生成された `config` オブジェクトをインポートして使用します。
672
700
 
673
701
  ### 使用例
674
702
 
@@ -676,7 +704,7 @@ export const config: IConfig = {
676
704
  import { config } from "@/config/Config";
677
705
 
678
706
  // ステージ設定
679
- const stageWidth = config.stage.width;
707
+ const stageWidth = config.stage.width;
680
708
  const stageHeight = config.stage.height;
681
709
 
682
710
  // API設定
@@ -686,9 +714,11 @@ const apiEndPoint = config.api.endPoint;
686
714
  const isSpa = config.spa;
687
715
  ```
688
716
 
717
+ ---
718
+
689
719
  ## ローディング画面
690
720
 
691
- `loading.callback`で設定したクラスの`start`関数と`end`関数が呼び出されます。
721
+ `loading.callback` で設定したクラスの `start()` と `end()` が自動的に呼び出されます。
692
722
 
693
723
  ```typescript
694
724
  export class Loading
@@ -715,9 +745,11 @@ export class Loading
715
745
  }
716
746
  ```
717
747
 
718
- ## gotoViewコールバック
748
+ ---
749
+
750
+ ## gotoView コールバック
719
751
 
720
- `gotoView.callback`で設定したクラスの`execute`関数が呼び出されます。複数のクラスを配列で設定でき、async/awaitで順次実行されます。
752
+ `gotoView.callback` で設定したクラスの `execute()` が呼び出されます。配列で複数のクラスを指定でき、async/await で順次実行されます。
721
753
 
722
754
  ```typescript
723
755
  import { app } from "@next2d/framework";
@@ -744,6 +776,8 @@ export class Background
744
776
  }
745
777
  ```
746
778
 
779
+ ---
780
+
747
781
  ## ビルドコマンド
748
782
 
749
783
  環境を指定してビルド:
@@ -767,6 +801,8 @@ npm run build -- --platform=ios
767
801
  npm run build -- --platform=android
768
802
  ```
769
803
 
804
+ ---
805
+
770
806
  ## 設定例
771
807
 
772
808
  ### 完全な設定ファイルの例
@@ -822,11 +858,15 @@ npm run build -- --platform=android
822
858
  },
823
859
  "gotoView": {
824
860
  "callback": ["callback.Background"]
825
- }
861
+ },
862
+ "align": "TL",
863
+ "scaleMode": "noScale"
826
864
  }
827
865
  }
828
866
  ```
829
867
 
868
+ ---
869
+
830
870
  ## 関連項目
831
871
 
832
872
  - [ルーティング](/ja/reference/framework/routing)
@@ -1068,15 +1108,6 @@ export class HomeDataCallback
1068
1108
  - 引数を省略した場合は、現在のURLから遷移先が解決されます（SPAの`popstate`時）。
1069
1109
  - 遷移開始時に前回の`response`マップはクリアされます。
1070
1110
 
1071
- `gotoView`実行シーケンス（詳細）:
1072
-
1073
- 1. 前回遷移で保持していた`response`マップを初期化します。
1074
- 2. `name`または現在URLから遷移先ルートを解決し、クエリを分解します。
1075
- 3. `all.spa: true`かつ通常遷移時はHistory API（`pushState`）でURL履歴を更新します。
1076
- 4. 遷移先`requests`を実行し、`name`キー単位で`response`/`cache`へ格納します。
1077
- 5. `requests.callback`と`gotoView.callback`を順次実行します。
1078
- 6. 旧Viewの`onExit`/unbind後に新View/ViewModelをbindし、`initialize`完了後に`onEnter`を呼び出します。
1079
-
1080
1111
  ```typescript
1081
1112
  import { app } from "@next2d/framework";
1082
1113
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "next2d-development-mcp",
3
3
  "displayName": "Next2D Development MCP",
4
- "version": "1.1.4",
4
+ "version": "1.1.5",
5
5
  "description": "MCP server for Next2D application development assistance",
6
6
  "type": "module",
7
7
  "author": "Toshiyuki Ienaga <ienaga@next2d.app>",
@@ -52,19 +52,19 @@
52
52
  },
53
53
  "devDependencies": {
54
54
  "@eslint/js": "^10.0.1",
55
- "@types/node": "^25.5.2",
56
- "@types/vscode": "^1.110.0",
57
- "@typescript-eslint/eslint-plugin": "^8.58.0",
58
- "@typescript-eslint/parser": "^8.58.0",
59
- "@vscode/vsce": "^3.7.1",
55
+ "@types/node": "^25.6.0",
56
+ "@types/vscode": "^1.115.0",
57
+ "@typescript-eslint/eslint-plugin": "^8.58.2",
58
+ "@typescript-eslint/parser": "^8.58.2",
59
+ "@vscode/vsce": "^3.8.0",
60
60
  "eslint": "^10.2.0",
61
61
  "eslint-plugin-unused-imports": "^4.4.1",
62
- "globals": "^17.4.0",
62
+ "globals": "^17.5.0",
63
63
  "typescript": "^6.0.2",
64
- "vitest": "^4.1.2"
64
+ "vitest": "^4.1.4"
65
65
  },
66
66
  "engines": {
67
67
  "node": ">=22.0.0",
68
- "vscode": "^1.109.0"
68
+ "vscode": "^1.110.0"
69
69
  }
70
70
  }