Thanks to visit codestin.com
Credit goes to github.com

Skip to content

USWDS - Core: Remove twig-html-loader dependency #6166

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
Merged
merged 1 commit into from
Nov 6, 2024
Merged

USWDS - Core: Remove twig-html-loader dependency #6166

merged 1 commit into from
Nov 6, 2024

Conversation

@mejiaj
Copy link
Contributor

@mejiaj mejiaj commented Oct 30, 2024 •
edited
Loading

Summary

Removed unused webpack dependency. We're not using the twig-html-loader dependency in uswds or uswds-site. It's been removed to reduce the number of dependencies.

Originated in #5832. Thanks again to @aduth for this contribution.

Breaking change

This is not a breaking change.

Related issue

Closes #6082.

Related pull requests

This is an internal change.

Preview link

Preview link →. There shouldn't be any regressions.

Problem statement

We wanted to confirm there were no regressions here or on uswds-site before removing the dependency. We build twig templates in this repo as part of our CI to ensure there aren't breaking changes to our component previews on site.

Solution

This specific dependency isn't needed and removed to have one less to worry about.

Testing and review

  1. Run npm run build:html
  2. Templates should still work as expected
  3. On uswds-site; checkout branch remove-deps-uswds-6082
  4. Confirm you can install and run locally npm install && npm start
  5. Visit component previews (code included) and confirm there aren't regressions

Dependency updates

Dependency name Previous version New version
twig-html-loader 0.1.9 --

@mejiaj mejiaj mentioned this pull request Oct 30, 2024
Closed
@mejiaj mejiaj marked this pull request as ready for review October 31, 2024 14:40
mahoneycm
mahoneycm approved these changes Oct 31, 2024
View reviewed changes
Copy link
Contributor

@mahoneycm mahoneycm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

  • Builds html-templates directory appropriately
  • Builds component preview HTML on site
  • Builds template HTML on site
  • No references to the removed dependency

amyleadem
amyleadem reviewed Nov 1, 2024
View reviewed changes
Copy link
Contributor

@amyleadem amyleadem left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I installed this branch on uswds-site and received a bunch of Error: Cannot find module 'twig' errors when running npm run build.

Removing the --legacy-peer-deps flag from the gulp build.js file does appear to resolve the errors. (For reference, the flag was added in this commit)

  1. Curious if anyone else encounters these errors on site?
  2. If yes, is it reasonable to remove that flag in the uswds-site repo to make this work?

@mahoneycm
Copy link
Contributor

@amyleadem I didn't notice the error after installing this branch. Looks like it doesn't happen on CI either since the checks passed and the preview built. If you run a clean install before installing this branch, are you still seeing the errors?

@amyleadem
Copy link
Contributor

@mahoneycm Yep, did a clean install. Did you remove the existing site directory before running npm run build on uswds-site?

@mahoneycm
Copy link
Contributor

@amyleadem oh I did not. Removing the directory did cause the build errors you mentioned before. Great catch! Removing --legacy-peer-deps resolved the build errors for me. It looks to me like it'd be a good idea to remove it on site when we install the next release branch

amyleadem
amyleadem approved these changes Nov 1, 2024
View reviewed changes
Copy link
Contributor

@amyleadem amyleadem left a comment •
edited by mejiaj
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: @mejiaj highlighted that the --legacy-peer-deps flag has been removed as part of the remove-deps-uswds-6082 test branch and this change should be included in the release. Approving this with the note that we should convert this uswds-site change to a PR that gets published with the other release doc updates.

@amyleadem amyleadem requested a review from thisisdano November 1, 2024 20:26
@amyleadem amyleadem mentioned this pull request Nov 5, 2024
Merged
23 tasks
@mejiaj
Copy link
Contributor Author

mejiaj commented Nov 6, 2024

I've renamed the site branch [remove-deps-uswds-6082] and updated the PR - uswds/uswds-site#2950.

@thisisdano thisisdano merged commit d0722a7 into develop Nov 6, 2024
5 checks passed
@thisisdano thisisdano deleted the jm-remove-deps-6082 branch November 6, 2024 21:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mandylloyd mandylloyd Awaiting requested review from mandylloyd

@CTGM-Bixal CTGM-Bixal Awaiting requested review from CTGM-Bixal

@cathybaptista cathybaptista Awaiting requested review from cathybaptista

3 more reviewers

@thisisdano thisisdano thisisdano approved these changes

@mahoneycm mahoneycm mahoneycm approved these changes

@amyleadem amyleadem amyleadem approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

USWDS - Enhancement: Remove twig-html-loader dependency

5 participants

@mejiaj @mahoneycm @amyleadem @thisisdano