microsoft/CSS-Exchange

[Work Item] Create a Shared Function(s) for displaying object in a common format to avoid lots of lines of code/code changes

Open

#1,773 建立於 2023年7月21日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)PowerShell (985 star) (234 fork)batch import
Work Itemgood first issue

描述

Describe the work Would like to move and create more functions similar to this:

https://github.com/microsoft/CSS-Exchange/blob/fc8b7ada30c101a5bda0d07c1ba66262d7d91356/Search/Troubleshoot-ModernSearch/Write/WriteHelpers.ps1

This will help the display of object a little bit better and avoid formatting issues like this:

image

Where adding a color code format to the object being displayed required multiple lines to be adjusted and if we add another attribute to the object that is longer, we have to then adjust all the lines as well to keep the same formatting.

貢獻者指南

技術棧
shell
領域
developer experience
議題類型
refactor
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
PowerShell scripting
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70
研究方向
Examine the linked file at https://github.com/microsoft/CSS Exchange/blob/fc8b7ada30c101a5bda0d07c1ba66262d7d91356/Search/Troubleshoot ModernSearch/Write/WriteHelpers.ps1 to understand the existing shared function pattern. Identify commonly used object display code throughout the repo that could be refactored into a reusable function. The goal is to reduce code duplication and formatting issues as described in the issue. No additional comments or PRs exist, so the first step is to analyze the function and propose a generalized version.