Skip to content
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

Jump to bottom

Uniform line endings for multi line strings/comments #7891

Merged
merged 8 commits into from Apr 5, 2020
Merged

Uniform line endings for multi line strings/comments #7891

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
50dec07
Fix #6501
sidharthv96 Mar 28, 2020
56179f1
Add tests #6501
sidharthv96 Mar 28, 2020
8b1607f
Add changelog
sidharthv96 Mar 28, 2020
dacbcc9
Fix changelog
sidharthv96 Mar 28, 2020
2011196
#7891 Update test case
sidharthv96 Mar 28, 2020
d067612
#7891 Add literal \n to template string test.
sidharthv96 Mar 29, 2020
5e14610
Merge branch 'master' of https://github.com/prettier/prettier into un…
sidharthv96 Mar 31, 2020
2f443b0
Update pr-7891.md
thorn0 Apr 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
60 changes: 60 additions & 0 deletions changelog_unreleased/javascript/pr-7891.md
View file
Open in desktop
@@ -0,0 +1,60 @@
#### Uniform line endings for multi line strings/comments ([#7891](https://github.com/prettier/prettier/pull/7891) by [@sidharthv96](https://github.com/sidharthv96))

Fixes [#6501](https://github.com/prettier/prettier/issues/6501)

Covers all languages

<!-- prettier-ignore -->
```
// Input
const foo = bar(<CRLF>
(_0: baz) => {<CRLF>
setTimeout(() => {<CRLF>
/*<CRLF>
Multiline comment<CRLF>
Multiline comment<CRLF>
Multiline comment<CRLF>
*/<CRLF>
console.log(<CRLF>
'Multiline string\\<CRLF>
Multiline string\\<CRLF>
Multiline string'<CRLF>
);<CRLF>
});<CRLF>
}<CRLF>
);<CRLF>

// Prettier stable
const foo = bar((_0: baz) => {<CRLF>
setTimeout(() => {<CRLF>
/*<LF>
Multiline comment<LF>
Multiline comment<LF>
Multiline comment<LF>
*/<CRLF>
console.log(<CRLF>
"Multiline string\\<LF>
Multiline string\\<LF>
Multiline string"<CRLF>
);<CRLF>
});<CRLF>
});<CRLF>


// Prettier master
const foo = bar((_0: baz) => {<CRLF>
setTimeout(() => {<CRLF>
/*<CRLF>
Multiline comment<CRLF>
Multiline comment<CRLF>
Multiline comment<CRLF>
*/<CRLF>
console.log(<CRLF>
"Multiline string\\<CRLF>
Multiline string\\<CRLF>
Multiline string"<CRLF>
);<CRLF>
});<CRLF>
});<CRLF>

```
9 changes: 6 additions & 3 deletions src/document/doc-printer.js
View file
Open in desktop
Expand Up @@ -253,9 +253,12 @@ function printDocToString(doc, options) {
const [ind, mode, doc] = cmds.pop();

if (typeof doc === "string") {
out.push(doc);

pos += getStringWidth(doc);
const formatted =
newLine !== "\n" && doc.includes("\n")
? doc.replace(/\n/g, newLine)
: doc;
out.push(formatted);
pos += getStringWidth(formatted);
} else {
switch (doc.type) {
case "cursor":
Expand Down
13 changes: 1 addition & 12 deletions src/main/core.js
View file
Open in desktop
Expand Up @@ -14,7 +14,6 @@ const {
const rangeUtil = require("./range-util");
const privateUtil = require("../common/util");
const {
utils: { mapDoc },
printer: { printDocToString },
debug: { printDocToDebug },
} = require("../document");
Expand Down Expand Up @@ -85,17 +84,7 @@ function coreFormat(text, opts, addAlignmentSize) {
const astComments = attachComments(text, ast, opts);
const doc = printAstToDoc(ast, opts, addAlignmentSize);

const eol = convertEndOfLineToChars(opts.endOfLine);
const result = printDocToString(
opts.endOfLine === "lf"
? doc
: mapDoc(doc, (currentDoc) =>
typeof currentDoc === "string" && currentDoc.includes("\n")
? currentDoc.replace(/\n/g, eol)
: currentDoc
),
opts
);
const result = printDocToString(doc, opts);

ensureAllCommentsPrinted(astComments);
// Remove extra leading indentation as well as the added indentation after last newline
Expand Down
177 changes: 177 additions & 0 deletions tests/end_of_line/__snapshots__/jsfmt.spec.js.snap
View file
Open in desktop
Expand Up @@ -56,3 +56,180 @@ function f() {<CRLF>

================================================================================
`;

exports[`multiline.js 1`] = `
====================================options=====================================
endOfLine: "lf"
parsers: ["babel"]
printWidth: 80
| printWidth
=====================================input======================================
type IAmIncredibleLongParameterType = {};<LF>
const IAmAnotherFunctionName = (_0: IAmIncredibleLongParameterType) => {};<LF>
export const IAmIncredibleLongFunctionName = IAmAnotherFunctionName(<LF>
(_0: IAmIncredibleLongParameterType) => {<LF>
setTimeout(() => {<LF>
/*<LF>
Multiline comment<LF>
Multiline comment<LF>
Multiline comment<LF>
*/<LF>
console.log(<LF>
'Multiline string\\<LF>
Multiline string\\<LF>
Multiline string'<LF>
);<LF>
console.log(<LF>
\`Multiline \\n string\\<LF>
Multiline string\\<LF>
Multiline string\`<LF>
);<LF>
});<LF>
}<LF>
);<LF>

=====================================output=====================================
type IAmIncredibleLongParameterType = {};<LF>
const IAmAnotherFunctionName = (_0: IAmIncredibleLongParameterType) => {};<LF>
export const IAmIncredibleLongFunctionName = IAmAnotherFunctionName(<LF>
(_0: IAmIncredibleLongParameterType) => {<LF>
setTimeout(() => {<LF>
/*<LF>
Multiline comment<LF>
Multiline comment<LF>
Multiline comment<LF>
*/<LF>
console.log(<LF>
"Multiline string\\<LF>
Multiline string\\<LF>
Multiline string"<LF>
);<LF>
console.log(<LF>
\`Multiline \\n string\\<LF>
Multiline string\\<LF>
Multiline string\`<LF>
);<LF>
});<LF>
}<LF>
);<LF>

================================================================================
`;

exports[`multiline.js 2`] = `
====================================options=====================================
endOfLine: "cr"
parsers: ["babel"]
printWidth: 80
| printWidth
=====================================input======================================
type IAmIncredibleLongParameterType = {};<LF>
const IAmAnotherFunctionName = (_0: IAmIncredibleLongParameterType) => {};<LF>
export const IAmIncredibleLongFunctionName = IAmAnotherFunctionName(<LF>
(_0: IAmIncredibleLongParameterType) => {<LF>
setTimeout(() => {<LF>
/*<LF>
Multiline comment<LF>
Multiline comment<LF>
Multiline comment<LF>
*/<LF>
console.log(<LF>
'Multiline string\\<LF>
Multiline string\\<LF>
Multiline string'<LF>
);<LF>
console.log(<LF>
\`Multiline \\n string\\<LF>
Multiline string\\<LF>
Multiline string\`<LF>
);<LF>
});<LF>
}<LF>
);<LF>

=====================================output=====================================
type IAmIncredibleLongParameterType = {};<CR>
const IAmAnotherFunctionName = (_0: IAmIncredibleLongParameterType) => {};<CR>
export const IAmIncredibleLongFunctionName = IAmAnotherFunctionName(<CR>
(_0: IAmIncredibleLongParameterType) => {<CR>
setTimeout(() => {<CR>
/*<CR>
Multiline comment<CR>
Multiline comment<CR>
Multiline comment<CR>
*/<CR>
console.log(<CR>
"Multiline string\\<CR>
Multiline string\\<CR>
Multiline string"<CR>
);<CR>
console.log(<CR>
\`Multiline \\n string\\<CR>
Multiline string\\<CR>
Multiline string\`<CR>
);<CR>
});<CR>
}<CR>
);<CR>

================================================================================
`;

exports[`multiline.js 3`] = `
====================================options=====================================
endOfLine: "crlf"
parsers: ["babel"]
printWidth: 80
| printWidth
=====================================input======================================
type IAmIncredibleLongParameterType = {};<LF>
const IAmAnotherFunctionName = (_0: IAmIncredibleLongParameterType) => {};<LF>
export const IAmIncredibleLongFunctionName = IAmAnotherFunctionName(<LF>
(_0: IAmIncredibleLongParameterType) => {<LF>
setTimeout(() => {<LF>
/*<LF>
Multiline comment<LF>
Multiline comment<LF>
Multiline comment<LF>
*/<LF>
console.log(<LF>
'Multiline string\\<LF>
Multiline string\\<LF>
Multiline string'<LF>
);<LF>
console.log(<LF>
\`Multiline \\n string\\<LF>
Multiline string\\<LF>
Multiline string\`<LF>
);<LF>
});<LF>
}<LF>
);<LF>

=====================================output=====================================
type IAmIncredibleLongParameterType = {};<CRLF>
const IAmAnotherFunctionName = (_0: IAmIncredibleLongParameterType) => {};<CRLF>
export const IAmIncredibleLongFunctionName = IAmAnotherFunctionName(<CRLF>
(_0: IAmIncredibleLongParameterType) => {<CRLF>
setTimeout(() => {<CRLF>
/*<CRLF>
Multiline comment<CRLF>
Multiline comment<CRLF>
Multiline comment<CRLF>
*/<CRLF>
console.log(<CRLF>
"Multiline string\\<CRLF>
Multiline string\\<CRLF>
Multiline string"<CRLF>
);<CRLF>
console.log(<CRLF>
\`Multiline \\n string\\<CRLF>
Multiline string\\<CRLF>
Multiline string\`<CRLF>
);<CRLF>
});<CRLF>
}<CRLF>
);<CRLF>

================================================================================
`;
23 changes: 23 additions & 0 deletions tests/end_of_line/multiline.js
View file
Open in desktop
@@ -0,0 +1,23 @@
type IAmIncredibleLongParameterType = {};
const IAmAnotherFunctionName = (_0: IAmIncredibleLongParameterType) => {};
export const IAmIncredibleLongFunctionName = IAmAnotherFunctionName(
(_0: IAmIncredibleLongParameterType) => {
setTimeout(() => {
/*
Multiline comment
Multiline comment
Multiline comment
*/
console.log(
'Multiline string\
Multiline string\
Multiline string'
);
console.log(
`Multiline \n string\
Multiline string\
Multiline string`
);
});
}
);