Skip to content

ConvertTo-Csv: Quote fields with quotes and newlines when using -UseQuotes AsNeeded #15765

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.

Sign up for GitHub

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

Merged
TravisEz13 merged 5 commits into from
Aug 4, 2021
Merged

ConvertTo-Csv: Quote fields with quotes and newlines when using -UseQuotes AsNeeded #15765

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
34e3ca6
Escape quotes and newlines with -UseQuotes AsNeeded
lukeselden Jul 13, 2021
c712df9
add additional -UseQuotes AsNeeded tests
lukeselden Jul 13, 2021
15200e4
Code Quality cleanup per codefactor review
lukeselden Jul 13, 2021
4832f43
inline AsNeeded character detection
lukeselden Jul 13, 2021
a9f296f
Apply suggestions from code review
lselden Jul 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/Microsoft.PowerShell.Commands.Utility/commands/utility/CsvCommands.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -967,7 +967,8 @@ internal string ConvertPropertyNamesCSV(IList<string> propertyNames)
AppendStringWithEscapeAlways(_outputString, propertyName);
break;
case BaseCsvWritingCommand.QuoteKind.AsNeeded:
if (propertyName.Contains(_delimiter))

if (propertyName.AsSpan().IndexOfAny(_delimiter, '\n', '"') != -1)
{
AppendStringWithEscapeAlways(_outputString, propertyName);
}
Expand Down Expand Up @@ -1038,7 +1039,7 @@ internal string ConvertPSObjectToCSV(PSObject mshObject, IList<string> propertyN
AppendStringWithEscapeAlways(_outputString, value);
break;
case BaseCsvWritingCommand.QuoteKind.AsNeeded:
if (value != null && value.Contains(_delimiter))
if (value != null && value.AsSpan().IndexOfAny(_delimiter, '\n', '"') != -1)
{
AppendStringWithEscapeAlways(_outputString, value);
}
Expand Down
39 changes: 39 additions & 0 deletions test/powershell/Modules/Microsoft.PowerShell.Utility/ConvertTo-Csv.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,5 +159,44 @@ Describe "ConvertTo-Csv" -Tags "CI" {
$result[0] | Should -BeExactly "`"FirstColumn`"rSecondColumn"
$result[1] | Should -BeExactly "Hellor"
}

It "UseQuotes AsNeeded Escapes Delimiters" {
$testDelimitersObject = [pscustomobject]@{ "FirstColumn" = "Hello,"; "Second,Column" = "World" };

$result = $testDelimitersObject | ConvertTo-Csv -UseQuotes AsNeeded -Delimiter ','

$result[0] | Should -BeExactly "FirstColumn,`"Second,Column`""
$result[1] | Should -BeExactly "`"Hello,`",World"

$result = $testDelimitersObject | ConvertTo-Csv -UseQuotes AsNeeded -Delimiter "r"

$result[0] | Should -BeExactly "`"FirstColumn`"rSecond,Column"
$result[1] | Should -BeExactly "Hello,r`"World`""
}

It "UseQuotes AsNeeded Escapes Newlines" {
$testCRLFObject = [pscustomobject]@{ "First`r`nColumn" = "Hello`r`nWorld" };
$testLFObject = [pscustomobject]@{ "First`nColumn" = "Hello`nWorld" };

$result = $testCRLFObject | ConvertTo-Csv -UseQuotes AsNeeded

$result[0] | Should -BeExactly "`"First`r`nColumn`""
$result[1] | Should -BeExactly "`"Hello`r`nWorld`""

$result = $testLFObject | ConvertTo-Csv -UseQuotes AsNeeded

$result[0] | Should -BeExactly "`"First`nColumn`""
$result[1] | Should -BeExactly "`"Hello`nWorld`""
}

It "UseQuotes AsNeeded Escapes Quotes" {
$testQuotesObject = [pscustomobject]@{ "First`"Column" = "`"Hello`" World" };

$result = $testQuotesObject | ConvertTo-Csv -UseQuotes AsNeeded

$result[0] | Should -BeExactly "`"First`"`"Column`""
$result[1] | Should -BeExactly "`"`"`"Hello`"`" World`""
}

}
}