jjcarrier/ps-helpparser

A PowerShell module for parsing arbitrary command's help output

ps-helpparser's Issues

Fix text alignment

Parameters that span multiple lines often will have misaligned text this is partly due to trimming logic in the module.
Add logic to make this more visually appealing.

Add New-HelpParser cmdlet

Add a cmdlet that creates a new *.psm1 for the specified command using a common template (similar to what is referenced in the README.md)

Cache parsed help params

A consideration for cases where parsing on-the-fly can cause noticeable latency issues with tab-completion:

It may be nice to consider options to cache the parsed results. Mechanisms such as hashing the data or checking the binary version or hash of the binary could be used to determine whether the cached results need to be invalidated and regenerated for the current instance.

Also take into consideration that the command invoked depends on the system path. Such a solution should resolve the full path of the binary incase a different session is being used that points to a different version of the same command name.

Consider adding optimized support for standard CLI handler libraries

Many modern languages define their own CLI argument parsing library (or there are well-established 3rd party libraries) which goes hand-in-hand with the help documentation. Consider supporting these in an optimized way since their formatting may be more well-defined and structured. Cases of this may include:

• Python: argparse
• .NET Core: System.CommandLine
• Java: Apache Commons CLI