Added Get-DiskSpace

Author: alan-null

Tests/Get-DiskSpace.Tests.ps1

@@ -0,0 +1,58 @@
+Import-Module .\WindowsDiskCleanup\WindowsDiskCleanup.psm1 -Force
+
+Describe 'Get-DiskSpace.Tests' {
+    BeforeAll {
+        Mock -CommandName Get-PSDrive -ModuleName WindowsDiskCleanup -MockWith {
+            return @{
+                Name = 'C'
+                Used = 50GB
+                Free = 100GB
+            }
+        }
+    }
+
+    It 'should return free space in GB by default' {
+        $result = Get-DiskSpace
+        $result | Should -Be 100
+    }
+
+    It 'should return total space in GB' {
+        $result = Get-DiskSpace -Name 'C' -SpaceType 'Total' -Unit 'GB'
+        $result | Should -Be 150
+    }
+
+    It 'should return used space in GB' {
+        $result = Get-DiskSpace -Name 'C' -SpaceType 'Used' -Unit 'GB'
+        $result | Should -Be 50
+    }
+
+    It 'should return free space in MB' {
+        $result = Get-DiskSpace -Name 'C' -SpaceType 'Free' -Unit 'MB'
+        $result | Should -Be (100 * 1024)
+    }
+
+    It 'should return total space in MB' {
+        $result = Get-DiskSpace -Name 'C' -SpaceType 'Total' -Unit 'MB'
+        $result | Should -Be (150 * 1024)
+    }
+
+    It 'should return used space in MB' {
+        $result = Get-DiskSpace -Name 'C' -SpaceType 'Used' -Unit 'MB'
+        $result | Should -Be (50 * 1024)
+    }
+
+    It 'should return free space in KB' {
+        $result = Get-DiskSpace -Name 'C' -SpaceType 'Free' -Unit 'KB'
+        $result | Should -Be (100 * 1024 * 1024)
+    }
+
+    It 'should return total space in KB' {
+        $result = Get-DiskSpace -Name 'C' -SpaceType 'Total' -Unit 'KB'
+        $result | Should -Be (150 * 1024 * 1024)
+    }
+
+    It 'should return used space in KB' {
+        $result = Get-DiskSpace -Name 'C' -SpaceType 'Used' -Unit 'KB'
+        $result | Should -Be (50 * 1024 * 1024)
+    }
+}

WindowsDiskCleanup/Public/Get-DiskSpace.ps1

@@ -0,0 +1,29 @@
+function Get-DiskSpace {
+    [CmdletBinding()]
+    param(
+        [char]$Name = "$env:HOMEDRIVE".TrimEnd(':'),
+
+        [ValidateSet("Free", "Total", "Used")]
+        [string]$SpaceType = "Free",
+
+        [ValidateSet("GB", "MB", "KB")]
+        [string]$Unit = "GB"
+    )
+
+    process {
+        $drive = Get-PSDrive -Name $Name
+        $space = switch ($SpaceType) {
+            "Free" { $drive.Free }
+            "Total" { $drive.Used + $drive.Free }
+            "Used" { $drive.Used }
+        }
+
+        switch ($Unit) {
+            "GB" { $space / 1GB }
+            "MB" { $space / 1MB }
+            "KB" { $space / 1KB }
+        }
+    }
+}
+
+Get-DiskSpace -SpaceType Free -Unit GB