Skip to content

feat: Add support for including excepting SourceCharacter to printDescription #3765

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

Closed
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,20 @@ type Money {
arg2: String
"Description 3 Description 3 Description 3 Description 3 Description 3 Description 3 Description 3 Description 3 Description 3 Description 3 Description 3"
arg3: String
"""
Description block string including double quote "4"
"""
arg4: String
"Description string value including double quote \\"5\\""
arg5: String
"""
Description block string including back slash \\\\6\\\\
"""
arg6: String
"Description string value including back slash \\\\7\\\\"
arg7: String
"Description string value including line terminator 8\\r\\n"
arg8: String
): String
}
`);
Expand Down Expand Up @@ -123,6 +137,25 @@ type User @key(fields: "id") {
Description 3 Description 3 Description 3 Description 3 Description 3 Description 3
"""
arg3: String
"""
Description block string including double quote "4"
"""
arg4: String
"""
Description string value including double quote "5"
"""
arg5: String
"""
Description block string including back slash \\\\6\\\\
"""
arg6: String
"""
Description string value including back slash \\7\\
"""
arg7: String
"""
Description string value including line terminator 8\r\n """
arg8: String
): String
}
`);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -347,7 +347,10 @@ function printDescription(
}

const lines = descriptionLines(def.description, 120 - indentation.length);
if (lines.length === 1) {
const hasExceptingStringCharacter = /"|\\|\r|\n/.test(lines[0]);
const printAsSingleLine = lines.length === 1 && !hasExceptingStringCharacter;

if (printAsSingleLine) {
return indentation + `"${lines[0]}"\n`;
} else {
return (
Expand All @@ -360,7 +363,7 @@ function descriptionLines(description: string, maxLen: number): Array<string> {
const rawLines = description.split('\n');
return rawLines.flatMap(line => {
if (line.length < maxLen + 5) {
return line;
return line.length === 0 ? [] : line;
}
// For > 120 character long lines, cut at space boundaries into sublines
// of ~80 chars.
Expand Down