[web] Update aliases for using ~/ instead of @ #400
Merged
Conversation
dgdavid
commented
Jan 19, 2023
| "~icons/*": ["node_modules/@material-symbols/svg-400/outlined/*"] | ||
| "~/*": ["src/*"], | ||
| "~/client": ["src/client/index.js"], | ||
| "@icons/*": ["node_modules/@material-symbols/svg-400/outlined/*"] |
Contributor
Author
There was a problem hiding this comment.
Use the @ here because this alias actually is a shortcut for an import from a node package.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Because "@" is used by npm for packages published under a named scope[1]. From their documentation: > The scope name is everything between the @ and the slash Additionally, "~" use to kind of means "home" or "root", which suits well for an alias pointing to the "root" directory. Consequently, it is easier to understand now whether an import comes from a dependency or the source code of the project. [1] https://docs.npmjs.com/about-scopes
Since we are not alising nested routes (e.g., ~/layout for src/components/layout or ~/core for src/components/core), most of defined aliases were actually redundant.
dgdavid
force-pushed
the
change-aliases
branch
from
e608524 to
b850b67
Compare
imobachgs
approved these changes
Jan 19, 2023
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Because "@" is used by npm for packages published under a named scope. From their documentation:
Additionally, "~" use to kind of means "home" or "root", which suits well for an alias pointing to the "root" directory.
Consequently, it is easier to understand now whether an import comes from a dependency or the source code of the project.
Related to #325 and f33e327