fastfsc/phwriter-metadata.ps1 at main · phellams/fastfsc · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# COMMON params
$source = "https://gitlab.com/phellams/fastfsc/-/blob/main/readme.md"
$phwriter_metadata_array = @(
    @{
        #CustomLogo  = $CustomLogo
        commandinfo = @{
            cmdlet      = "Get-FolderSizeFast";
            synopsis    = "Get-FolderSizeFast [-Path <String>] [-Recurse] [-Detailed] [-Format <String>] [-Help]";
            description = "This cmdlet calculates the size of a folder quickly by leveraging .NET methods. It supports recursion, progress display, and can output results in various formats including JSON and XML.";
            source      = ""
        }
        paramtable  = @(
            @{
                name        = "Path"
                param       = "p|Path"
                type        = "string"
                required    = $true
                description = "Specifies the path of the folder to calculate its size. Wildcards are supported."
                inline      = $false # Description on a new line
            },
            @{
                name        = "Detailed"
                param       = "d|Detailed"
                type        = "switch"
                required    = $false
                description = "Outputs detailed information about each file and folder processed."
                inline      = $false
            },
            @{
                name        = "format"
                param       = "f|Format"
                type        = "string"
                required    = $false
                description = "Specifies the output format. Supported formats are 'json' and 'xml'."
                inline      = $false
            }
            @{
                name        = "Help"
                param       = "h|Help"
                type        = "switch"
                required    = $false
                description = "Displays help information for the cmdlet."
                inline      = $false
            }
        )
        examples    = @(
            "Get-FolderSizeFast -Path 'C:\MyFolder' -Detailed",
            "Get-FolderSizeFast -Path 'C:\MyFolder' -format json",
            "Get-FolderSizeFast -Path 'C:\MyFolder' -format xml"
        )
    },
    @{
        commandinfo = @{
            cmdlet      = "Get-FolderSizeParallel";
            synopsis    = "Get-FolderSizeParallel [-Path <String>] [-Detailed] [-Format <String>] [-Help]";
            description = "This cmdlet calculates the size of a folder using parallel processing to enhance performance. It supports recursion, progress display, and can output results in various formats including JSON and XML.";
            source      = ""
        }
        paramtable  = @(
            @{
                name        = "Path"
                param       = "p|Path"
                type        = "string"
                required    = $true
                description = "Specifies the path of the folder to calculate its size. Wildcards are supported."
                inline      = $false # Description on a new line
            },
            @{
                name        = "format"
                param       = "f|Format"
                type        = "string"
                required    = $false
                description = "Specifies the output format. Supported formats are 'json' and 'xml'."
                inline      = $false
            }
        )
        examples    = @(
            "Get-FolderSizeParallel -Path 'C:\MyFolder'",
            "Get-FolderSizeParallel -Path 'C:\MyFolder' -format json",
            "Get-FolderSizeParallel -Path 'C:\MyFolder' -format xml"
        )
    }
    @{
        commandinfo = @{
            cmdlet      = "Request-FolderReport";
            synopsis    = "Requst-FolderReport [-Path <String>] [-Format <String>] [-Help]";
            description = "This cmdlet generates a report of the size of a folder and can output results in various formats including JSON and XML.";
            source      = ""
        }
        paramtable  = @(
            @{
                name        = "Path"
                param       = "p|Path"
                type        = "string"
                required    = $true
                description = "Specifies the path of the folder to calculate its size. Wildcards are supported."
                inline      = $false # Description on a new line
            },
            @{
                name        = "Detailed"
                param       = "d|Detailed"
                type        = "switch"
                required    = $false
                description = "Outputs detailed information about each file and folder processed."
                inline      = $false
            },
            @{
                name        = "format"
                param       = "f|Format"
                type        = "string"
                required    = $false
                description = "Specifies the output format. Supported formats are 'json' and 'xml'."
                inline      = $false
            }
        )
        examples    = @(
            "Request-FolderReport -Path C:\Users\User\Desktop\* -Format xml",
            "Request-FolderReport -Path C:\Users\User\Desktop\* -Format json",
            "Request-FolderReport -Path C:\Users\User\Desktop\*"
        )
    }
)