Bump version

Allow import Excel to take packages not just paths

AddConditionalFormatting.ps1

@@ -185,7 +185,7 @@
             $Address = "$($Address.Row):$($Address.Row)"
     }
     elseif ($Address -is [OfficeOpenXml.ExcelColumn]) {
-        $Address = [OfficeOpenXml.ExcelAddress]::new(1,$address.ColumnMin,1,$address.ColumnMax).Address -replace '1',''
+        $Address = (New-Object 'OfficeOpenXml.ExcelAddress' @(1, $address.ColumnMin, 1, $address.ColumnMax).Address) -replace '1',''
         if ($Address -notmatch ':') {$Address = "$Address`:$Address"}
     }
     if ( $Address -is [string] -and $Address -match "!") {$Address = $Address -replace '^.*!',''}

DoTests.ps1

@@ -10,7 +10,7 @@ $PSVersionTable.PSVersion
 
 ## Create the zip before the tests run
 ## Otherwise the EPPlus.dll is in use after the Pester run
-$ModuleVersion = (Get-Content -Raw .\ImportExcel.psd1)  | Invoke-Expression | ForEach-Object ModuleVersion
+$ModuleVersion = (Invoke-Command -ScriptBlock ([scriptblock]::Create((Get-Content -Raw .\ImportExcel.psd1)))).moduleVersion
 
 if (!$DontCreateZip) {
     $dest = "ImportExcel-{0}-{1}.zip" -f $ModuleVersion, (Get-Date).ToString("yyyyMMddHHmmss")

Examples/InteractWithOtherModules/Pester/Analyze_that.ps1

@@ -0,0 +1,26 @@
+param(
+    $PesterTestsPath = "$PSScriptRoot\..\..\..\__tests__\"
+)
+
+$xlfile = "$env:Temp\testResults.xlsx"
+Remove-Item $xlfile -ErrorAction SilentlyContinue
+
+$xlparams = @{
+    Path              = $xlfile
+    InputObject       = (Invoke-Pester -Script $PesterTestsPath -PassThru).TestResult | Sort-Object describe
+    WorksheetName     = 'FullResults'
+
+    IncludePivotTable = $true
+    PivotRows         = 'Describe'
+    PivotColumns      = 'Passed'
+    PivotData         = @{'Passed' = 'Count' }
+
+    IncludePivotChart = $true
+    ChartType         = 'BarClustered'
+
+    AutoSize          = $true
+    AutoFilter        = $true
+    Activate          = $true
+}
+
+Export-Excel -Show @xlparams

Examples/InteractWithOtherModules/ScriptAnalyzer/Analyze_this.ps1

@@ -0,0 +1,62 @@
+<#
+  .Synopsis
+    Runs PsScriptAnalyzer against one or more folders and pivots the results to form a report.
+
+  .Example
+    Analyze_this.ps1
+    Invokes script analyzer on the current directory; creates a file in $env:temp and opens it in Excel
+  .Example
+    Analyze_this.ps1 -xlfile ..\mymodule.xlsx -quiet
+    Invokes script analyzer on the current directory; creates a file in the parent directory but does not open it
+  .Example
+    "." , (dir 'C:\Program Files\WindowsPowerShell\Modules\ImportExcel\') | .\examples\ScriptAnalyzer\Analyze_this.ps1
+    run from a developemnt directory for importExcel it will produce a report for that directory compared against installed versions
+    this creates the file in the default location and opens it
+#>
+[CmdletBinding()]
+param (
+    [parameter(ValueFromPipeline = $true)]
+    $Path          = $PWD,
+    $xlfile        = "$env:TEMP\ScriptAnalyzer.xlsx",
+    $ChartType     = 'BarClustered' ,
+    $PivotColumns  = 'Location',
+    [switch]$Quiet
+)
+
+begin {
+    Remove-Item -Path $xlfile -ErrorAction SilentlyContinue
+    $xlparams = @{
+        Path           = $xlfile
+        WorksheetName  = 'FullResults'
+        AutoSize       = $true
+        AutoFilter     = $true
+        Activate       = $true
+        Show           = (-not $Quiet)
+    }
+    $pivotParams = @{
+        PivotTableName = 'BreakDown'
+        PivotData      = @{RuleName = 'Count' }
+        PivotRows      = 'Severity', 'RuleName'
+        PivotColumns   = 'Location'
+        PivotTotals    = 'Rows'
+    }
+    $dirsToProcess     = @()
+}
+process {
+    if     ($path.fullName) {$dirsToProcess += $path.fullName}
+    elseif ($path.path)     {$dirsToProcess += $path.Path}
+    else                    {$dirsToProcess += $path}
+}
+
+end {
+    $pivotParams['-PivotChartDefinition'] = New-ExcelChartDefinition -ChartType $chartType -Column (1 + $dirsToProcess.Count) -Title "Script analysis" -LegendBold
+    $xlparams['PivotTableDefinition']     = New-PivotTableDefinition @pivotParams
+
+    $dirsToProcess | ForEach-Object {
+        $dirName = (Resolve-Path -Path $_) -replace "^.*\\(.*?)\\(.*?)$", '$1-$2'
+        Write-Progress -Activity "Running Script Analyzer" -CurrentOperation $dirName
+        Invoke-ScriptAnalyzer -Path $_ -ErrorAction SilentlyContinue |
+            Add-Member -MemberType NoteProperty -Name Location -Value $dirName -PassThru
+    }   |       Export-Excel @xlparams
+    Write-Progress -Activity "Running Script Analyzer" -Completed
+}

Export-Excel.ps1

@@ -84,9 +84,9 @@
         .PARAMETER RangeName
             Makes the data in the worksheet a named range.
         .PARAMETER TableName
-            Makes the data in the worksheet a table with a name, and applies a style to it. Name must not contain spaces.
+            Makes the data in the worksheet a table with a name, and applies a style to it. The name must not contain spaces. If a style is specified without a name, table1, table2 etc. will be used.
         .PARAMETER TableStyle
-            Selects the style for the named table - defaults to 'Medium6'.
+            Selects the style for the named table - if a name is specified without a style, 'Medium6' is used as a default.
         .PARAMETER BarChart
             Creates a "quick" bar chart using the first text column as labels and the first numeric column as values
         .PARAMETER ColumnChart
@@ -418,15 +418,15 @@
         .LINK
             https://github.com/dfinke/ImportExcel
     #>
-    [CmdletBinding(DefaultParameterSetName = 'Default')]
+    [CmdletBinding(DefaultParameterSetName = 'Now')]
     [OutputType([OfficeOpenXml.ExcelPackage])]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingPlainTextForPassword", "")]
     Param(
-        [Parameter(ParameterSetName = "Default", Position = 0)]
-        [Parameter(ParameterSetName = "Table"  , Position = 0)]
+
+        [Parameter(Mandatory = $true, ParameterSetName = "Path", Position = 0)]
         [String]$Path,
-        [Parameter(Mandatory = $true, ParameterSetName = "PackageDefault")]
-        [Parameter(Mandatory = $true, ParameterSetName = "PackageTable")]
+        [Parameter(Mandatory = $true, ParameterSetName = "Package")]
+
         [OfficeOpenXml.ExcelPackage]$ExcelPackage,
         [Parameter(ValueFromPipeline = $true)]
         [Alias('TargetData')]
@@ -462,8 +462,8 @@
         [Switch]$FreezeFirstColumn,
         [Switch]$FreezeTopRowFirstColumn,
         [Int[]]$FreezePane,
-        [Parameter(ParameterSetName = 'Default')]
-        [Parameter(ParameterSetName = 'PackageDefault')]
+
+
         [Switch]$AutoFilter,
         [Switch]$BoldTopRow,
         [Switch]$NoHeader,
@@ -478,11 +478,11 @@
                 elseif ($_[0] -notmatch '[a-z]') { throw 'Tablename starts with an invalid character.'  }
                 else { $true }
             })]
