Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jjcarrier/PS-TextTable
A PowerShell module to convert from text-based tables into objects
https://github.com/jjcarrier/PS-TextTable
Last synced: 3 months ago
JSON representation
A PowerShell module to convert from text-based tables into objects
- Host: GitHub
- URL: https://github.com/jjcarrier/PS-TextTable
- Owner: jjcarrier
- License: mit
- Created: 2023-07-02T17:47:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-03T15:26:43.000Z (about 1 year ago)
- Last Synced: 2024-05-18T05:34:34.315Z (6 months ago)
- Language: PowerShell
- Size: 20.5 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - jjcarrier/PS-TextTable - A PowerShell module to convert from text-based tables into objects (PowerShell)
README
# TextTable Converter PowerShell Module
[](https://github.com/jjcarrier/TextTable/actions/workflows/ci.yml)
## Description
Provides a simple way to convert text-based tables into PowerShell objects.
The underlying `ConvertFrom-TextTable` cmdlet provides:
* Conversion from text-based tables often encountered in cmd/bash-centric tools to PowerShell objects.
* Various options for handling the conversion logic when working with more complex/verbose output.
* Detect (and optionally report) table truncation (indicated by presence of trailing ellipsis).
Below are the `current` requirements for table conversion:
* Column headers must be left aligned.
* Column headers must be single words.
* Column headers must be on a single line.
* In the absence of a column separator, the first line of the `-Text` input is treated as the column header.
* All rows in the table respect the bounds setup by the first character of each column header.
With the above requirements, it is possible to support a simple solution for parsing table entries with spaces.
> [!NOTE]\
> The primary use-case of this module was to provide a simple way to access the list of upgradable
packages from the output of `winget update`.
## Installation
Install the module from `PSGallery`:
```pwsh
Install-Module -Name TextTable -Repository PSGallery
```
Load the module via:
```pwsh
Import-Module TextTable
```
## Usage
An example use-case of this cmdlet is to interact with the `winget update` output as shown below:
```pwsh
$updates = @(winget update | ConvertFrom-TextTable)
if ($updates.Count -gt 0) {
Write-Output "Below are all of the available updates:"
$updates | Format-Table
Write-Output "The first available update is:"
$updates[0]
}
```
It is worth noting that the above is not a complete solution to capturing the updates from `winget update` as this
may output more than one table that may need to be parsed and this cmdlet only parses the first table encountered.
Additionally, the table that is output typically includes a count of how many packages are upgradable before a
blank line is encountered. To solve both of these issues means that the user should:
* Split the `winget update` output to separate the two tables and pass them to this cmdlet individually
* Use the `-LastLineRegEx` option to specify the line containing the number of upgradable packages as the last line,
or simply drop the entry from the resulting array of objects.
## Testing
Basic tests are available via [Pester](https://pester.dev/). With Pester setup, run:
```pwsh
Invoke-Pester
```
## Reporting Issues
If a particular command appears to be be problematic with `ConvertFrom-TextTable`, please report it
in a GitHub issue. Or if so inclined, make a PR to address the problem.