-
Notifications
You must be signed in to change notification settings - Fork 0
📖 [Docs]: README pages now use the standard module landing-page format #30
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Marius Storhaug (MariusStorhaug)
wants to merge
4
commits into
main
Choose a base branch
from
docs/standardize-readme
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,119 +1,29 @@ | ||
| # Hashtable | ||
|
|
||
| Hashtable is a comprehensive module that provides functions for working with PowerShell hashtables. | ||
| It enables you to convert hashtables to PSCustomObjects and vice versa, format hashtables into readable PowerShell | ||
| code, merge hashtables with override support, and remove entries based on specific criteria. This collection of | ||
| utilities is designed to simplify complex hashtable manipulations and help automate your PowerShell workflows. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| This module uses the following external resources: | ||
| - The [PSModule framework](https://github.com/PSModule) for building, testing, and publishing the module. | ||
| Hashtable is a PowerShell module that simplifies common hashtable operations. | ||
|
|
||
| ## Installation | ||
|
|
||
| To install the module from the PowerShell Gallery, you can use the following command: | ||
| Install the module from the PowerShell Gallery: | ||
|
|
||
| ```powershell | ||
| Install-PSResource -Name Hashtable | ||
| Import-Module -Name Hashtable | ||
| ``` | ||
|
MariusStorhaug marked this conversation as resolved.
|
||
|
|
||
| ## Usage | ||
|
|
||
| Below are some examples illustrating typical use cases for the module. | ||
|
|
||
| ### Example 1: Converting a Hashtable to a PSCustomObject | ||
|
|
||
| This example demonstrates how to convert a nested hashtable into a PSCustomObject, making it easier to manipulate and explore your data. | ||
|
|
||
| ```powershell | ||
| $hashtable = @{ | ||
| Name = 'Alice' | ||
| Age = 30 | ||
| Contact = @{ | ||
| Email = 'alice@example.com' | ||
| Phone = '123-456-7890' | ||
| } | ||
| } | ||
|
|
||
| $object = $hashtable | ConvertFrom-Hashtable | ||
| $object | Format-List | ||
| ``` | ||
|
|
||
| ### Example 2: Merging Hashtables | ||
|
|
||
| Merge a default settings hashtable with user-specified overrides. In this example, the values in the override hashtable | ||
| replace those in the main hashtable. | ||
|
|
||
| ```powershell | ||
| $defaultSettings = @{ | ||
| Theme = 'Light' | ||
| Language = 'en' | ||
| Layout = 'Standard' | ||
| } | ||
| $userSettings = @{ | ||
| Theme = 'Dark' | ||
| Layout = 'Compact' | ||
| } | ||
|
|
||
| $mergedSettings = $defaultSettings | Merge-Hashtable -Overrides $userSettings | ||
| $mergedSettings | ||
| ``` | ||
|
|
||
| ### Example 3: Formatting a Hashtable as PowerShell Code | ||
|
|
||
| Convert a hashtable into a nicely formatted PowerShell code representation. This is especially useful for exporting | ||
| configurations to a `.psd1` file. | ||
|
|
||
| ```powershell | ||
| $configuration = @{ | ||
| Server = 'localhost' | ||
| Port = 8080 | ||
| Credentials = @{ | ||
| Username = 'admin' | ||
| Password = 'P@ssw0rd' | ||
| } | ||
| Enabled = $true | ||
| } | ||
| If your environment still uses PowerShellGet, install the module with `Install-Module -Name Hashtable` instead. | ||
|
|
||
| $formattedConfig = $configuration | Format-Hashtable | ||
| Write-Output $formattedConfig | ||
| ``` | ||
| ## Documentation | ||
|
|
||
| ### Example 4: Removing Hashtable Entries Based on Criteria | ||
| Documentation is published at [psmodule.io/Hashtable](https://psmodule.io/Hashtable/). | ||
|
|
||
| Remove specific entries from a hashtable, such as keys with null or empty values, or those matching a particular name. | ||
| Use PowerShell help and command discovery for module details: | ||
|
|
||
| ```powershell | ||
| $ht = @{ | ||
| ValidKey = 'SomeValue' | ||
| EmptyKey = '' | ||
| RemoveMe = 'Unwanted' | ||
| } | ||
|
|
||
| # Remove entries with null or empty values and keys named 'RemoveMe' | ||
| $ht | Remove-HashtableEntry -NullOrEmptyValues -Keys 'RemoveMe' | ||
| $ht | ||
| Get-Command -Module Hashtable | ||
| Get-Help ConvertTo-Hashtable -Examples | ||
| ``` | ||
|
|
||
| You can use `Get-Command -Module 'Hashtable'` to list available commands, and `Get-Help -Examples <CommandName>` to view command-specific examples. | ||
|
|
||
| ## Documentation | ||
|
|
||
| Detailed documentation for each function is available via inline help. For more extensive documentation, please visit the | ||
| [Hashtable docs](https://psmodule.io/Hashtable/) or [PSModule Docs](https://psmodule.io/docs). | ||
|
|
||
| ## Contributing | ||
|
|
||
| Coder or not, you can contribute to the project! We welcome all contributions. | ||
|
|
||
| ### For Users | ||
|
|
||
| If you don't code, your feedback is invaluable. If you encounter issues, unexpected behaviors, or missing functionality, | ||
| please submit a bug report or feature request via the project's issues page. | ||
|
|
||
| ### For Developers | ||
|
|
||
| If you code, we'd love to see your contributions. Please review the [Contribution Guidelines](CONTRIBUTING.md) for more details. | ||
| You can start by picking up an existing issue or submitting a new one if you have an idea for a new feature or improvement. | ||
| Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.