Skip to content

USWDS-Compile: Support configuring sass-embedded #145

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

Closed
mdmower-csnw wants to merge 8 commits into from
Closed

USWDS-Compile: Support configuring sass-embedded #145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
058337b
Use gulp-sass 6.0
thisisdano Jan 5, 2025
752dcd6
Use modern Sass API
thisisdano Jan 5, 2025
adfef14
Merge remote-tracking branch 'upstream/develop' into mdm-sass-options
mdmower-csnw Feb 6, 2025
8f44741
Support sass-embedded options
mdmower-csnw Feb 6, 2025
f02f129
(Revisions) Support sass-embedded options
mdmower-csnw Feb 11, 2025
a26fc24
Merge remote-tracking branch 'upstream/develop' into dw-gulp-sass-update
mdmower-csnw Dec 15, 2025
d1b7ae6
Update to gulp-sass v6.0.1
mdmower-csnw Dec 15, 2025
b9a463b
Merge branch 'dw-mdm-gulp-sass-update' into mdm-sass-options
mdmower-csnw Dec 15, 2025
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
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,12 +96,12 @@ Use path settings to customize where USWDS Compile looks for USWDS source and ou

### Additional settings

| Setting | Default | Description |
| --------------------------------- | -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `sprite.projectIconsOnly` | `false` | Include _only_ the icons in `paths.src.projectIcons` in the icon sprite. |
| `settings.compile.browserslist` | `["> 2%", "last 2 versions", "IE 11", "not dead"]` | Define the [browserslist query](https://github.com/browserslist/browserslist?tab=readme-ov-file#queries) for CSS prefixes generated by [autoprefixer](https://github.com/postcss/autoprefixer). |
| `settings.compile.sassSourcemaps` | `true` | Include sourcemap when compiling SASS to CSS. |
| `settings.compile.sassDeprecationWarnings` | `false` | Show USWDS Sass deprecation warnings. When set to `true`, Sass will output deprecation warnings for USWDS code in the terminal during compilation. Deprecation warnings for non-USWDS Sass will output even when this value is set to `false`. |
| Setting | Default | Description |
| --------------------------------- | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `sprite.projectIconsOnly` | `false` | Include _only_ the icons in `paths.src.projectIcons` in the icon sprite. |
| `settings.compile.browserslist` | `["> 2%", "last 2 versions", "IE 11", "not dead"]` | Define the [browserslist query](https://github.com/browserslist/browserslist?tab=readme-ov-file#queries) for CSS prefixes generated by [autoprefixer](https://github.com/postcss/autoprefixer). |
| `settings.compile.sassSourcemaps` | `true` | Include sourcemap when compiling SASS to CSS. |
| `settings.compile.sassOptions` | `{quietDeps: true, style: "compressed"}` | Configure [sass-embedded options](https://sass-lang.com/documentation/js-api/interfaces/options/). By default SASS deprecation warnings arising from USWDS source are hidden and output CSS is minified. These options can be overridden and additional options specified. When `loadPaths` is defined, the paths are appended to those necessary for USWDS compilation. The `watch` script will also watch these directories for changes. |

### Functions

Expand Down
34 changes: 29 additions & 5 deletions gulpfile.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,19 @@ let settings = {
},
browserslist: ["> 2%", "last 2 versions", "IE 11", "not dead"],
sassSourcemaps: true,
sassDeprecationWarnings: false,
/**
* @type {boolean | undefined}
* @deprecated Set `sassOptions.quietDeps` instead. */
sassDeprecationWarnings: undefined,
/**
* @type {import('sass-embedded').Options<"async">}
* @default
* {
* quietDeps: true,
* style: "compressed"
* }
*/
sassOptions: {},
},
sprite: {
width: 24,
Expand Down Expand Up @@ -190,7 +202,9 @@ function buildSass() {
grid: true,
overrideBrowserslist: settings.compile.browserslist,
}),
csso({ forceMediaMerge: false }),
...(settings.compile.sassOptions.style === "expanded"
? []
: [csso({ forceMediaMerge: false })]),
],
includes: [
// 1. local theme files
Expand All @@ -209,9 +223,16 @@ function buildSass() {
})
.pipe(
sass({
outputStyle: "compressed",
includePaths: buildSettings.includes,
quietDeps: !settings.compile.sassDeprecationWarnings,
style: "compressed",
...settings.compile.sassOptions,
loadPaths: [
...buildSettings.includes,
...(settings.compile.sassOptions.loadPaths ?? []),
Comment thread
mdmower-csnw marked this conversation as resolved.
],
quietDeps:
settings.compile.sassDeprecationWarnings !== undefined
? !settings.compile.sassDeprecationWarnings
: settings.compile.sassOptions.quietDeps ?? true,
}).on("error", handleError)
)
.pipe(replace(/\buswds @version\b/g, `based on uswds v${pkg}`))
Expand All @@ -228,6 +249,9 @@ function watchSass() {
[
`${paths.dist.theme}/**/*.scss`.replace("//", "/"),
`${paths.src.projectSass}/**/*.scss`.replace("//", "/"),
...(settings.compile.sassOptions.loadPaths ?? []).map((loadPath) =>
`${loadPath}/**/*.scss`.replace("//", "/")
),
],
buildSass
);
Expand Down
8 changes: 4 additions & 4 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"gulp-postcss": "9.0.1",
"gulp-rename": "2.0.0",
"gulp-replace": "1.1.4",
"gulp-sass": "5.1.0",
"gulp-sass": "6.0.1",
"gulp-svgstore": "9.0.0",
"postcss": "8.5.2",
"postcss-csso": "6.0.1",
Expand Down