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

Improve with (...) formatting #11637

Merged
merged 5 commits into from Oct 19, 2021
Merged

Improve with (...) formatting #11637

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
841ed48
Null checking
sosukesuzuki Oct 8, 2021
49c8353
Improve configuration formatting
sosukesuzuki Oct 8, 2021
338447e
Add tests
sosukesuzuki Oct 8, 2021
6e2cd50
Add changelog
sosukesuzuki Oct 9, 2021
d37c451
Format
sosukesuzuki Oct 9, 2021
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
21 changes: 21 additions & 0 deletions changelog_unreleased/scss/11637.md
View file
Open in desktop
@@ -0,0 +1,21 @@
#### Improve `with (...)` formatting (#11637 by @sosukesuzuki)

<!-- prettier-ignore -->
```scss
// Input
@use 'library' with (
$black: #222,
$border-radius: 0.1rem $font-family: 'Helvetica, sans-serif'
);

// Prettier stable
@use 'library' with
($black: #222, $border-radius: 0.1rem $font-family: 'Helvetica, sans-serif');

// Prettier main
@use 'library' with (
$black: #222,
$border-radius: 0.1rem $font-family: 'Helvetica, sans-serif'
);

```
22 changes: 20 additions & 2 deletions src/language-css/printer-postcss.js
View file
Open in desktop
Expand Up @@ -74,6 +74,7 @@ const {
isColorAdjusterFuncNode,
lastLineHasInlineComment,
isAtWordPlaceholderNode,
isConfigurationNode,
} = require("./utils.js");
const { locStart, locEnd } = require("./loc.js");

Expand Down Expand Up @@ -807,6 +808,19 @@ function genericPrint(path, options, print) {
continue;
}

if (
iNode.value === "with" &&
iNextNode &&
iNextNode.type === "value-paren_group" &&
iNextNode.open &&
iNextNode.open.value === "(" &&
iNextNode.close &&
iNextNode.close.value === ")"
) {
parts.push(" ");
continue;
}

// Be default all values go through `line`
parts.push(line);
}
Expand Down Expand Up @@ -872,6 +886,10 @@ function genericPrint(path, options, print) {
const lastItem = getLast(node.groups);
const isLastItemComment = lastItem && lastItem.type === "value-comment";
const isKey = isKeyInValuePairNode(node, parentNode);
const isConfiguration = isConfigurationNode(node, parentNode);

const shouldBreak = isConfiguration || (isSCSSMapItem && !isKey);
const shouldDedent = isConfiguration || isKey;

const printed = group(
[
Expand Down Expand Up @@ -915,11 +933,11 @@ function genericPrint(path, options, print) {
node.close ? print("close") : "",
],
{
shouldBreak: isSCSSMapItem && !isKey,
shouldBreak,
}
);

return isKey ? dedent(printed) : printed;
return shouldDedent ? dedent(printed) : printed;
}
case "value-func": {
return [
Expand Down
25 changes: 25 additions & 0 deletions src/language-css/utils.js
View file
Open in desktop
Expand Up @@ -484,6 +484,30 @@ function isModuleRuleName(name) {
return moduleRuleNames.has(name);
}

function isConfigurationNode(node, parentNode) {
if (
!node.open ||
node.open.value !== "(" ||
!node.close ||
node.close.value !== ")" ||
node.groups.some((group) => group.type !== "value-comma_group")
) {
return false;
}
if (parentNode.type === "value-comma_group") {
const prevIdx = parentNode.groups.indexOf(node) - 1;
const maybeWithNode = parentNode.groups[prevIdx];
if (
maybeWithNode &&
maybeWithNode.type === "value-word" &&
maybeWithNode.value === "with"
) {
return true;
}
}
return false;
}

module.exports = {
getAncestorCounter,
getAncestorNode,
Expand Down Expand Up @@ -539,4 +563,5 @@ module.exports = {
stringifyNode,
isAtWordPlaceholderNode,
isModuleRuleName,
isConfigurationNode,
};
94 changes: 94 additions & 0 deletions tests/format/scss/configuration/__snapshots__/jsfmt.spec.js.snap
View file
Open in desktop
@@ -0,0 +1,94 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`use.scss - {"trailingComma":"none"} format 1`] = `
====================================options=====================================
parsers: ["scss"]
printWidth: 80
trailingComma: "none"
| printWidth
=====================================input======================================
@use "@fylgja/base" with (
$family-main: (
Rubik,
Roboto,
system-ui,
sans-serif,
),
$font-weight: 350,
$h1-font-weight: 500,
$h2-font-weight: 500,
$h3-font-weight: 500
);

@use 'library' with (
$black: #222,
$border-radius: 0.1rem
);

=====================================output=====================================
@use "@fylgja/base" with (
$family-main: (
Rubik,
Roboto,
system-ui,
sans-serif
),
$font-weight: 350,
$h1-font-weight: 500,
$h2-font-weight: 500,
$h3-font-weight: 500
);

@use "library" with (
$black: #222,
$border-radius: 0.1rem
);

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

exports[`use.scss format 1`] = `
====================================options=====================================
parsers: ["scss"]
printWidth: 80
| printWidth
=====================================input======================================
@use "@fylgja/base" with (
$family-main: (
Rubik,
Roboto,
system-ui,
sans-serif,
),
$font-weight: 350,
$h1-font-weight: 500,
$h2-font-weight: 500,
$h3-font-weight: 500
);

@use 'library' with (
$black: #222,
$border-radius: 0.1rem
);

=====================================output=====================================
@use "@fylgja/base" with (
$family-main: (
Rubik,
Roboto,
system-ui,
sans-serif,
),
$font-weight: 350,
$h1-font-weight: 500,
$h2-font-weight: 500,
$h3-font-weight: 500
);

@use "library" with (
$black: #222,
$border-radius: 0.1rem
);

================================================================================
`;
2 changes: 2 additions & 0 deletions tests/format/scss/configuration/jsfmt.spec.js
View file
Open in desktop
@@ -0,0 +1,2 @@
run_spec(__dirname, ["scss"], { trailingComma: "none" });
run_spec(__dirname, ["scss"]);
17 changes: 17 additions & 0 deletions tests/format/scss/configuration/use.scss
View file
Open in desktop
@@ -0,0 +1,17 @@
@use "@fylgja/base" with (
$family-main: (
Rubik,
Roboto,
system-ui,
sans-serif,
),
$font-weight: 350,
$h1-font-weight: 500,
$h2-font-weight: 500,
$h3-font-weight: 500
);

@use 'library' with (
$black: #222,
$border-radius: 0.1rem
);
12 changes: 8 additions & 4 deletions tests/format/scss/quotes/__snapshots__/jsfmt.spec.js.snap
View file
Open in desktop
Expand Up @@ -34,8 +34,10 @@ singleQuote: true
=====================================output=====================================
@use 'library';

@use 'library' with
($black: #222, $border-radius: 0.1rem $font-family: 'Helvetica, sans-serif');
@use 'library' with (
$black: #222,
$border-radius: 0.1rem $font-family: 'Helvetica, sans-serif'
);

@use 'library' as *;

Expand Down Expand Up @@ -89,8 +91,10 @@ printWidth: 80
=====================================output=====================================
@use "library";

@use "library" with
($black: #222, $border-radius: 0.1rem $font-family: "Helvetica, sans-serif");
@use "library" with (
$black: #222,
$border-radius: 0.1rem $font-family: "Helvetica, sans-serif"
);

@use "library" as *;

Expand Down