USWDS-Site: Error writeup - uswds-core config

[amyleadem]

Description

Closes #1690

Preview links:

• Migrating to 3.0
• Settings

Purpose

Update documentation surrounding the configuration of @use "uswds-core" with() to include a note about error handling. If configured improperly, users can receive an error message that might point them in the wrong direction. Adding a note to clarify what to do when receiving this error should help users get unstuck and successfully compile their .scss files.

Related error message:

Error: This module was already loaded, so it can't be configured using "with".
   ┌──> node_modules/@uswds/uswds/packages/uswds-core/src/styles/variables/_index.scss
16 │   @forward "project-defaults";
   │   ^^^^^^^^^^^^^^^^^^^^^^^^^^^ new load
   ╵
   ┌──> node_modules/@uswds/uswds/packages/uswds-core/src/styles/functions/general/get-default.scss
14 │   @use "../../variables/project-defaults" as *;
   │   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ original load

Relevant slack threads related to this error:

• USWDS: 04/07/22
• USWDS-Public: 06/16/22
• USWDS-Public: 06/29/22

Additional information

Before you hit Submit, make sure you’ve done whichever of these applies to you:

• Follow the 18F Front End Coding Style Guide and Accessibility Guide.
• Run npm test and make sure the tests for the files you have changed have passed.
• Run your code through HTML_CodeSniffer and make sure it’s error free.
• Title your pull request using this format: [Website] - [UI component]: Brief statement describing what this pull request solves.

[mejiaj]

LGTM, thanks Amy!