-        [Parameter(ParameterSetName = 'Table'        , Mandatory = $true, ValueFromPipelineByPropertyName)]
-        [Parameter(ParameterSetName = 'PackageTable' , Mandatory = $true, ValueFromPipelineByPropertyName)]
+
+
         [String]$TableName,
-        [Parameter(ParameterSetName = 'Table')]
-        [Parameter(ParameterSetName = 'PackageTable')]
+
+
         [OfficeOpenXml.Table.TableStyles]$TableStyle,
         [Switch]$Barchart,
         [Switch]$PieChart,
@@ -793,9 +793,12 @@
                     Add-ExcelName  -RangeName $targetRangeName -Range $ws.Cells[$targetRow, ($StartColumn + $c ), $LastRow, ($StartColumn + $c )]
                     try {#this test can throw with some names, surpress any error
                         if ([OfficeOpenXml.FormulaParsing.ExcelUtilities.ExcelAddressUtil]::IsValidAddress(($targetRangeName -replace '\W' , '_' ))) {
-                            Write-Warning "AutoNameRange: Property name '$targetRangeName' is also a valid Excel address and may cause issues. Consider renaming the property name."
+                            Write-Warning -Message "AutoNameRange: Property name '$targetRangeName' is also a valid Excel address and may cause issues. Consider renaming the property."
+                        }
+                    }
+                    Catch {
+                        Write-Warning -Message "AutoNameRange: Testing '$targetRangeName' caused an error. This should be harmless, but a change of property name may be needed.."
                     }
-                    } Catch {}
                 }
             }
             catch {Write-Warning -Message "Failed adding named ranges to worksheet '$WorksheetName': $_"  }
@@ -803,14 +806,17 @@
         #Empty string is not allowed as a name for ranges or tables.
         if ($RangeName) { Add-ExcelName  -Range $ws.Cells[$dataRange] -RangeName $RangeName}
 
+        #Allow table to be inserted by specifying Name, or Style or both; only process autoFilter if there is no table (they clash).
         if     ($TableName) {
             if ($PSBoundParameters.ContainsKey('TableStyle')) {
                   Add-ExcelTable -Range $ws.Cells[$dataRange] -TableName $TableName -TableStyle $TableStyle
             }
             else {Add-ExcelTable -Range $ws.Cells[$dataRange] -TableName $TableName}
         }
