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.

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

Use @/ to show module alias instead of @ prefixed #12600

Merged
merged 3 commits into from
May 11, 2020
Merged

Use @/ to show module alias instead of @ prefixed #12600

merged 3 commits into from
May 11, 2020

Conversation

belgattitude
Copy link
Contributor

@belgattitude belgattitude commented May 7, 2020 •
edited

Even being a common practice, the use of reserved '@' for prefixing module aliases should not be promoted in doc.

Why ?

Will hurt when an org publishes a '@core/xxx" package.

Just changed the prefix by '_' in the example, but curious to know what are the practices here.

NexJs rock ! Thanks for making it truly awesome.

@belgattitude belgattitude requested a review from Timer as a code owner May 7, 2020 13:48
@belgattitude belgattitude changed the title docs: controversial '@' prefix aliases should not be used docs'module-alias): controversial '@' prefix should not be used May 7, 2020
@belgattitude belgattitude changed the title docs'module-alias): controversial '@' prefix should not be used docs(module-alias): controversial '@' prefix should not be used May 7, 2020
@ijjk
Copy link
Member

ijjk commented May 7, 2020

Stats from current PR

Default Server Mode (Increase detected ⚠️)
General
zeit/next.js canary belgattitude/next.js docs/safer-module-aliases Change
buildDuration 12.9s 13.7s ⚠️ +788ms
nodeModulesSize 58.8 MB 58.8 MB ✓
Page Load Tests Overall increase ✓
zeit/next.js canary belgattitude/next.js docs/safer-module-aliases Change
/ failed reqs 0 0 ✓
/ total time (seconds) 2.358 2.173 -0.19
/ avg req/sec 1060.15 1150.43 ⚠️ +90.28
/error-in-render failed reqs 0 0 ✓
/error-in-render total time (seconds) 1.459 1.445 -0.01
/error-in-render avg req/sec 1713.54 1729.89 ⚠️ +16.35
Client Bundles (main, webpack, commons)
zeit/next.js canary belgattitude/next.js docs/safer-module-aliases Change
main-HASH.js gzip 6.23 kB 6.23 kB ✓
webpack-HASH.js gzip 746 B 746 B ✓
de003c3a9d30..5232.js gzip 10.3 kB 10.3 kB ✓
framework.HASH.js gzip 39.1 kB 39.1 kB ✓
Overall change 56.4 kB 56.4 kB ✓
Client Bundles (main, webpack, commons) Modern
zeit/next.js canary belgattitude/next.js docs/safer-module-aliases Change
main-HASH.module.js gzip 4.83 kB 4.83 kB ✓
webpack-HASH..dule.js gzip 746 B 746 B ✓
de003c3a9d30..dule.js gzip 6.88 kB 6.88 kB ✓
framework.HA..dule.js gzip 39.1 kB 39.1 kB ✓
Overall change 51.6 kB 51.6 kB ✓
Legacy Client Bundles (polyfills)
zeit/next.js canary belgattitude/next.js docs/safer-module-aliases Change
polyfills-HASH.js gzip 26.3 kB 26.3 kB ✓
Overall change 26.3 kB 26.3 kB ✓
Client Pages
zeit/next.js canary belgattitude/next.js docs/safer-module-aliases Change
_app.js gzip 1.23 kB 1.23 kB ✓
_error.js gzip 3.13 kB 3.13 kB ✓
hooks.js gzip 663 B 663 B ✓
index.js gzip 222 B 222 B ✓
link.js gzip 2.06 kB 2.06 kB ✓
routerDirect.js gzip 280 B 280 B ✓
withRouter.js gzip 278 B 278 B ✓
Overall change 7.86 kB 7.86 kB ✓
Client Pages Modern
zeit/next.js canary belgattitude/next.js docs/safer-module-aliases Change
_app.module.js gzip 598 B 598 B ✓
_error.module.js gzip 2.09 kB 2.09 kB ✓
hooks.module.js gzip 383 B 383 B ✓
index.module.js gzip 223 B 223 B ✓
link.module.js gzip 1.52 kB 1.52 kB ✓
routerDirect..dule.js gzip 279 B 279 B ✓
withRouter.m..dule.js gzip 278 B 278 B ✓
Overall change 5.37 kB 5.37 kB ✓
Client Build Manifests
zeit/next.js canary belgattitude/next.js docs/safer-module-aliases Change
_buildManifest.js gzip 61 B 61 B ✓
_buildManife..dule.js gzip 61 B 61 B ✓
Overall change 122 B 122 B ✓
Rendered Page Sizes
zeit/next.js canary belgattitude/next.js docs/safer-module-aliases Change
index.html gzip 926 B 926 B ✓
link.html gzip 936 B 936 B ✓
withRouter.html gzip 924 B 924 B ✓
Overall change 2.79 kB 2.79 kB ✓
Serverless Mode
General
zeit/next.js canary belgattitude/next.js docs/safer-module-aliases Change
buildDuration 14.2s 14.3s ⚠️ +95ms
nodeModulesSize 58.8 MB 58.8 MB ✓
Client Bundles (main, webpack, commons)
zeit/next.js canary belgattitude/next.js docs/safer-module-aliases Change
main-HASH.js gzip 6.23 kB 6.23 kB ✓
webpack-HASH.js gzip 746 B 746 B ✓
de003c3a9d30..5232.js gzip 10.3 kB 10.3 kB ✓
framework.HASH.js gzip 39.1 kB 39.1 kB ✓
Overall change 56.4 kB 56.4 kB ✓
Client Bundles (main, webpack, commons) Modern
zeit/next.js canary belgattitude/next.js docs/safer-module-aliases Change
main-HASH.module.js gzip 4.83 kB 4.83 kB ✓
webpack-HASH..dule.js gzip 746 B 746 B ✓
de003c3a9d30..dule.js gzip 6.88 kB 6.88 kB ✓
framework.HA..dule.js gzip 39.1 kB 39.1 kB ✓
Overall change 51.6 kB 51.6 kB ✓
Legacy Client Bundles (polyfills)
zeit/next.js canary belgattitude/next.js docs/safer-module-aliases Change
polyfills-HASH.js gzip 26.3 kB 26.3 kB ✓
Overall change 26.3 kB 26.3 kB ✓
Client Pages
zeit/next.js canary belgattitude/next.js docs/safer-module-aliases Change
_app.js gzip 1.23 kB 1.23 kB ✓
_error.js gzip 3.13 kB 3.13 kB ✓
hooks.js gzip 663 B 663 B ✓
index.js gzip 222 B 222 B ✓
link.js gzip 2.06 kB 2.06 kB ✓
routerDirect.js gzip 280 B 280 B ✓
withRouter.js gzip 278 B 278 B ✓
Overall change 7.86 kB 7.86 kB ✓
Client Pages Modern
zeit/next.js canary belgattitude/next.js docs/safer-module-aliases Change
_app.module.js gzip 598 B 598 B ✓
_error.module.js gzip 2.09 kB 2.09 kB ✓
hooks.module.js gzip 383 B 383 B ✓
index.module.js gzip 223 B 223 B ✓
link.module.js gzip 1.52 kB 1.52 kB ✓
routerDirect..dule.js gzip 279 B 279 B ✓
withRouter.m..dule.js gzip 278 B 278 B ✓
Overall change 5.37 kB 5.37 kB ✓
Client Build Manifests
zeit/next.js canary belgattitude/next.js docs/safer-module-aliases Change
_buildManifest.js gzip 61 B 61 B ✓
_buildManife..dule.js gzip 61 B 61 B ✓
Overall change 122 B 122 B ✓
Serverless bundles
zeit/next.js canary belgattitude/next.js docs/safer-module-aliases Change
_error.js 853 kB 853 kB ✓
404.html 4.18 kB 4.18 kB ✓
hooks.html 3.81 kB 3.81 kB ✓
index.js 853 kB 853 kB ✓
link.js 891 kB 891 kB ✓
routerDirect.js 883 kB 883 kB ✓
withRouter.js 884 kB 884 kB ✓
Overall change 4.37 MB 4.37 MB ✓

