Merge pull request #252 from nullvariant/feat/tilde-compression-ssh-key-path

feat: compress file picker SSH key paths to ~/ format

Author: nullvariant

extensions/git-id-switcher/CHANGELOG.md

@@ -7,6 +7,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.16.8] - 2026-01-31
+
+### Changed
+
+- **SSH key file picker now stores paths in `~/` format instead of absolute paths**:
+  - Selecting a key via the 📁 browse button now produces `~/.ssh/id_ed25519` instead of `/Users/name/.ssh/id_ed25519`
+  - Improves privacy (no OS username in settings.json) and portability across machines
+  - Works on both Unix and Windows (backslashes normalized to forward slashes)
+  - Extracted shared `replaceHomeWithTilde()` utility to `pathUtils.ts`, removing duplicate from `pathSanitizer.ts`
+
+### Documentation
+
+- **Updated Japanese README for identity management UI**:
+  - Added "Profile Management UI" as first item in Features section
+  - Rewrote Quick Start Step 3 from settings.json-first to UI-first approach
+  - Added new "Profile Management" section (add/edit/delete/reorder/SSH key path)
+  - Added Delete Identity command to Commands table
+  - Removed "Note: Basic Setup (No SSH)" section
+
 ## [0.16.7] - 2026-01-30
 
 ### Fixed

extensions/git-id-switcher/docs/i18n/ja/README.md

@@ -40,11 +40,12 @@ Gitプロフィール切り替えツールは数多く存在しますが、**Git
 
 ## 機能
 
+- **プロフィール管理UI**: settings.jsonを編集せずに、プロフィールの追加・編集・削除・並べ替えが可能
+- **ワンクリックでプロフィール切り替え**: Git user.nameとuser.emailを瞬時に変更
+- **ステータスバー統合**: 現在のプロフィールを常に一目で確認
 - **サブモジュール対応**: Gitサブモジュールにも自動的にプロフィールを伝播
 - **SSH鍵管理**: ssh-agentのSSH鍵を自動的に切り替え
 - **GPG署名対応**: コミット署名用のGPG鍵を設定（オプション）
-- **ワンクリックでプロフィール切り替え**: Git user.nameとuser.emailを瞬時に変更
-- **ステータスバー統合**: 現在のプロフィールを常に一目で確認
 - **リッチなツールチップ**: 説明やSSHホストを含む詳細なプロフィール情報
 - **クロスプラットフォーム**: macOS、Linux、Windowsで動作
 - **多言語対応**: 17言語をサポート
@@ -103,36 +104,28 @@ Host github-work
 
 ### ステップ 3: 拡張機能を設定
 
-拡張機能の設定を開き（`Cmd+,` / `Ctrl+,`）→「Git ID Switcher」を検索 →「settings.jsonで編集」をクリック：
+インストール直後はサンプルプロフィールが用意されています。これを自分用に編集しましょう。
 
