Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 13 additions & 9 deletions README.ja.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
> **Public Beta お知らせ(2026年3月8日):** FlowMap は Public Beta 段階です。ライセンス検証は現在ローカル/開発用プレビューであり、本番向けサーバー側の強制検証は未実装です。

# FlowMap

> Swift コードの構造と呼び出し関係をグラフ分析するツールです。AI が生成したコード変更の検証に特に役立ちます。
Expand All @@ -6,8 +8,6 @@

[English](README.md) · [한국어](README.ko.md)

**ステータス: Public Beta**

## FlowMap とは

FlowMap は Swift コードを解析し、ファイル・型・関数・呼び出し関係をワークスペース全体のグラフとして構築し、VS Code 上で視覚的に探索できる開発者ツールです。
Expand Down Expand Up @@ -87,6 +87,9 @@ swift build -c release
cd ../..
```

> 注: リプレイ/シナリオ検証スクリプトは `parsers/swift-ast/.build/debug/flowmap-swift-ast` を参照します。
> これらを実行する場合は debug ビルドも一度必要です: `cd parsers/swift-ast && swift build -c debug`.

**4. VS Code 拡張をコンパイル**

```bash
Expand All @@ -104,6 +107,10 @@ cd ../..
4. コマンドパレットから **FlowMap: Analyze Workspace** を実行する(`Cmd+Shift+P`)
5. **FlowMap Graph** パネルを開く

### VSIX インストール版の実行

`.vsix` でインストールした場合は、`flowmap.binaryPath` にビルド済みエンジンのパス(例: `/path/to/FlowMap/target/debug/flowmap`)を設定してから **FlowMap: Analyze Workspace** を実行してください。

## 使い方

1. VS Code で Swift ワークスペースを開く
Expand Down Expand Up @@ -161,16 +168,13 @@ Public Beta 詳細検証(`reports/public-beta-validation-detail.md`):

## ライセンス

FlowMap は source-available モデルで提供されています
FlowMap は現在 **Public Beta** 段階です

**Swift サポート**
- 個人・非商用利用: 無料
- 商用 / チーム / 企業利用: ライセンスが必要
最終的なライセンス条件(商用条件を含む)は、ベータ終了後に告知します。

**他言語対応**
今後の追加言語サポートは、別売りの商用プラグインとして提供される可能性があります。
それまでは著者がすべての権利を保持し、Public Beta の評価目的での利用のみ許可されます。

商用ライセンスに関するお問い合わせは、こちらまでご連絡ください: adgk2349b@gmail.com
商用利用または再配布については: adgk2349b@gmail.com

## ロードマップ

Expand Down
22 changes: 13 additions & 9 deletions README.ko.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
> **퍼블릭 베타 공지 (2026년 3월 8일):** FlowMap은 퍼블릭 베타 단계입니다. 라이선스 검증은 현재 로컬/개발용 프리뷰이며, 프로덕션 서버 강제 검증은 아직 구현되지 않았습니다.

# FlowMap

> Swift 코드의 구조와 호출 관계를 그래프로 분석하는 도구입니다. AI가 생성한 코드 변경을 검증할 때 특히 유용합니다.
Expand All @@ -6,8 +8,6 @@

[English](README.md) · [日本語](README.ja.md)

**상태: Public Beta**

## FlowMap이란?

FlowMap은 Swift 코드를 파싱해 파일, 타입, 함수, 호출 관계를 워크스페이스 단위로 그래프화하고, VS Code에서 시각적으로 탐색할 수 있게 해주는 개발 도구입니다.
Expand Down Expand Up @@ -87,6 +87,9 @@ swift build -c release
cd ../..
```

> 참고: 리플레이/시나리오 검증 스크립트는 `parsers/swift-ast/.build/debug/flowmap-swift-ast` 경로를 사용합니다.
> 해당 스크립트를 실행할 경우 debug 빌드도 1회 필요합니다: `cd parsers/swift-ast && swift build -c debug`.

**4. VS Code 확장 컴파일**

```bash
Expand All @@ -104,6 +107,10 @@ cd ../..
4. 커맨드 팔레트에서 **FlowMap: Analyze Workspace**를 실행합니다 (`Cmd+Shift+P`)
5. **FlowMap Graph** 패널을 엽니다

### VSIX 설치 버전 실행

