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.

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

USWDS-Compile: Support configuring sass-embedded #145

Draft
wants to merge 6 commits into
base: dw-gulp-sass-update
Choose a base branch
from

Conversation

mdmower-csnw
Copy link
Contributor

@mdmower-csnw mdmower-csnw commented Feb 6, 2025

This pull request builds on top of #140 which is still in draft status. Once that pull request is merged into develop, this PR will retarget to the develop branch, at which point I'll resolve any conflicts and move it out of draft status. Note that there aren't actually any dependency updates here. This PR includes a merge of the latest from develop and those changes will automatically disappear when dw-gulp-sass-update is updated.

Summary

Add support for configuring sass-embedded options. This improves this flexibility of uswds-compile for consumers.

  • Add sassOptions to settings.compile.
    • Include type hints from sass-embedded Options. Until @types/gulp-sass is updated for v6, this is more correct than using GulpSassOptions from @types/gulp-sass which is based on node-sass.
    • Indicate default options that will apply unless overridden.
    • If loadPaths are defined, watch these paths for changes when the watch script is running.
  • Deprecate (but still support) sassDeprecationWarnings.
    • Include JSDoc deprecation notice.
  • Better support SASS option style when set to expanded to avoid running CSSO minification. This improves source map reliability.
  • Update readme.

Related issue

Closes #133
Closes #80
Closes #59

Testing and review

A testing pull request has been prepared for the sandbox: uswds/uswds-sandbox#180 . Sample tests to get you started are included in that PR description.

cathybaptista and others added 5 commits January 14, 2025 10:56
Bumps [undici](https://github.com/nodejs/undici) from 6.21.0 to 6.21.1.
- [Release notes](https://github.com/nodejs/undici/releases)
- [Commits](nodejs/undici@v6.21.0...v6.21.1)

---
updated-dependencies:
- dependency-name: undici
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>
USWDS-Compile - POAM: January ‘25
- Add `sassOptions` to `settings.compile`.
  - Include type hints from `sass-embedded` Options. Until
    `@types/gulp-sass` is updated for v6, this is more correct than
    using `GulpSassOptions` from `@types/gulp-sass` which is based on
    `node-sass`.
  - Indicate default options that will apply unless overridden.
- Deprecate (but still support) `sassDeprecationWarnings`.
  - Include JSDoc deprecation notice.
- Better support SASS option `style` when set to `expanded` to avoid
  running CSSO minification. This improves source map reliability.
- Watch `loadPaths` for changes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants