[FEATURE] Preserve Workspace Folder Structure on 'export'
まだ誰も着手していません。
評価
調査の方向性
まず src/fabric_cli/parsers/fab_fs_parser.py のエクスポート引数の処理から始め、次に src/fabric_cli/client/fab_api_folders.py、fab_api_workspace.py、fab_api_item.py のフォルダー、ワークスペースアイテム、アイテム定義のクライアントを読みます。--preserve-folders がアイテムのフォルダーパスを再現し、デフォルトのエクスポートはルートレベルのアイテムを含めてフラットなままになれば、作業は完了です。
索引モデルが issue の本文から書いたものです。
説明
Use Case / Problem
Problem Statement
I'm exporting a Fabric workspace to my local filesystem for backup and version control. My workspace uses folders to organize items logically—by feature, department, or data source—but the current export functionality strips away this structure entirely.
Current Limitation
The export command flattens the folder hierarchy. When I export an item located at MyWorkspace/Sales Reports/Q1_Report.Report, it creates Q1_Report.Report/ directly in the output directory, completely discarding the Sales Reports/ parent folder. This eliminates the organizational context that's critical for understanding the project.
Impact on Workflow
This limitation breaks DevOps and GitOps practices. In code-managed Fabric environments, folder structure isn't just organizational—it's fundamental to the project architecture. Without it, I can't:
- Navigate locally: The flat structure makes it nearly impossible to find items quickly or understand relationships between assets.
- Conduct meaningful code reviews: Git diffs lose context when the logical grouping disappears, making it harder for teams to review changes effectively.
- Automate deployments: Re-importing assets while preserving the intended workspace organization becomes manual and error-prone.
Requested Enhancement
Preserve the full folder hierarchy during workspace export. If an item exists at MyWorkspace/Sales Reports/Q1_Report.Report, the export should create Sales Reports/Q1_Report.Report/ in the output directory, maintaining the complete path structure.
This would enable seamless integration with modern development workflows and make Fabric workspaces truly manageable as code.
Proposed Solution
Specific commands or functionality:
Extend the existing export command with a --preserve-folders flag to maintain the workspace's folder hierarchy during export.
fab export <workspace_name> -o <output_path> --preserve-folders
Expected behavior and output:
With the --preserve-folders flag enabled, the export command replicates the complete folder structure from the Fabric workspace to the local filesystem.
Example:
Starting with this workspace structure in Fabric:
/MyWorkspace.Workspace/
├── Reports/
│ └── Sales_Report.Report
└── Notebooks/
└── Data_Processing.Notebook
Current Behavior (fab export MyWorkspace.Workspace -o ./local_export --all):
./local_export/
├── Sales_Report.Report/
│ └── ... (item files)
└── Data_Processing.Notebook/
└── ... (item files)
All items export to a flat structure, losing the original folder organization.
Expected Behavior (fab export MyWorkspace.Workspace -o ./local_export --all --preserve-folders):
./local_export/
├── Reports/
│ └── Sales_Report.Report/
│ └── ... (item files)
└── Notebooks/
└── Data_Processing.Notebook/
└── ... (item files)
The original folder hierarchy is preserved, making it easier to understand project organization.
Integration with existing fabric-cli features:
This enhancement naturally extends the export command and strengthens the CLI's filesystem metaphor established by commands like ls, cd, and mkdir. It also sets the foundation for a complementary import enhancement that could automatically recreate folder structures in target workspaces, enabling true round-trip workflows.
Alternatives Considered
No response
Impact Assessment
- This would help me personally
- This would help my team/organization
- This would help the broader fabric-cli community
- This aligns with Microsoft Fabric roadmap items
Implementation Attestation
- I understand this feature should maintain backward compatibility with existing commands
- I confirm this feature request does not introduce performance regressions for existing workflows
- I acknowledge that new features must follow fabric-cli's established patterns and conventions
Implementation Notes
- Relevant Fabric REST APIs:
This feature can be efficiently implemented using three core APIs that minimize the number of calls needed:
-
GET /v1/workspaces/{workspaceId}/folders?recursive=True: Found insrc/fabric_cli/client/fab_api_folders.py, this single call retrieves the entire folder hierarchy for a workspace—no recursiveGET /folders/{folderId}calls required. The response includes each folder'sid,displayName, andparentFolderId. -
GET /v1/workspaces/{workspaceId}/items: This API (infab_api_workspace.py) returns a flat list of all workspace items. The critical property isfolderId, which links each item to its parent folder in the hierarchy. Root-level items won't have afolderId. -
POST /v1/workspaces/{workspaceId}/items/{itemId}/getDefinition: The existing API used by theexportcommand (fab_api_item.py) to fetch an item's actual definition content. This part of the logic would remain unchanged.
-
Command Structure or Argument Patterns:
A new optional flag should be added to the
exportcommand insrc/fabric_cli/parsers/fab_fs_parser.py. A good name would be--preserve-folders. -
Compatibility Concerns:
To ensure backward compatibility, this new behavior should only be triggered when the
--preserve-foldersflag is present. The default behavior of theexportcommand (flattening the directory structure) should remain unchanged to avoid breaking existing user scripts and workflows.
- 主要言語
- Python
- スター
- 174
- フォーク
- 64
- 平均マージ
- 6日 38分
- マージ済み PR(30日)
- 5
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
microsoft/fabric-cli のほかの issue
-
[FEATURE] Loosen strict dependency pins to improve compatibility with newer `fabric-cicd` versions再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープンai:feature-triage:unable-to-process enhancement
難易度 1/5 1時間未満 初心者へのやさしさ 70/100
microsoft/fabric-cli#294 · コメント 2 件 · リアクション 1 件 ·
-
[BUG] bulk-export errors with "[NotSupported] Only supported for Lakehouse/Files"再び着手できるかも @rksharma-owg が 41 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンai:bug-triage:unable-to-process bug
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
microsoft/fabric-cli#287 · コメント 2 件 ·
-
ai:feature-triage:unable-to-process enhancement
難易度 3/5 1〜2日 初心者へのやさしさ 64/100
microsoft/fabric-cli#292 · コメント 1 件 ·
-
ai:question-triage:unable-to-process question
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
microsoft/fabric-cli#288 · コメント 2 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 52/100
microsoft/fabric-cli#286 · コメント 3 件 ·
microsoft/fabric-cli の issue をすべて見る
似ている issue
-
難易度 1/5 1〜3時間 初心者へのやさしさ 85/100
WLAN-Pi/wlanpi-profiler#341 ·
メンテナーはふだん 1 日以内に返信
-
Memory leak: the shared `validation_aborted_error` keeps every traceback it is raised through対応中かも @Fire162 が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
graphql-python/graphql-core#287 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
roman-corgi/ctc-dip#160 ·
メンテナーはふだん 1 日以内に返信
-
type-bug
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
render_findings.py reads and writes in the host's default encoding, so findings.html breaks on a cp1252 Windows host対応中かも @Aaqibhafeezkhan が今日担当しました。 オープンbug good first issue mentored python size: XS up-for-grabs
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
dheerajjha/mcp-migrate#366 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信