-
-        if ($AutoFilter) {
+        elseif ($PSBoundParameters.ContainsKey('TableStyle')) {
+                  Add-ExcelTable -Range $ws.Cells[$dataRange] -TableName "" -TableStyle $TableStyle
+        }
+        elseif ($AutoFilter) {
             try {
                 $ws.Cells[$dataRange].AutoFilter = $true
                 Write-Verbose -Message "Enabled autofilter. "
@@ -1235,7 +1241,7 @@ function Select-Worksheet {
     }
 }
 
-Function Add-ExcelName {
+function Add-ExcelName {
     <#
       .SYNOPSIS
         Adds a named-range to an existing Excel worksheet.
@@ -1299,9 +1305,8 @@ function Add-ExcelTable {
         #The range of cells to assign to a table.
         [Parameter(Mandatory=$true)]
         [OfficeOpenXml.ExcelRange]$Range,
-        #The name for the Table - this should be unqiue in the Workbook.
-        [Parameter(Mandatory=$true)]
-        [String]$TableName,
+        #The name for the Table - this should be unqiue in the Workbook - auto generated names will be used if this is left empty.
+        [String]$TableName = "",
         #The Style for the table, by default "Medium6" is used
         [OfficeOpenXml.Table.TableStyles]$TableStyle = 'Medium6',
         #By default the header row is shown - it can be turned off with -ShowHeader:$false.
@@ -1324,12 +1329,16 @@ function Add-ExcelTable {
         [Switch]$PassThru
     )
     try {
+        if ($TableName -eq "" -or $null -eq $TableName) {
+            $tbl = $Range.Worksheet.Tables.Add($Range, "")
+        }
+        else {
             if ([OfficeOpenXml.FormulaParsing.ExcelUtilities.ExcelAddressUtil]::IsValidAddress($TableName)) {
-            Write-Warning -Message "$tableName reads as an Excel address, and so is not allowed as a table name."
+                Write-Warning -Message "$TableName reads as an Excel address, and so is not allowed as a table name."
                 return
             }
-        if ($tableName -notMatch '^[A-Z]') {
-            Write-Warning -Message "$tableName is not allowed as a table name because it does not begin with a letter."
+            if ($TableName -notMatch '^[A-Z]') {
+                Write-Warning -Message "$TableName is not allowed as a table name because it does not begin with a letter."
                 return
             }
             if ($TableName -match "\W") {
@@ -1349,7 +1358,8 @@ function Add-ExcelTable {
             }
             else {
                 $tbl = $ws.Tables.Add($Range, $TableName)
-            Write-Verbose -Message "Defined table '$TableName' at $($Range.Address)"
+                Write-Verbose -Message "Defined table '$($tbl.Name)' at $($Range.Address)"
+            }
         }
         #it seems that show total changes some of the others, so the sequence matters.
         if     ($PSBoundParameters.ContainsKey('ShowHeader'))        {$tbl.ShowHeader        = [bool]$ShowHeader}
@@ -1358,7 +1368,7 @@ function Add-ExcelTable {
             foreach ($k in $TotalSettings.keys) {
                 if (-not $tbl.Columns[$k]) {Write-Warning -Message "Table does not have a Column '$k'."}
                 elseif ($TotalSettings[$k] -notin @("Average", "Count", "CountNums", "Max", "Min", "None", "StdDev", "Sum", "Var") ) {
-                    Write-wanring "'$($TotalSettings[$k])' is not a valid total function."
+                    Write-Warning -Message "'$($TotalSettings[$k])' is not a valid total function."
                 }
                 else {$tbl.Columns[$k].TotalsRowFunction = $TotalSettings[$k]}
             }

GetExcelTable.ps1

@@ -96,7 +96,7 @@ function ConvertFrom-ExcelColumnName {
     $sum
 }
 
-ipmo .\ImportExcel.psd1 -Force
+Import-Module .\ImportExcel.psd1 -Force
 
 #Get-ExcelTableName .\testTable.xlsx | Get-ExcelTable .\testTable.xlsx
 Get-ExcelTable .\testTable.xlsx Table3

Import-Html.ps1

@@ -10,7 +10,7 @@ function Import-Html {
     )
 
     $xlFile = [System.IO.Path]::GetTempFileName() -replace "tmp","xlsx"
-    rm $xlFile -ErrorAction Ignore
+    Remove-Item $xlFile -ErrorAction Ignore
 
     Write-Verbose "Exporting to Excel file $($xlFile)"
 

ImportExcel.psd1

@@ -4,7 +4,7 @@
     RootModule        = 'ImportExcel.psm1'
 
     # Version number of this module.
-    ModuleVersion     = '6.0.0'
+    ModuleVersion     = '6.1.0'
 
     # ID used to uniquely identify this module
     GUID              = '60dd4136-feff-401a-ba27-a84458c57ede'

ImportExcel.psm1

@@ -5,7 +5,7 @@ Add-Type -Path "$($PSScriptRoot)\EPPlus.dll"
 . $PSScriptRoot\Charting.ps1
 . $PSScriptRoot\ColorCompletion.ps1
 . $PSScriptRoot\ConvertExcelToImageFile.ps1
-. $PSScriptRoot\Compare-WorkSheet.ps1
+. $PSScriptRoot\compare-workSheet.ps1
 . $PSScriptRoot\ConvertFromExcelData.ps1
 . $PSScriptRoot\ConvertFromExcelToSQLInsert.ps1
 . $PSScriptRoot\ConvertToExcelXlsx.ps1
@@ -22,8 +22,8 @@ Add-Type -Path "$($PSScriptRoot)\EPPlus.dll"
 . $PSScriptRoot\Import-Html.ps1
 . $PSScriptRoot\InferData.ps1
 . $PSScriptRoot\Invoke-Sum.ps1
-. $PSScriptRoot\Join-WorkSheet.ps1
-. $PSScriptRoot\Merge-Worksheet.ps1
+. $PSScriptRoot\Join-Worksheet.ps1
+. $PSScriptRoot\Merge-worksheet.ps1
 . $PSScriptRoot\New-ConditionalFormattingIconSet.ps1
 . $PSScriptRoot\New-ConditionalText.ps1
 . $PSScriptRoot\New-ExcelChart.ps1
@@ -32,7 +32,7 @@ Add-Type -Path "$($PSScriptRoot)\EPPlus.dll"
 . $PSScriptRoot\Pivot.ps1
 . $PSScriptRoot\PivotTable.ps1
 . $PSScriptRoot\RemoveWorksheet.ps1
-. $PSScriptRoot\Send-SQLDataToExcel.ps1
+. $PSScriptRoot\Send-SqlDataToExcel.ps1
 . $PSScriptRoot\Set-CellStyle.ps1
 . $PSScriptRoot\Set-Column.ps1
 . $PSScriptRoot\Set-Row.ps1
@@ -45,9 +45,10 @@ Add-Type -Path "$($PSScriptRoot)\EPPlus.dll"
 New-Alias -Name Use-ExcelData -Value "ConvertFrom-ExcelData" -Force
 
 if ($PSVersionTable.PSVersion.Major -ge 5) {
-    . $PSScriptRoot\Plot.ps1
+    . $PSScriptRoot\plot.ps1
 
     Function New-Plot {
+        [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '', Justification='New-Plot does not change system state')]
         Param()
 
         [PSPlot]::new()
@@ -73,7 +74,11 @@ function Import-Excel {
 
    .PARAMETER Path
        Specifies the path to the Excel file.
-
+   .PARAMETER ExcelPackage
+       Instead of specifying a path provides an Excel Package object (from Open-ExcelPackage)
+       Using this avoids re-reading the whole file when importing multiple parts of it.
+       To allow multiple read operations Import-Excel does NOT close the package, and you should use
+       Close-ExcelPackage -noSave to close it.
    .PARAMETER WorksheetName
        Specifies the name of the worksheet in the Excel workbook to import. By default, if no name is provided, the first worksheet will be imported.
 
@@ -82,19 +87,15 @@ function Import-Excel {
 
    .PARAMETER HeaderName
        Specifies custom property names to use, instead of the values defined in the column headers of the TopRow.
-
-       In case you provide less header names than there is data in the worksheet, then only the data with a corresponding header name will be imported and the data without header name will be disregarded.
-
-       In case you provide more header names than there is data in the worksheet, then all data will be imported and all objects will have all the property names you defined in the header names. As such, the last properties will be blanc as there is no data for them.
+       If you provide fewer header names than there are columns of data in the worksheet, then data will only be imported from that number of columns - the others will be ignored.
+       If you provide more header names than there are columns of data in the worksheet, it will result in blank properties being added to the objects returned.
 
    .PARAMETER NoHeader
        Automatically generate property names (P1, P2, P3, ..) instead of the ones defined in the column headers of the TopRow.
-
        This switch is best used when you want to import the complete worksheet ‘as is’ and are not concerned with the property names.
 
    .PARAMETER StartRow
        The row from where we start to import data, all rows above the StartRow are disregarded. By default this is the first row.
-
        When the parameters ‘-NoHeader’ and ‘-HeaderName’ are not provided, this row will contain the column headers that will be used as property names. When one of both parameters are provided, the property names are automatically created and this row will be treated as a regular row containing data.
 
    .PARAMETER EndRow
@@ -261,20 +262,28 @@ function Import-Excel {
    .NOTES
   #>
 
-    [CmdLetBinding(DefaultParameterSetName)]
+    [CmdLetBinding()]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingPlainTextForPassword", "")]
     Param (
         [Alias('FullName')]
-        [Parameter(ValueFromPipelineByPropertyName, ValueFromPipeline, Position = 0, Mandatory)]
+        [Parameter(ParameterSetName = "PathA", Mandatory, ValueFromPipelineByPropertyName, ValueFromPipeline, Position = 0 )]
+        [Parameter(ParameterSetName = "PathB", Mandatory, ValueFromPipelineByPropertyName, ValueFromPipeline, Position = 0 )]
+        [Parameter(ParameterSetName = "PathC", Mandatory, ValueFromPipelineByPropertyName, ValueFromPipeline, Position = 0 )]
         [ValidateScript( {(Test-Path -Path $_ -PathType Leaf) -and ($_ -match '.xls$|.xlsx$|.xlsm$')})]
         [String]$Path,
+        [Parameter(ParameterSetName = "PackageA", Mandatory)]
+        [Parameter(ParameterSetName = "PackageB", Mandatory)]
+        [Parameter(ParameterSetName = "PackageC", Mandatory)]
+        [OfficeOpenXml.ExcelPackage]$ExcelPackage,
         [Alias('Sheet')]
         [Parameter(Position = 1)]
         [ValidateNotNullOrEmpty()]
         [String]$WorksheetName,
-        [Parameter(ParameterSetName = 'B', Mandatory)]
+        [Parameter(ParameterSetName = 'PathB'   , Mandatory)]
+        [Parameter(ParameterSetName = 'PackageB', Mandatory)]
         [String[]]$HeaderName ,
-        [Parameter(ParameterSetName = 'C', Mandatory)]
+        [Parameter(ParameterSetName = 'PathC'   , Mandatory)]
+        [Parameter(ParameterSetName = 'PackageC', Mandatory)]
         [Switch]$NoHeader     ,
         [Alias('HeaderRow', 'TopRow')]
         [ValidateRange(1, 9999)]
@@ -289,14 +298,14 @@ function Import-Excel {
         [ValidateNotNullOrEmpty()]
         [String]$Password
     )
-    Begin {
+    begin {
         $sw = [System.Diagnostics.Stopwatch]::StartNew()
         Function Get-PropertyNames {
             <#
             .SYNOPSIS
                 Create objects containing the column number and the column name for each of the different header types.
             #>
-
+            [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseSingularNouns', '', Justification="Name would be incorrect, and command is not exported")]
             Param (
                 [Parameter(Mandatory)]
                 [Int[]]$Columns,
@@ -320,8 +329,8 @@ function Import-Excel {
                     }
                 }
                 else {
-                    if ($StartRow -eq 0) {
-                        throw 'The top row can never be equal to 0 when we need to retrieve headers from the worksheet.'
+                    if ($StartRow -lt 1) {
+                        throw 'The top row can never be less than 1 when we need to retrieve headers from the worksheet.' ; return
                     }
 
                     foreach ($C in $Columns) {
@@ -330,43 +339,21 @@ function Import-Excel {
                 }
             }
             Catch {
-                throw "Failed creating property names: $_"
+                throw "Failed creating property names: $_" ; return
             }
         }
     }
 
-    Process {
-        #region Open file
+    process {
+        if      ($Path -and  $Password)  {$ExcelPackage = Open-ExcelPackage -Path $Path -Password $Password}
+        elseif ($Path)                   {$ExcelPackage = Open-ExcelPackage -Path $Path}
         try {
-            $Path = (Resolve-Path $Path).ProviderPath
-            Write-Verbose "Import Excel workbook '$Path' with worksheet '$Worksheetname'"
-            $Stream = New-Object -TypeName System.IO.FileStream -ArgumentList $Path, 'Open', 'Read', 'ReadWrite'
+            #Select worksheet
+            if (-not  $WorksheetName) { $Worksheet = $ExcelPackage.Workbook.Worksheets[1] }
+            elseif(-not ($Worksheet = $ExcelPackage.Workbook.Worksheets[$WorkSheetName])) {
+                    throw "Worksheet '$WorksheetName' not found, the workbook only contains the worksheets '$($ExcelPackage.Workbook.Worksheets)'. If you only wish to select the first worksheet, please remove the '-WorksheetName' parameter." ; return
             }
-        Catch {throw "Could not open $Path ; $_ "}
 
-        if ($Password) {
-            Try {
-                $Excel = New-Object -TypeName OfficeOpenXml.ExcelPackage
-                $excel.Load( $Stream, $Password)
-            }
-            Catch { throw "Could not read $Path with the provided password." }
-        }
-        else {
-            try {$Excel = New-Object -TypeName OfficeOpenXml.ExcelPackage -ArgumentList $Stream}
-            Catch {throw "Failed to read $Path"}
-        }
-        #endregion
-        Try {
-            #region Select worksheet
-            if ($WorksheetName) {
-                if (-not ($Worksheet = $Excel.Workbook.Worksheets[$WorkSheetName])) {
-                    throw "Worksheet '$WorksheetName' not found, the workbook only contains the worksheets '$($Excel.Workbook.Worksheets)'. If you only wish to select the first worksheet, please remove the '-WorksheetName' parameter."
-                }
-            }
-            else {
-                $Worksheet = $Excel.Workbook.Worksheets | Select-Object -First 1
-            }
-            #endregion
             Write-Debug $sw.Elapsed.TotalMilliseconds
             #region Get rows and columns
             #If we are doing dataonly it is quicker to work out which rows to ignore before processing the cells.
@@ -374,7 +361,7 @@ function Import-Excel {
             if (-not $EndColumn) {$EndColumn = $Worksheet.Dimension.End.Column }
             $endAddress = [OfficeOpenXml.ExcelAddress]::TranslateFromR1C1("R[$EndRow]C[$EndColumn]", 0, 0)
             if ($DataOnly) {
-                #If we are using headers startrow will be the headerrow so examine data from startRow + 1,
+                #If we are using headers startrow will be the header-row so examine data from startRow + 1,
                 if ($NoHeader) {$range = "A" + ($StartRow     ) + ":" + $endAddress }
                 else {$range = "A" + ($StartRow + 1 ) + ":" + $endAddress }
                 #We're going to look at every cell and build 2 hash tables holding rows & columns which contain data.
@@ -390,17 +377,17 @@ function Import-Excel {
                 $columns = ($StartColumn..$EndColumn).Where( {$colHash[$_]})
             }
             else {
-                $Columns = $StartColumn..$EndColumn  ; if ($StartColumn -gt $EndColumn) {Write-Warning -Message "Selecting columns $StartColumn to $EndColumn might give odd results."}
-                if ($NoHeader) {$Rows = (    $StartRow)..$EndRow ; if ($StartRow -gt $EndRow) {Write-Warning -Message "Selecting rows $StartRow to $EndRow might give odd results."} }
+                $Columns = $StartColumn .. $EndColumn  ; if ($StartColumn -gt $EndColumn) {Write-Warning -Message "Selecting columns $StartColumn to $EndColumn might give odd results."}
+                if ($NoHeader) {$Rows =  $StartRow..$EndRow ; if ($StartRow -gt $EndRow) {Write-Warning -Message "Selecting rows $StartRow to $EndRow might give odd results."} }
                 else {$Rows = (1 + $StartRow)..$EndRow ; if ($StartRow -ge $EndRow) {Write-Warning -Message "Selecting $StartRow as the header with data in $(1+$StartRow) to $EndRow might give odd results."}}
             }
             #endregion
             #region Create property names
             if ((-not $Columns) -or (-not ($PropertyNames = Get-PropertyNames -Columns $Columns -StartRow $StartRow))) {
-                throw "No column headers found on top row '$StartRow'. If column headers in the worksheet are not a requirement then please use the '-NoHeader' or '-HeaderName' parameter."
+                throw "No column headers found on top row '$StartRow'. If column headers in the worksheet are not a requirement then please use the '-NoHeader' or '-HeaderName' parameter."; return
             }
             if ($Duplicates = $PropertyNames | Group-Object Value | Where-Object Count -GE 2) {
-                throw "Duplicate column headers found on row '$StartRow' in columns '$($Duplicates.Group.Column)'. Column headers must be unique, if this is not a requirement please use the '-NoHeader' or '-HeaderName' parameter."
+                throw "Duplicate column headers found on row '$StartRow' in columns '$($Duplicates.Group.Column)'. Column headers must be unique, if this is not a requirement please use the '-NoHeader' or '-HeaderName' parameter."; return
             }
             #endregion
             Write-Debug $sw.Elapsed.TotalMilliseconds
@@ -425,14 +412,9 @@ function Import-Excel {
             }
             Write-Debug $sw.Elapsed.TotalMilliseconds
         }
-        Catch {
-            throw "Failed importing the Excel workbook '$Path' with worksheet '$Worksheetname': $_"
-        }
-        Finally {
-            $Stream.Close()
-            $Stream.Dispose()
-            $Excel.Dispose()
-            $Excel = $null
+        catch { throw "Failed importing the Excel workbook '$Path' with worksheet '$Worksheetname': $_"; return }
+        finally {
+            if ($Path) {Close-ExcelPackage -ExcelPackage $ExcelPackage -NoSave }
         }
     }
 }
@@ -474,8 +456,8 @@ function ConvertFrom-ExcelSheet {
     )
 
     $Path = (Resolve-Path $Path).Path
-    $stream = New-Object -TypeName System.IO.FileStream -ArgumentList $Path, "Open", "Read", "ReadWrite"
-    $xl = New-Object -TypeName OfficeOpenXml.ExcelPackage -ArgumentList $stream
+    $Stream = New-Object -TypeName System.IO.FileStream -ArgumentList $Path, "Open", "Read", "ReadWrite"
+    $xl = New-Object -TypeName OfficeOpenXml.ExcelPackage -ArgumentList $Stream
     $workbook = $xl.Workbook
 
     $targetSheets = $workbook.Worksheets | Where-Object {$_.Name -like $SheetName}
@@ -494,8 +476,8 @@ function ConvertFrom-ExcelSheet {
         Import-Excel $Path -Sheet $($sheet.Name) | Export-Csv @params
     }
 
-    $stream.Close()
-    $stream.Dispose()
+    $Stream.Close()
+    $Stream.Dispose()
     $xl.Dispose()
 }
 

LoadPSD1.ps1

@@ -1,3 +1,3 @@
-if((Get-Module -list ImportExcel) -eq $null) {
+if($null -eq (Get-Module -ListAvailable ImportExcel) ) {
     Import-Module $PSScriptRoot\ImportExcel.psd1 -force
 }

Merge-worksheet.ps1

@@ -375,6 +375,8 @@ Function Merge-MultipleSheets {
         the key; in this version the row numbers are hidden.
     #>
     [cmdletbinding()]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '', Justification="False positives when initializing variable in begin block")]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseSingularNouns', '', Justification="MultipleSheet would be incorrect")]
     #[Alias("Merge-MulipleSheets")] #There was a spelling error in the first release. This was there to ensure things didn't break but intelisense gave the alias first.
     param   (
         #Paths to the files to be merged. Files are also accepted

New-ConditionalFormattingIconSet.ps1

@@ -27,6 +27,7 @@ function New-ConditionalFormattingIconSet {
         Add-Add-ConditionalFormatting
         New-ConditionalText
     #>
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '',Justification='Does not change system State')]
     param(
         [Parameter(Mandatory=$true)]
         $Range,

New-ConditionalText.ps1

@@ -42,8 +42,8 @@ function New-ConditionalText {
         Add-Add-ConditionalFormatting
         New-ConditionalFormattingIconSet
     #>
-
     [cmdletbinding()]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '',Justification='Does not change system State')]
     param(
         #[Parameter(Mandatory=$true)]
         [Alias("ConditionValue")]

New-ExcelChart.ps1

@@ -97,6 +97,7 @@
     #>
     [Alias("New-ExcelChart")] #This was the former name. The new name reflects that we are defining a chart, not making one in the workbook.
     [cmdletbinding()]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '',Justification='Does not change system State')]
     param(
         $Title = "Chart Title",
         $Header,

New-PSItem.ps1

@@ -1,3 +1,5 @@
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '', Scope='Function', Target='New*', Justification='Does not change system State')]
+param()
 function New-PSItem {
 
     $totalArgs = $args.Count

PivotTable.ps1

@@ -312,6 +312,7 @@ function New-PivotTableDefinition {
 
         This is a re-work of one of the examples in Export-Excel - instead of writing out the pivot definition hash table it is built by calling New-PivotTableDefinition.
     #>
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '',Justification='Does not change system State')]
     param(
         [Parameter(Mandatory)]
         [Alias("PivtoTableName")]#Previous typo - use alias to avoid breaking scripts

README.md

@@ -53,6 +53,11 @@ Install-Module ImportExcel -scope CurrentUser
 Install-Module ImportExcel
 ```
 
+# What's new 6.1.0
+
+Thank you to [James O'Neill](https://github.com/jhoneill)
+- Instead of specifying a path provides an Excel Package object (from `Open-ExcelPackage`), using this avoids re-reading the whole file when importing multiple parts of it. To allow multiple read operations `Import-Excel` does NOT close the package, and you should use `Close-ExcelPackage -noSave` to close it.
+
 # What's new 6.0.0
 
 Thank you to [James O'Neill](https://github.com/jhoneill) for the optimizations, and refactoring leading to a ***~10x*** speed increase. Thanks to [ili101](https://github.com/ili101) for earlier PRs that provided the ground work for this.

RemoveWorksheet.ps1

@@ -15,7 +15,8 @@
         C:\> dir c:\reports\*.xlsx | Remove-WorkSheet
         Removes 'Sheet1' from all the xlsx files in the c:\reports directory
 
-#>
+    #>
+    [cmdletbinding(SupportsShouldProcess=$true)]
     param(
         #    [Parameter(ValueFromPipelineByPropertyName)]
         [Parameter(ValueFromPipelineByPropertyName)]
@@ -34,9 +35,10 @@
 
         if ($pkg) {
             foreach ($wsn in $WorksheetName) {
+                if ($PSCmdlet.ShouldProcess($FullName,"Remove Sheet $wsn")) {
                     $pkg.Workbook.Worksheets.Delete($wsn)
                 }
-
+            }
             Close-ExcelPackage -ExcelPackage $pkg -Show:$Show
         }
     }

Send-SqlDataToExcel.ps1

@@ -90,6 +90,8 @@
         Export-Excel
     #>
     [CmdletBinding(DefaultParameterSetName="none")]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidGlobalVars', '', Justification="Allowed to use DBSessions Global variable from GETSQL Module")]
+
     param (
         [Parameter(ParameterSetName="SQLConnection",   Mandatory=$true)]
         [Parameter(ParameterSetName="ODBCConnection",  Mandatory=$true)]

Set-CellStyle.ps1

@@ -1,4 +1,7 @@
-function Set-CellStyle {
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '', Scope='Function', Target='Set*', Justification='Does not change system state')]
+param()
+
+function Set-CellStyle {
     param(
         $WorkSheet,
         $Row,

Set-Column.ps1

@@ -44,6 +44,8 @@
     [cmdletbinding()]
     [Alias("Set-Column")]
     [OutputType([OfficeOpenXml.ExcelColumn],[String])]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '',Justification='Does not change system state')]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '', Justification="Variables created for script block which may be passed as a parameter, but not used in the script")]
     Param (
         #If specifying the worksheet by name, the ExcelPackage object which contains the worksheet also needs to be passed.
         [Parameter(ParameterSetName="Package",Mandatory=$true)]
@@ -138,7 +140,7 @@
     process {
         if ($null -eq $workSheet.Dimension) {Write-Warning "Can't format an empty worksheet."; return}
         if ($Column  -eq 0 )  {$Column     = $endColumn    + 1 }
-        $columnName = [OfficeOpenXml.ExcelCellAddress]::new(1,$column).Address -replace "1",""
+        $columnName = (New-Object 'OfficeOpenXml.ExcelCellAddress' @(1, $column)).Address -replace "1",""
         Write-Verbose -Message "Updating Column $columnName"
         #If there is a heading, insert it and use it as the name for a range (if we're creating one)
         if      ($PSBoundParameters.ContainsKey('Heading'))                 {

Set-Row.ps1

@@ -33,6 +33,8 @@
     [cmdletbinding()]
     [Alias("Set-Row")]
     [OutputType([OfficeOpenXml.ExcelRow],[String])]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '',Justification='Does not change system state')]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '', Justification="Variables created for script block which may be passed as a parameter, but not used in the script")]
     Param (
         #An Excel package object - e.g. from Export-Excel -PassThru - requires a sheet name.
         [Parameter(ParameterSetName="Package",Mandatory=$true)]
@@ -143,7 +145,7 @@
         #Fill in the data
         if      ($PSBoundParameters.ContainsKey('Value')) {foreach ($column in ($StartColumn..$endColumn)) {
             #We might want the column name in a script block
-            $columnName = [OfficeOpenXml.ExcelCellAddress]::new(1,$column).Address -replace "1",""
+            $columnName = (New-Object -TypeName OfficeOpenXml.ExcelCellAddress @(1,$column)).Address -replace "1",""
             if  ($Value -is [scriptblock] ) {
                 #re-create the script block otherwise variables from this function are out of scope.
                 $cellData = & ([scriptblock]::create( $Value ))
@@ -177,7 +179,7 @@
             if ($PSBoundParameters.ContainsKey($p)) {$params[$p] = $PSBoundParameters[$p]}
         }
         if ($params.Count) {
-            $theRange = [OfficeOpenXml.ExcelAddress]::New($Row, $StartColumn, $Row, $endColumn)
+            $theRange = New-Object -TypeName OfficeOpenXml.ExcelAddress @($Row, $StartColumn, $Row, $endColumn)
             Set-ExcelRange -WorkSheet $Worksheet -Range $theRange @params
         }
         #endregion

Set-WorkSheetProtection.ps1

@@ -9,6 +9,7 @@
         Set-WorkSheetProtection -WorkSheet $planSheet -IsProtected -AllowAll -AllowInsertColumns:$false -AllowDeleteColumns:$false -UnLockAddress "A:N"
         Turns on protection for the worksheet in $planSheet, checks all the allow boxes excel Insert and Delete columns and unlocks columns A-N
     #>
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '',Justification='Does not change system state')]
     param (
         #The worksheet where protection is to be applied.
         [Parameter(Mandatory=$true)]

SetFormat.ps1

@@ -32,6 +32,7 @@
     #>
     [cmdletbinding()]
     [Alias("Set-Format")]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '',Justification='Does not change system state')]
     Param   (
         #One or more row(s), Column(s) and/or block(s) of cells to format.
         [Parameter(ValueFromPipeline = $true,Position=0)]

Update-FirstObjectProperties.ps1

@@ -1,3 +1,8 @@
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '', Scope='Function', Target='Update*', Justification='Does not change system state')]
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseSingularNouns', '', Scope='Function', Target='Update*', Justification='Property would be incorrect')]
+
+param()
+
 Function Update-FirstObjectProperties {
     <#
         .SYNOPSIS
@@ -79,7 +84,7 @@ Function Update-FirstObjectProperties {
         $Union = @()
         $Input | ForEach-Object {
             If ($Union.Count) {
-                $_ | Get-Member | Where {-not ($Union[0] | Get-Member $_.Name)} | ForEach-Object {
+                $_ | Get-Member | Where-Object {-not ($Union[0] | Get-Member $_.Name)} | ForEach-Object {
                     $Union[0] | Add-Member -MemberType NoteProperty -Name $_.Name -Value $Null
                 }
             }

__tests__/Compare-WorkSheet.tests.ps1

@@ -328,7 +328,7 @@ Describe "Merge Multiple sheets" {
             $ws.Cells[12,9 ].Value                                        | Should     be $ws.Cells[12,5].Value
             $ws.Cells[12,10].Value                                        | Should     be $ws.Cells[12,6].Value
         }
-        it "Creared Conditional formatting rules                                                   " {
+        it "Created Conditional formatting rules                                                   " {
             $cf=$ws.ConditionalFormatting
             $cf.Count                                                     | Should     be 17
             $cf[16].Address.Address                                       | Should     be 'B2:B1048576'

__tests__/ImportExcelTests/Simple.tests.ps1

@@ -29,4 +29,14 @@ Describe "Tests" {
         $timer.TotalMilliseconds | should BeLessThan 3000
     }
 
+    It "Should be able to open, read and close as seperate actions" {
+        $timer = Measure-Command {
+            $excel = Open-ExcelPackage $PSScriptRoot\Simple.xlsx
+            $data = Import-Excel -ExcelPackage $excel
+            Close-ExcelPackage -ExcelPackage $excel -NoSave}
+            $timer.TotalMilliseconds | should BeLessThan 2100
+            $data.count | Should be 2
+            $data[0].p1 | Should be "a"
+            $data[1].p1 | Should be "b"
+    }
 }

__tests__/Join-Worksheet.tests.ps1

@@ -91,12 +91,12 @@ Describe "Join Worksheet part 1" {
 }
     $path = "$env:TEMP\Test.xlsx"
     Remove-item -Path $path -ErrorAction SilentlyContinue
-IF ($PSVersionTable.PSVersion.Major -gt 5) {Write-warning -message "Part 2 Does not run on V6"; return}
+#switched to CIM objects so test runs on V6
 Describe "Join Worksheet part 2" {
-     Get-WmiObject -Class win32_logicaldisk |
+    Get-CimInstance -ClassName win32_logicaldisk |
         Select-Object -Property DeviceId,VolumeName, Size,Freespace |
             Export-Excel -Path $path -WorkSheetname Volumes -NumberFormat "0,000"
-    Get-NetAdapter  |
+    Get-CimInstance -Namespace root/StandardCimv2 -class MSFT_NetAdapter   |
         Select-Object -Property Name,InterfaceDescription,MacAddress,LinkSpeed |
             Export-Excel -Path $path -WorkSheetname NetAdapters
 

compare-worksheet.ps1

@@ -69,6 +69,8 @@
         Only the unchanged rows are highlighted.
 #>
     [cmdletbinding(DefaultParameterSetName)]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingWriteHost', '', Justification="Write host used for sub-warning level message to operator which does not form output")]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '', Justification="False positives when initializing variable in begin block")]
     Param(
         #First file to compare.
         [parameter(Mandatory=$true,Position=0)]
@@ -219,11 +221,9 @@
     }
     elseif  ($diff -and $FontColor) {Write-Warning -Message "To match rows to set changed cells, you must specify -Key and it must match one of the included properties." }
 
-    #if nothing was found write a message which wont be redirected
+    #if nothing was found write a message which will not be redirected
     if (-not $diff) {Write-Host "Comparison of $Referencefile::$worksheet1 and $Differencefile::$WorkSheet2 returned no results."  }
 
-
-
     if      ($Show)               {
         Start-Process -FilePath $Referencefile
         if  (-not $oneFile)  { Start-Process -FilePath $Differencefile }

plot.ps1

@@ -1,3 +1,5 @@
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '', Justification="False positives")]
+param()
 class PSPlot {
     hidden $path
     hidden $pkg