-```json
-{
-  "gitIdSwitcher.identities": [
-    {
-      "id": "personal",
-      "icon": "🏠",
-      "name": "高橋カオル",
-      "service": "GitHub",
-      "email": "kaoru@personal.example.com",
-      "description": "個人プロジェクト",
-      "sshKeyPath": "~/.ssh/id_ed25519_personal"
-    },
-    {
-      "id": "work",
-      "icon": "💼",
-      "name": "高橋カオル",
-      "service": "GitHub 会社用",
-      "email": "kaoru.takahashi@company.example.com",
-      "description": "会社の開発用",
-      "sshKeyPath": "~/.ssh/id_ed25519_work",
-      "sshHost": "github-work"
-    }
-  ],
-  "gitIdSwitcher.defaultIdentity": "personal",
-  "gitIdSwitcher.autoSwitchSshKey": true,
-  "gitIdSwitcher.applyToSubmodules": true
-}
-```
+1. ステータスバー（右下）のプロフィールアイコンをクリック
+2. 一覧下部の「プロフィール管理」を選択
+3. サンプルプロフィールの「✏️」をクリックして編集
+4. ID・名前・メールアドレスを自分の情報に変更
+5. 「SSH Key Path」を選択し、📁ボタンでSSH秘密鍵を参照選択（パスが自動入力される）
+6. SSHホスト・その他のオプション項目も必要に応じて設定
+
+<img src="https://assets.nullvariant.com/nullvariant-vscode-extensions/extensions/git-id-switcher/images/management-ui-ja.png" width="600" alt="プロフィール管理UI">
+
+<img src="https://assets.nullvariant.com/nullvariant-vscode-extensions/extensions/git-id-switcher/images/ssh-key-browse-ja.png" width="600" alt="SSH鍵パス参照ボタン">
+
+> **鍵ファイルは送信されません**: この操作で記録されるのは鍵ファイルのパス（場所）だけです。鍵ファイルの中身がアップロードされたり外部に送信されることはありません。
+
+2つ目のプロフィールは「＋」ボタンから新規追加してください。
+
+> **ヒント**: settings.jsonから直接設定することもできます。
+> 拡張機能の設定を開き（`Cmd+,` / `Ctrl+,`）→「Git ID Switcher」を検索 →「settings.jsonで編集」をクリック。
+> JSON形式での設定例は「[フル設定例](#フル設定例-4アカウントとssh--gpg)」を参照してください。
+
+SSH鍵パスの詳細な設定手順・プロフィールの編集・削除・並び替えについては「[プロフィール管理](#プロフィール管理)」を参照してください。
 
 ### ステップ 4: 使ってみる
 
@@ -286,6 +279,76 @@ Host bitbucket.org
 
 ---
 
+## プロフィール管理
+
+ステータスバーをクリック → 一覧下部の「プロフィール管理」で管理画面を開きます。
+プロフィールの追加・編集・削除・並び替えはすべてUIから直接操作できます。
+
+<img src="https://assets.nullvariant.com/nullvariant-vscode-extensions/extensions/git-id-switcher/images/management-ui-overview-ja.png" width="600" alt="プロフィール管理画面">
+
+### プロフィールの追加
+
+1. 管理画面の「＋」ボタンをクリック
+2. 各フィールドを入力:
+   - **ID** (必須): 一意の識別子（例: `personal`, `work`）
+   - **名前** (必須): Git user.name
+   - **メール** (必須): Git user.email
+   - その他のオプション項目（アイコン、サービス名、説明、SSH鍵パス、SSHホスト、GPG鍵ID）
+3. 「保存」を選択
+
+保存後、編集画面に遷移するので、オプション項目も続けて設定できます。
+
+### プロフィールの編集
+
+1. 管理画面で対象プロフィールの「✏️」をクリック
+2. 編集したいフィールドを選択
+3. 新しい値を入力
+
+フィールドを保存すると編集画面に戻るので、他のフィールドも続けて編集できます。
+
+> **注意**: プロフィールIDは、プロフィールが1件のみの場合に限り変更可能です。
+> 2件以上の場合は参照整合性のためロックされます。
+
+### プロフィールの削除
+
+1. 管理画面で対象プロフィールの「🗑️」をクリック
+2. 確認ダイアログで「はい」を選択
+
+コマンドパレットから `Git ID Switcher: Delete Identity` でも実行できます。
+
+### プロフィールの並び替え
+
+管理画面で対象プロフィールの「⬆」「⬇」をクリックして順序を変更できます。
+この順序はsettings.json内の配列順と連動します。
+
+### SSH鍵パスの設定
+
+SSH鍵パスの入力は、この拡張機能の設定で最も手間のかかる項目です。
+管理UIにはファイル参照機能が組み込まれており、パスを手入力する必要がありません。
+
+1. プロフィールの編集画面で「SSH Key Path」を選択
+2. 入力欄の右側に「📁」（Browse for SSH key path...）ボタンが表示される
+3. ボタンをクリックすると、OSのファイルダイアログが `~/.ssh/` を初期表示して開く
+4. 使用したいSSH秘密鍵ファイルを選択（例: `id_ed25519_work`）
+5. 選択したファイルのパスが `~/.ssh/...` 形式で入力欄に自動入力される
+6. パスのバリデーションが即座に実行される
+
+<img src="https://assets.nullvariant.com/nullvariant-vscode-extensions/extensions/git-id-switcher/images/ssh-key-dialog-ja.png" width="600" alt="SSH鍵ファイルダイアログ">
+
+<img src="https://assets.nullvariant.com/nullvariant-vscode-extensions/extensions/git-id-switcher/images/ssh-key-autofill-ja.png" width="600" alt="SSH鍵パス自動入力後">
+
+> **鍵ファイルは送信されません**: この操作は鍵ファイルのパス（場所）を記録するだけです。鍵ファイルの中身がアップロードされたり外部に送信されることはありません。
+
+**パス入力のポイント:**
+
+- 📁ボタンで参照するのが最も確実（タイプミスの心配なし）
+- 手入力も可能（`~/.ssh/id_ed25519_work` のように `~` で始まるパスも使用可）
+- セキュリティ上、`~/.ssh/` ディレクトリ配下のファイルのみ指定可能
+
+> **ヒント**: SSH鍵ファイルが `~/.ssh/` にない場合は、先にファイルを移動またはシンボリックリンクを作成してください。
+
+---
+
 ## 設定リファレンス
 
 ### プロフィールのプロパティ
@@ -342,33 +405,6 @@ Host bitbucket.org
 | `false`                | `高橋カオル`           | `高橋カオル <email>`    |
 | `true`                 | `👤 高橋カオル`        | `👤 高橋カオル <email>` |
 
-### 補足: 基本設定のみ（SSHなし）
-
-SSH鍵切り替えが不要な場合（単一のGitHubアカウントで異なるコミット者情報を使い分けるなど）、最小構成で利用できます：
-
-```json
-{
-  "gitIdSwitcher.identities": [
-    {
-      "id": "personal",
-      "icon": "🏠",
-      "name": "高橋カオル",
-      "email": "kaoru@personal.example.com",
-      "description": "個人プロジェクト"
-    },
-    {
-      "id": "work",
-      "icon": "💼",
-      "name": "高橋カオル",
-      "email": "kaoru.takahashi@company.example.com",
-      "description": "会社の開発用"
-    }
-  ]
-}
-```
-
-この設定では`git config user.name`と`user.email`のみを切り替えます。
-
 ---
 
 ## 仕組み
@@ -582,6 +618,7 @@ VS Codeなどのエディタは設定スキーマをメモリにキャッシュ
 | コマンド                                 | 説明                         |
 | ---------------------------------------- | ---------------------------- |
 | `Git ID Switcher: Select Identity`       | プロフィールピッカーを開く   |
+| `Git ID Switcher: Delete Identity`       | プロフィールを削除           |
 | `Git ID Switcher: Show Current Identity` | 現在のプロフィール情報を表示 |
 | `Git ID Switcher: Show Documentation`    | ドキュメントを表示           |
 

extensions/git-id-switcher/package.json

@@ -2,7 +2,7 @@
   "name": "git-id-switcher",
   "displayName": "%extension.displayName%",
   "description": "%extension.description%",
-  "version": "0.16.7",
+  "version": "0.16.8",
   "publisher": "nullvariant",
   "icon": "images/icon.png",
   "engines": {

extensions/git-id-switcher/src/security/pathSanitizer.ts

@@ -10,6 +10,7 @@
 import * as path from 'node:path';
 import { PATH_MAX, MAX_PATTERN_CHECK_LENGTH } from '../core/constants';
 import { CONTROL_CHAR_REGEX_ALL } from '../validators/common';
+import { replaceHomeWithTilde } from './pathUtils';
 
 /**
  * Platform-specific sensitive directory patterns
@@ -217,23 +218,6 @@ function tryRedactUncPath(normalizedPath: string): string | null {
   return null;
 }
 
-/**
- * Replace home directory with ~ for privacy.
- *
- * @internal
- */
-function replaceHomeWithTilde(normalizedPath: string, home: string): string | null {
-  if (!home) {
-    return null;
-  }
-  const normalizedHome = home.replaceAll('\\', '/');
-  // SECURITY: Ensure we match at path component boundary
-  if (normalizedPath === normalizedHome || normalizedPath.startsWith(normalizedHome + '/')) {
-    return '~' + normalizedPath.slice(normalizedHome.length);
-  }
-  return null;
-}
-
 /**
  * Sanitize path for logging (don't expose full path structure)
  *

extensions/git-id-switcher/src/security/pathUtils.ts

@@ -499,3 +499,35 @@ export function isUnderSshDirectory(value: string): boolean {
 
   return normalizedValue.startsWith(sshDirWithSep);
 }
+
+/**
+ * Replace home directory prefix with ~ for privacy and portability.
+ *
+ * Normalizes path separators to forward slashes so the result is always
+ * in `~/...` form regardless of platform. Returns null if the path is
+ * not under the home directory.
+ *
+ * @param absolutePath - Absolute path (may contain backslashes on Windows)
+ * @param homeDir - Home directory path
+ * @returns Path with ~ prefix, or null if not under home directory
+ *
+ * @example
+ * replaceHomeWithTilde('/Users/me/.ssh/key', '/Users/me')   // '~/.ssh/key'
+ * replaceHomeWithTilde('C:\\Users\\me\\.ssh\\key', 'C:\\Users\\me') // '~/.ssh/key'
+ * replaceHomeWithTilde('/other/path', '/Users/me')           // null
+ */
+export function replaceHomeWithTilde(absolutePath: string, homeDir: string): string | null {
+  if (!homeDir) {
+    return null;
+  }
+  const normalizedPath = absolutePath.replaceAll('\\', '/');
+  const normalizedHome = homeDir.replaceAll('\\', '/');
+  // SECURITY: Ensure we match at path component boundary
+  if (normalizedPath === normalizedHome) {
+    return '~';
+  }
+  if (normalizedPath.startsWith(normalizedHome + '/')) {
+    return '~' + normalizedPath.slice(normalizedHome.length);
+  }
+  return null;
+}

extensions/git-id-switcher/src/test/e2e/identityManager.test.ts

@@ -2556,7 +2556,7 @@ describe('identityManager E2E Test Suite', function () {
     });
 
     describe('File selection updates InputBox value', () => {
-      it('should update InputBox value after file selection', async () => {
+      it('should update InputBox value after file selection (Unix)', async () => {
         // Save original env
         const originalHome = process.env.HOME;
         process.env.HOME = '/home/testuser';
@@ -2598,12 +2598,68 @@ describe('identityManager E2E Test Suite', function () {
 
         try {
           await showEditProfileFlow(TEST_IDENTITIES.work);
-          assert.strictEqual(inputBoxValueAfterFilePick, '/home/testuser/.ssh/selected_key',
-            'InputBox value should be updated to selected file path');
+          assert.strictEqual(inputBoxValueAfterFilePick, '~/.ssh/selected_key',
+            'InputBox value should be updated to selected file path with ~ prefix');
         } finally {
           process.env.HOME = originalHome;
         }
       });
+
+      it('should normalize Windows backslashes to forward slashes after tilde compression', async () => {
+        // Save original env
+        const originalHome = process.env.HOME;
+        const originalUserProfile = process.env.USERPROFILE;
+
+        // Simulate Windows environment
+        delete process.env.HOME;
+        process.env.USERPROFILE = 'C:\\Users\\testuser';
+
+        let inputBoxValueAfterFilePick: string | undefined;
+
+        const mockVSCode = createMockVSCode({
+          identities: [TEST_IDENTITIES.work],
+          quickPickSelections: [
+            { field: 'sshKeyPath' },
+            undefined,
+          ],
+          inputBoxSelections: [FILE_PICKER_CLICK, undefined],
+          showOpenDialogResult: 'C:\\Users\\testuser\\.ssh\\selected_key',
+        });
+
+        const originalCreateInputBox = mockVSCode.window.createInputBox;
+        mockVSCode.window.createInputBox = () => {
+          const inputBox = originalCreateInputBox();
+          const originalValueSetter = Object.getOwnPropertyDescriptor(inputBox, 'value')?.set;
+          let internalValue = '';
+
+          Object.defineProperty(inputBox, 'value', {
+            get: () => internalValue,
+            set: (v: string) => {
+              internalValue = v;
+              inputBoxValueAfterFilePick = v;
+              if (originalValueSetter) {
+                originalValueSetter.call(inputBox, v);
+              }
+            },
+          });
+          return inputBox;
+        };
+
+        _setMockVSCode(mockVSCode as never);
+
+        try {
+          await showEditProfileFlow(TEST_IDENTITIES.work);
+          assert.strictEqual(inputBoxValueAfterFilePick, '~/.ssh/selected_key',
+            'Windows backslashes should be normalized to forward slashes after ~ compression');
+        } finally {
+          if (originalHome !== undefined) {
+            process.env.HOME = originalHome;
+          }
+          if (originalUserProfile !== undefined) {
+            process.env.USERPROFILE = originalUserProfile;
+          }
+        }
+      });
     });
 
     describe('Validation after file selection', () => {