`.vsix`로 설치한 경우 `flowmap.binaryPath`를 빌드된 엔진 경로(예: `/path/to/FlowMap/target/debug/flowmap`)로 설정한 뒤 **FlowMap: Analyze Workspace**를 실행하세요.

## 사용 방법

1. VS Code에서 Swift 워크스페이스를 엽니다
Expand Down Expand Up @@ -161,16 +168,13 @@ node scripts/run_commit_replay.mjs \

## 라이선스

FlowMap은 source-available 방식으로 제공됩니다.
FlowMap은 현재 **퍼블릭 베타** 단계입니다.

**Swift 지원**
- 개인 및 비상업적 사용: 무료
- 상업적 / 팀 / 기업 사용: 라이선스 필요
최종 라이선스 조건(상업용 조건 포함)은 베타 종료 후 공지됩니다.

**추가 언어**
향후 추가 언어 지원은 별도 상용 플러그인 형태로 제공될 수 있습니다.
그 전까지는 작성자가 모든 권리를 보유하며, 퍼블릭 베타 평가 목적 사용만 허용됩니다.

상업용 라이선스 문의: adgk2349b@gmail.com
상업적 사용 또는 재배포 관련 문의: adgk2349b@gmail.com

## 로드맵

Expand Down
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
> **PUBLIC BETA NOTICE (March 8, 2026):** FlowMap is in public beta. Licensing is currently local/dev-only preview (no production server-side entitlement enforcement yet).

# FlowMap

> Swift code graph and impact analysis tool — understand and verify code structure, especially when reviewing AI-generated changes.
Expand All @@ -6,8 +8,6 @@

[한국어](README.ko.md) · [日本語](README.ja.md)

**Status: Public Beta**

## What is FlowMap?

FlowMap parses Swift code, builds a workspace-level graph of files, types, functions, and call relationships, and visualizes that graph inside VS Code.
Expand Down Expand Up @@ -87,6 +87,9 @@ swift build -c release
cd ../..
```

> Note: replay/scenario validation scripts look for the parser binary at `parsers/swift-ast/.build/debug/flowmap-swift-ast`.
> If you run those scripts, also build debug once: `cd parsers/swift-ast && swift build -c debug`.

**4. Compile the VS Code extension**

```bash
Expand All @@ -104,6 +107,10 @@ cd ../..
4. Run **FlowMap: Analyze Workspace** from the command palette (`Cmd+Shift+P`)
5. Open the **FlowMap Graph** panel

### Run from VSIX (installed extension)

If you install FlowMap via `.vsix`, set `flowmap.binaryPath` to your built engine binary path (for example: `/path/to/FlowMap/target/debug/flowmap`), then run **FlowMap: Analyze Workspace**.

## Usage

1. Open a Swift workspace in VS Code
Expand Down Expand Up @@ -161,16 +168,13 @@ Detailed public beta validation (`reports/public-beta-validation-detail.md`):

## License

FlowMap is source-available.
FlowMap is currently in **public beta**.

**Swift support**
- Personal and non-commercial use: free
- Commercial, team, or company use: a license is required
Final licensing terms (including commercial terms) will be announced after the beta period.

**Other languages**
Additional language support may be provided as separate commercial plugins in the future.
Until then, all rights are reserved by the author, except that evaluation use for the public beta is permitted.

For commercial licensing inquiries, contact: adgk2349b@gmail.com
For commercial use or redistribution, please contact: adgk2349b@gmail.com

## Roadmap

Expand Down
8 changes: 8 additions & 0 deletions editor/vscode/.vscodeignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Keep package minimal for release VSIX
**/*

!package.json
!LICENSE
!out/**
!webview/**
!node_modules/cytoscape/**
12 changes: 12 additions & 0 deletions editor/vscode/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Copyright (c) 2026 Seungmin Lee
All rights reserved.

FlowMap VS Code extension is currently distributed for public beta evaluation.

Until final licensing terms are announced after the public beta period:
- all rights are reserved by the author;
- evaluation use for the public beta is permitted;
- commercial use and redistribution require prior written permission.

For commercial use or redistribution inquiries:
adgk2349b@gmail.com
4 changes: 4 additions & 0 deletions editor/vscode/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
"displayName": "FlowMap",
"description": "Call-graph visualization for AI-generated Swift code",
"version": "0.1.0",
"repository": {
"type": "git",
"url": "https://github.com/adgk2349/FlowMap.git"
},
"engines": {
"vscode": "^1.85.0"
},
Expand Down
Loading
Loading