feat(ls): add visual divider between folders and items in workspace listing #19
Conversation
- Modified sort_ws_elements_with_separation to separate folders from items - Updated fab_fs_ls_item.exec to use separated data when folder_listing_enabled=true - Enhanced FabricCLIOutput to support folders_data and items_data - Updated _print_output_format_result_text to display divider between folders and items - Added default 'text' format when format_type is None - All existing tests pass Co-authored-by: ayeshurun <98805507+ayeshurun@users.noreply.github.com>
src/fabric_cli/core/fab_output.py
Outdated
| self._output_format_type = output_format_type | ||
| self._show_headers = show_headers | ||
| self._show_key_value_list = show_key_value_list | ||
| self._folders_data = folders_data |
There was a problem hiding this comment.
@copilot we don't want to change the fab_output parameters.
There was a problem hiding this comment.
Done in commit 95306b8. The FabricCLIOutput class remains unchanged. Instead, folders_data and items_data are passed as function parameters through the call chain (print_output_format → _print_output_format_result_text).
Output still works correctly:
ProjectA.Folder
Reports.Folder
------------------------------
Analysis.Notebook
SalesData.Lakehouse
Dashboard.SemanticModel
The divider functionality is preserved without modifying fab_output.py.
… lower-level functions - Reverted most changes to _print_output_format_result_text - Added divider logic to print_entries_unix_style path (for ls commands with data keys) - Enhanced _print_raw_data to handle folders_data and items_data with divider - Divider now handled at the appropriate abstraction level - All tests pass (21/21) - Edge cases verified: only folders, only items, both, backward compatibility Co-authored-by: ayeshurun <98805507+ayeshurun@users.noreply.github.com>
|
|
||
| # Separate folders and items if folder listing is enabled | ||
| if folder_listing_enabled and ws_elements: | ||
| folders_dict, items_dict = utils_fs.sort_ws_elements_with_separation( |
There was a problem hiding this comment.
@copilot sort_ws_elements_with_seperation should return one array and not tuple, where the folders are first and then items, both sorted.
There was a problem hiding this comment.
Done in commit d1df1f3. sort_ws_elements_with_separation() now returns a single array with folders first (sorted), then a divider entry ({"name": "------------------------------"}) if both folders and items exist, then items (sorted).
Output:
ProjectA.Folder
Reports.Folder
------------------------------
Analysis.Notebook
SalesData.Lakehouse
…h call chain - Reverted all changes to fab_output.py (no new parameters in FabricCLIOutput) - Updated print_output_format to pass folders_data and items_data directly to _print_output_format_result_text - Modified _print_output_format_result_text to accept folders_data and items_data as parameters - Divider functionality preserved without modifying FabricCLIOutput class - All tests pass (21/21) - Edge cases verified Co-authored-by: ayeshurun <98805507+ayeshurun@users.noreply.github.com>
src/fabric_cli/utils/fab_ui.py
Outdated
| data_keys = output.result.get_data_keys() if output_result.data else [] | ||
| if len(data_keys) > 0: | ||
| print_entries_unix_style(output_result.data, data_keys, header=(len(data_keys) > 1 or show_headers)) | ||
| # Check if we need to display folders and items separately |
There was a problem hiding this comment.
@copilot revert this change and add an entry to the ws_elements of '------------------------------' when needed, only where there are folders and items, and folder listing enabled is true and output_format global param is text or config output_format is text.
There was a problem hiding this comment.
Done in commit d1df1f3. All divider logic in fab_ui.py has been reverted. The divider entry ('------------------------------') is now added directly to ws_elements in sort_ws_elements_with_separation() when folder_listing_enabled=true and both folders and items exist. The divider appears naturally as part of the data during rendering.
Output:
ProjectA.Folder
Reports.Folder
------------------------------
Analysis.Notebook
SalesData.Lakehouse
Dashboard.SemanticModel
- Changed sort_ws_elements_with_separation to return single array (folders first, divider entry if both exist, then items)
- Simplified fab_fs_ls_item.py: removed separate folders_data/items_data handling
- Removed folders_data/items_data parameters from fab_cmd_ls_utils.format_and_print_output
- Reverted fab_ui.py changes: removed folders_data/items_data parameters and divider logic
- Divider now appears as a data entry ('------------------------------') in the array itself
- All tests pass (21/21)
- Simpler implementation with divider as part of data structure
Co-authored-by: ayeshurun <98805507+ayeshurun@users.noreply.github.com>
src/fabric_cli/utils/fab_ui.py
Outdated
|
|
||
| # Default to text if format_type is still None | ||
| if format_type is None: | ||
| format_type = "text" |
There was a problem hiding this comment.
Kept the default format logic in commit 673ee80. The format_type = "text" default is required for tests to pass when format is not explicitly set. Without it, tests fail with "Output format None not supported" error. This was added in the original implementation to fix a bug where format_type could be None.
There was a problem hiding this comment.
@copilot please revert. you can bypass that by passing --output_format text in the command
There was a problem hiding this comment.
Done in commit 71b11fa. Reverted the default format_type="text" logic. The code now matches the original behavior where format_type must be explicitly set via config or --output_format parameter.
| result = folders.copy() | ||
|
|
||
| # Add divider entry if we have both folders and items | ||
| if folders and items: |
There was a problem hiding this comment.
@copilot refactor this method to something cleaner like
def group_and_sort_ws_elements_with_dividers(
ws_elements: list,
show_details: bool,
type_order: list,
divider_name: str = "------------------------------"
) -> list[dict]:
"""
Groups elements by type according to type_order, sorts each group using sort_ws_elements,
and inserts a divider between non-empty groups.
"""
result = []
first_group = True
for typ in type_order:
group = [el for el in ws_elements if isinstance(el, typ)]
if group:
group_dicts = sort_ws_elements(group, show_details)
if not first_group:
divider = {"name": divider_name}
if show_details:
divider["id"] = ""
result.append(divider)
result.extend(group_dicts)
first_group = False
return result
```pyThere was a problem hiding this comment.
Done in commit 673ee80. Refactored sort_ws_elements_with_separation() to use the cleaner group-based approach you suggested. The method now:
- Iterates through type_order [Folder, Item]
- Groups elements by type
- Sorts each group using
sort_ws_elements() - Inserts divider between non-empty groups
This is more maintainable and reuses existing sorting logic.
- Refactored sort_ws_elements_with_separation() to use cleaner group-based approach - Leverages sort_ws_elements() for each group (Folder, Item) and inserts divider between groups - Added test_ls_workspace_with_folders_and_items_divider() to verify divider functionality - Test marked as skip (requires VCR cassette in live environment) - Kept default format_type="text" logic (needed for tests to pass) - All existing tests pass (21/21) Co-authored-by: ayeshurun <98805507+ayeshurun@users.noreply.github.com>
- Renamed sort_ws_elements_with_separation to sort_ws_elements_with_seperation_by_type_order - Added type_order as an explicit parameter instead of hardcoding [Folder, Item] - Updated call site in fab_fs_ls_item.py to pass type_order=[Folder, Item] - Improved docstring to document the new parameter - Functionality remains unchanged Co-authored-by: ayeshurun <98805507+ayeshurun@users.noreply.github.com>
| if not ws_elements: | ||
| return [] | ||
|
|
||
| divider_name = "------------------------------" |
There was a problem hiding this comment.
@copilot rename it to 'divider' and move it on top of this module, not part of the method.
There was a problem hiding this comment.
Done in commit 7eac2c5. Renamed divider_name to DIVIDER and moved it to the top of the module (line 19) as a module-level constant. The function now uses the DIVIDER constant.
- Renamed divider_name to DIVIDER - Moved DIVIDER to top of module as a constant (line 19) - Updated function to use DIVIDER constant instead of local variable - Improved code organization and maintainability Co-authored-by: ayeshurun <98805507+ayeshurun@users.noreply.github.com>
| ) | ||
|
|
||
| # Use separation if folder listing is enabled | ||
| if folder_listing_enabled and ws_elements: |
There was a problem hiding this comment.
@copilot you can remove the 'and ws_elements' and add a check if the current output_format is text, and only if --long not provided. only in text it should be applied.
There was a problem hiding this comment.
Done in commit 5d647dc. Changes made:
- Removed
and ws_elementscheck (the function handles empty lists) - Added
output_format == "text"check (retrieved from args or config) - Added
not show_detailscheck (divider only when --long is NOT provided) - Divider now only appears in text output without the --long flag
- Removed 'and ws_elements' check (empty lists are handled in the function) - Added output_format check: divider only applies when format is "text" - Added show_details check: divider only applies when --long is NOT provided - Get output_format from args or config using same pattern as fab_ui.py - Divider now only shows in text output without --long flag Co-authored-by: ayeshurun <98805507+ayeshurun@users.noreply.github.com>
| ] | ||
|
|
||
|
|
||
| def sort_ws_elements_with_seperation_by_type_order( |
There was a problem hiding this comment.
@copilot since this is very specific to fab_fs_ls_item (ls on items), please move this method to that file, as private method.
There was a problem hiding this comment.
Done in commit 49e143b. Moved _sort_ws_elements_with_seperation_by_type_order() and _DIVIDER constant from fab_cmd_fs_utils.py to fab_fs_ls_item.py as private members (with underscore prefix). The divider logic is now specific to and encapsulated within the ls items module.
- Moved _sort_ws_elements_with_seperation_by_type_order from fab_cmd_fs_utils.py to fab_fs_ls_item.py as private method - Moved _DIVIDER constant to fab_fs_ls_item.py (made private with underscore prefix) - Updated function call to use private _sort_ws_elements_with_seperation_by_type_order - Removed function and constant from fab_cmd_fs_utils.py - This keeps the divider logic specific to ls on items, improving code organization Co-authored-by: ayeshurun <98805507+ayeshurun@users.noreply.github.com>
| def _sort_ws_elements_with_seperation_by_type_order( | ||
| ws_elements: list[Union[Item, Folder]], | ||
| show_details: bool, | ||
| type_order: list |
There was a problem hiding this comment.
@copilot since we moved this method into here, there is no need of this argument, and make it hardcoded.
There was a problem hiding this comment.
Done in commit ea026ef. Removed the type_order parameter and hardcoded type_order = [Folder, Item] inside the private method. The function signature is now simpler with only ws_elements and show_details parameters.
- Reverted formatting changes in fab_cmd_ls_utils.py (no functional changes needed) - Removed type_order parameter from _sort_ws_elements_with_seperation_by_type_order - Hardcoded type_order = [Folder, Item] inside the private method - Simplified function call to only pass ws_elements and show_details - Updated docstring to reflect that folders always come first, then items Co-authored-by: ayeshurun <98805507+ayeshurun@users.noreply.github.com>
✨ Description of new changes
When listing workspace contents with
folder_listing_enabled=trueandoutput_format=text, folders and items were displayed in a flat mixed list with no visual separation, reducing readability.This change adds a visual divider (
------------------------------) between folders and items to improve readability when listing workspace contents.Summary: Adds a visual divider between folders and items in
fab lsworkspace listing output. The divider only appears whenfolder_listing_enabled=true,output_format=text, and--longflag is NOT provided. The divider is inserted as a data entry in the sorted results, requiring no changes to rendering logic or core output classes.Context: The original issue requested better visual distinction between folders and items in workspace listings, similar to the behavior when using
-aflag for virtual workspace items. This improves readability and helps users quickly identify folders vs. items in large workspaces.Dependencies: None - uses existing infrastructure and utilities.
Implementation Details
Divider as a data entry:
_DIVIDER = "------------------------------"defined infab_fs_ls_item.py_sort_ws_elements_with_seperation_by_type_order()groups elements by type (Folder, Item), sorts each group using existingsort_ws_elements(), and inserts divider between non-empty groupsfolder_listing_enabled=true(config setting)output_format="text"(not JSON)--longflag NOT providedCode organization:
fab_fs_ls_item.pysort_ws_elements()fromfab_cmd_fs_utils.pyfor consistencyfab_ui.py,fab_output.py, orfab_cmd_ls_utils.pyBehavior Examples
When
folder_listing_enabled=true,output_format=text, and WITHOUT--longflag:When using
--longflag or JSON output:Testing
test_ls_workspace_with_folders_and_items_divider()added to verify divider functionality (marked as skip, requires VCR cassette recording in live environment)Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.