@timneutkens
Copy link
Member

In what way is it controversial? Sounds more like a personal opinion 🤔

@belgattitude
Copy link
Contributor Author

belgattitude commented May 7, 2020 •
edited

@timneutkens Controversial is not a good wording for the title... because it's being subject to controversy :D

I'll rename then it's far more better. Of course it's not a bug.

Personal suggestion

@belgattitude belgattitude changed the title docs(module-alias): controversial '@' prefix should not be used docs(module-alias): '@' prefix should not be used May 7, 2020
Timer
Timer requested changes May 11, 2020
View reviewed changes
docs/advanced-features/module-path-aliases.md Outdated Show resolved Hide resolved
docs/advanced-features/module-path-aliases.md Outdated Show resolved Hide resolved
timneutkens and others added 2 commits May 11, 2020 13:50
@timneutkens @Timer
Update docs/advanced-features/module-path-aliases.md
373f48c 
Co-authored-by: Joe Haddad <timer150@gmail.com>
@timneutkens @Timer
Update docs/advanced-features/module-path-aliases.md
743ab06 
Co-authored-by: Joe Haddad <timer150@gmail.com>
@timneutkens timneutkens changed the title docs(module-alias): '@' prefix should not be used Use @/ to show module alias instead of @ prefixed May 11, 2020
@timneutkens timneutkens merged commit 653098d into vercel:canary May 11, 2020
mydearxym added a commit to coderplanets/coderplanets_web that referenced this pull request May 13, 2020
@mydearxym
refactor(naming): change local module alias import from @ -> @/
861a5ea 
vercel/next.js#12600
chibicode pushed a commit to chibicode/next.js that referenced this pull request May 21, 2020
@belgattitude @timneutkens
@Timer @chibicode
Use @/ to show module alias instead of @ prefixed (vercel#12600)
4f47638 
* docs: controversial '@' prefix aliases should not be used

* Update docs/advanced-features/module-path-aliases.md

Co-authored-by: Joe Haddad <timer150@gmail.com>

* Update docs/advanced-features/module-path-aliases.md

Co-authored-by: Joe Haddad <timer150@gmail.com>

Co-authored-by: Tim Neutkens <tim@timneutkens.nl>
Co-authored-by: Joe Haddad <timer150@gmail.com>
rokinsky pushed a commit to rokinsky/next.js that referenced this pull request Jul 11, 2020
@belgattitude @timneutkens
@Timer @rokinsky
Use @/ to show module alias instead of @ prefixed (vercel#12600)
2886b2b 
* docs: controversial '@' prefix aliases should not be used

* Update docs/advanced-features/module-path-aliases.md

Co-authored-by: Joe Haddad <timer150@gmail.com>

* Update docs/advanced-features/module-path-aliases.md

Co-authored-by: Joe Haddad <timer150@gmail.com>

Co-authored-by: Tim Neutkens <tim@timneutkens.nl>
Co-authored-by: Joe Haddad <timer150@gmail.com>
@vercel vercel locked as resolved and limited conversation to collaborators Jan 30, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@Timer Timer Timer requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@belgattitude @ijjk @timneutkens @Timer