search

AlaskaAirlines / WebCoreStyleSheets

The core front-end framework for building experiences with the Orion Design System and transition to the Auro Design System.
https://auro.alaskaair.com/webcorestylesheets
Apache License 2.0
5 stars 5 forks source link

Unnecessary tilde in import in documentation #190

Closed B-E-A-F closed 3 months ago

B-E-A-F commented 7 months ago

Please verify the version of auro-wcss you have installed

4.3.1

Please describe the bug

  1. Attempt to import with tilde
  2. See outputted error
  3. Remove tilde
  4. See successful import

Reproducing the error

None

Expected behavior

Documentation should just use a regular import statement: @import '~@aurodesignsystem/webcorestylesheets/src/breakpoints'; should just be @import '@aurodesignsystem/webcorestylesheets/src/breakpoints';

What browsers are you seeing the problem on?

No response

Additional context

I don't think anyone using a modern bundler is going to have to reference node_modules via a ~. It will actually output an error in some scenarios where your project does not support / allow ~ imports.

Exit criteria

Documentation is updated or clarified

blackfalcon commented 6 months ago

Hi @ArcherScript,

Thank you for raising this issue and we are sorry that you ran into problems with the directions.

As for your statement that no modern bundler would reference the node_modules using the ~ is not 100% accurate. Using the ~ was part of the Webpack Sass loader API, although it is now deprecated. We just haven't updated the docs yet.

I recommend the following:

  1. Remove the references to the ~ in the docs
  2. Place more emphasis on the pre-processed CSS assets over the Sass use
  3. Update the Sass imports documentation to be more agnostic of front-end platform.