Skip to content

feat(yaml): normalize scalars before formatting #254

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
merged 1 commit into from
Jan 29, 2021
Merged

feat(yaml): normalize scalars before formatting #254

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 23 additions & 11 deletions apidom/packages/apidom-ast/src/nodes/yaml/YamlScalar/formats.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,11 +78,18 @@ const chomp = (indicator: '+' | '-' | undefined, value: string): string => {
return value;
};

// prevent escaped newlines from being converted to a space
const preventNlCollapseToSpace = (val: string) => val.replace(/\\\n\s*/g, '');
/**
* Normalizes lines breaks.
* https://yaml.org/spec/1.2/spec.html#line%20break/normalization/
*/
// @ts-ignore
const normalizeLineBreaks = (val: string) => val.replace(/\r\n/g, '\n');

// prevent escaped line breaks from being converted to a space
const preventLineBreakCollapseToSpace = (val: string) => val.replace(/\\\n\s*/g, '');

// collapse newlines into spaces
const collapseNlToSpace = (val: string) =>
// collapse line breaks into spaces
const collapseLineBreakToSpace = (val: string) =>
val
.replace(/(?<![\n]+)\n([^\n]+)/g, (match: string, p1: string) => ` ${p1.trimLeft()}`)
.replace(/[\n]{2}/g, '\n');
Expand All @@ -98,8 +105,9 @@ const removeQuotes = curry((quoteType, val) =>
export const formatFlowPlain = pipe(
// @ts-ignore
prop('text'),
normalizeLineBreaks,
trim,
collapseNlToSpace,
collapseLineBreakToSpace,
split('\n'),
map(trimStart),
join('\n'),
Expand All @@ -113,9 +121,10 @@ export const formatFlowPlain = pipe(
export const formatFlowSingleQuoted = pipe(
// @ts-ignore
prop('text'),
normalizeLineBreaks,
trim,
removeQuotes("'"),
collapseNlToSpace,
collapseLineBreakToSpace,
split('\n'),
map(trimStart),
join('\n'),
Expand All @@ -128,10 +137,11 @@ export const formatFlowSingleQuoted = pipe(
export const formatFlowDoubleQuoted = pipe(
// @ts-ignore
prop('text'),
normalizeLineBreaks,
trim,
removeQuotes('"'),
preventNlCollapseToSpace,
collapseNlToSpace,
preventLineBreakCollapseToSpace,
collapseLineBreakToSpace,
unraw,
split('\n'),
map(trimStart),
Expand All @@ -145,7 +155,8 @@ export const formatFlowDoubleQuoted = pipe(
export const formatBlockLiteral = (scalarNode: any): string => {
const indentation = getIndentation(scalarNode);
const chompingIndicator = getChompingIndicator(scalarNode);
const lines = tail(scalarNode.text.split('\n')); // first line only contains indicators
const normalized = normalizeLineBreaks(scalarNode.text);
const lines = tail(normalized.split('\n')); // first line only contains indicators
const transducer = compose(map(trimCharsStart(indentation)), map(concatRight('\n')));
// @ts-ignore
const deindented: string = transduce(transducer, concat, '', lines);
Expand All @@ -160,11 +171,12 @@ export const formatBlockLiteral = (scalarNode: any): string => {
export const formatBlockFolded = (scalarNode: any): string => {
const indentation = getIndentation(scalarNode);
const chompingIndicator = getChompingIndicator(scalarNode);
const lines = tail(scalarNode.text.split('\n')); // first line only contains indicators
const normalized = normalizeLineBreaks(scalarNode.text);
const lines = tail(normalized.split('\n')); // first line only contains indicators
const transducer = compose(map(trimCharsStart(indentation)), map(concatRight('\n')));
// @ts-ignore
const deindented: string = transduce(transducer, concat, '', lines);
const collapsed = collapseNlToSpace(deindented);
const collapsed = collapseLineBreakToSpace(deindented);

return chomp(chompingIndicator, collapsed);
};