René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"New Feature: Commands for string methods \u0026 operators on the pipeline","articleBody":"# Introduction\r\nOne of the things I have seen that always bugged me in PowerShell was the fact, that string operators cannot be used on a pipeline. A simple example:\r\n```powershell\r\n(2,3,1,4 | Sort-Object) -join \".\"\r\n```\r\nNot convenient, especially for interactive console use where you often need to go back and add the braces. The default string operators obviously aren't cmdlets and won't work on the pipeline - instead they are fast.\r\n\r\nIn one of my modules (`PSUtil`) I have functions that emulate this functionality:\r\n```powershell\r\n2,3,1,4 | sort | join \".\"\r\n```\r\nHowever I think this would make sense as part of the default command set, as virtually every user of PowerShell has to handle strings.\r\n\r\n# Weighing the scales\r\n## Advantages\r\n\r\n - More convenient to use for end user on the pipeline\r\n - Additional suitable features can be added through parameters (See implementation proposal below)\r\n\r\n## Disadvantages\r\n\r\n - Clobber list of commands available by default with more commands.\r\n\r\n# On Implementation\r\n\r\nI am willing to implement all commands involved, their tests and documentation, all by myself, if this feature is deemed worthwhile.\r\n\r\n# Proposed commands \u0026 features\r\n## Add-String (Alias: 'wrap')\r\n\r\nDoes not have an operator equivalent. Command that allows you to easily add to a string on the pipeline.\r\n\r\n### Example\r\n```powershell\r\nPS\u003e 1..4 | wrap '\"' '\"'\r\n\r\n\"1\"\r\n\"2\"\r\n\"3\"\r\n\"4\"\r\n```\r\n\r\n### Parameters\r\n\r\n - InputString (`string[]` | Pipeline), the string(s) being added to\r\n - Before (`string`), the string to add before the input\r\n - Behind (`string`), the string to add behind the input\r\n - PadLeft (`char`), character to pad left with\r\n - PadRight (`char`), character to pad right with\r\n - PadWidth (`int`), up to how many characters the string should be padded with\r\n\r\n## Format-String (Alias: 'format')\r\n\r\nEquivalent to `-f`. Command that allows you to use the format operator on the pipeline.\r\n\r\n### Example\r\n```powershell\r\nPS\u003e 1..4 | format \"{0:N2} - {1:D3}\" -Count 2\r\n\r\n1,00 - 002\r\n3,00 - 004\r\n```\r\n\r\n### Parameters\r\n\r\n - InputObject (`object` | Pipeline), objects to be formatted\r\n - Format (`string`), the format definition\r\n - Count (`int`), the number of items to store up before formating them in bulk (optional, default 1)\r\n\r\n## Get-Substring\r\n\r\nAllows trimming and picking a substring from specified strings.\r\n\r\n### Example\r\n\r\n```powershell\r\nPS\u003e \"abc def ghi\" | substring -trim \"abi\"\r\n\r\nc def gh\r\n\r\nPS\u003e \"abc def ghi\" | substring 2 4\r\n\r\nc de\r\n```\r\n\r\n### Parameters\r\n\r\n - InputString (`string[]` | Pipeline), the strings to pick from\r\n - Trim (`string`), what characters to trim\r\n - TrimStart (`string`), what characters to trim at the start of the string\r\n - TrimEnd (`string`), what characters to trim at the end of the string\r\n - Start (`int`), the start index to pick the substring from\r\n - Length (`int`), how long a substring to pick\r\n\r\n## Join-String (Alias: 'join')\r\n\r\nEquivalent to `-join`. Command that allows you to join items on the pipeline\r\n\r\n### Example\r\n```powershell\r\nPS\u003e 1..4 | join \",\"\r\n\r\n1,2,3,4\r\n\r\nPS\u003e 1..4 | join \",\" -Count 2\r\n\r\n1,2\r\n3,4\r\n```\r\n\r\n### Parameters\r\n\r\n - InputString (`string[]` | Pipeline), the strings to join\r\n - Separator (`string`), what string to join them with. Defaults to `([System.Environment]::NewLine)`\r\n - Count (`int`), the number of items to join together. (Defaults to all items)\r\n\r\n## Set-String ('replace')\r\n\r\nEquivalent to the `-replace` operator _and_ the `.Replace()` string method\r\n\r\n### Example\r\n```powershell\r\nPS\u003e \"abc def ghi\" | replace \"d\\w+\" \"zzz\"\r\n\r\nabc zzz ghi\r\n\r\nPS\u003e \"abc def ghi\" | replace \"d\\w+\" { 1..4 | join \".\" }\r\n\r\nabc 1.2.3.4 ghi\r\n\r\nPS\u003e \"abc (def) ghi\" | replace \"(def)\" \"def\" -DoNotUseRegex\r\n\r\nabc def ghi\r\n```\r\n\r\n### Parameters\r\n\r\n - InputString (`string[]` | Pipeline), the strings to replace within\r\n - OldValue (`string`), what sequence to replace\r\n - NewValue (`object`), what to replace with. Can be a string or a scriptblock\r\n - DoNotUseRegex (`switch`), switches from regex replace to using the string method `Replace()`\r\n - Options (`RegexOptions`), the regex options to use on replace, defaults to `IgnoreCase`\r\n\r\n## Split-String ('split')\r\n\r\nEquivalent to the `-split` operator _and_ the `.Split()` string method\r\n\r\n### Example\r\n\r\n```powershell\r\nPS\u003e \"abc def ghi\" | split \" d\\w+ \"\r\n\r\nabc\r\nghi\r\n\r\nPS\u003e \"abc def ghi | split \" d\\w+ \" -DoNotUseRegex\r\n\r\nabc\r\n\r\nef\r\nghi\r\n```\r\n\r\n### Parameters\r\n\r\n - InputString (`string[]` | Pipeline), the strings to split\r\n - Separator (`object`), what to split with.\r\n - DoNotUseRegex (`switch`), switches from regex split to using the string method `Split()`\r\n - Options (`RegexOptions`), the regex options to use on split, defaults to `IgnoreCase`\r\n - Count (`int`), the maximum number of items to split into (equivalent to `-split \".\",2`)\r\n\r\n# Concluding\r\n\r\nI believe these commands to improve the interactive console experience of most users, without having significant drawbacks and am perfectly willing to do the implementation myself, pending the approval of the court of public opinion :)\r\n\r\nOpinions / comments / refinements, anybody?\r\n\r\n`2018-04-27` - Updated parameter names, replaced `Remove-String (trim)`  with `Get-SubString`","author":{"url":"https://github.com/FriedrichWeinmann","@type":"Person","name":"FriedrichWeinmann"},"datePublished":"2018-04-21T21:51:49.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":20},"url":"https://github.com/6697/PowerShell/issues/6697"}