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.

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

examples: remove app-dir and with prefix in the mdx directory name #73458

Merged
merged 2 commits into from
Jan 8, 2025

Conversation

JamBalaya56562
Copy link
Contributor

@JamBalaya56562 JamBalaya56562 commented Dec 3, 2024

What?

  1. Rename the following examples.
Before After
app-dir-mdx mdx
with-mdx mdx-pages
with-mdx-remote mdx-remote
  1. Change the example names at README.md in the repositories.
  2. Update the mdx pathname in the test files.

Why?

Why remove app-dir- in the directory name?

The default has already been App Router anyways and a lot of examples have migrated over.
x-ref: #72642 (comment)

Why remove with- in the directory name?

According to examples guidelines,

Example directories should not be prefixed with with-

How did you verify your code works?

I have tested the new with-mdx.test.ts and example.test.ts.

Adding or Updating Examples

CC: @samcx

@ijjk ijjk added examples Issue was opened via the examples template. tests labels Dec 3, 2024
@ijjk
Copy link
Member

ijjk commented Dec 3, 2024

Allow CI Workflow Run

  • approve CI run for commit: 097ed31

Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer

@JamBalaya56562 JamBalaya56562 force-pushed the mdx branch 7 times, most recently from d8c24fb to 679be62 Compare December 10, 2024 23:51
@JamBalaya56562 JamBalaya56562 force-pushed the mdx branch 4 times, most recently from b1350ef to 4504933 Compare December 16, 2024 01:50
@samcx samcx self-requested a review December 17, 2024 01:42
@samcx
Copy link
Member

samcx commented Dec 17, 2024

@JamBalaya56562 It looks like there are conflicts now!

@JamBalaya56562 JamBalaya56562 force-pushed the mdx branch 2 times, most recently from 45885e7 to e2983ae Compare December 17, 2024 02:00
@JamBalaya56562
Copy link
Contributor Author

@JamBalaya56562 It looks like there are conflicts now!

Thank you for checking!
I have rebased and resolved merge conflict.

@samcx
Copy link
Member

samcx commented Dec 17, 2024

@JamBalaya56562 we should update mdx-remote to App Router as well!

@JamBalaya56562
Copy link
Contributor Author

@JamBalaya56562 we should update mdx-remote to App Router as well!

Alright, I have made PR of that at #74067.
Those changes are so big that I separated the PR.

This PR will be updated when #74067 is merged.

@samcx
Copy link
Member

samcx commented Dec 18, 2024

@JamBalaya56562 The other PR has been merged!

@JamBalaya56562
Copy link
Contributor Author

@JamBalaya56562 The other PR has been merged!

Thank you very much!
I have updated this PR, and there are no merge conflicts.

@ijjk
Copy link
Member

ijjk commented Jan 7, 2025

Tests Passed

@ijjk
Copy link
Member

ijjk commented Jan 7, 2025

Stats from current PR

Default Build (Increase detected ⚠️)
General
vercel/next.js canary JamBalaya56562/next.js mdx Change
buildDuration 18.9s 16.1s N/A
buildDurationCached 15.1s 13s N/A
nodeModulesSize 417 MB 417 MB
nextStartRea..uration (ms) 471ms 472ms N/A
Client Bundles (main, webpack)
vercel/next.js canary JamBalaya56562/next.js mdx Change
1187-HASH.js gzip 52.6 kB 52.6 kB N/A
8276.HASH.js gzip 169 B 168 B N/A
8377-HASH.js gzip 5.44 kB 5.44 kB N/A
bccd1874-HASH.js gzip 53 kB 53 kB N/A
framework-HASH.js gzip 57.5 kB 57.5 kB N/A
main-app-HASH.js gzip 232 B 235 B N/A
main-HASH.js gzip 34.1 kB 34.1 kB N/A
webpack-HASH.js gzip 1.71 kB 1.71 kB N/A
Overall change 0 B 0 B
Legacy Client Bundles (polyfills)
vercel/next.js canary JamBalaya56562/next.js mdx Change
polyfills-HASH.js gzip 39.4 kB 39.4 kB
Overall change 39.4 kB 39.4 kB
Client Pages
vercel/next.js canary JamBalaya56562/next.js mdx Change
_app-HASH.js gzip 193 B 193 B
_error-HASH.js gzip 193 B 193 B
amp-HASH.js gzip 512 B 510 B N/A
css-HASH.js gzip 343 B 342 B N/A
dynamic-HASH.js gzip 1.84 kB 1.84 kB
edge-ssr-HASH.js gzip 265 B 265 B
head-HASH.js gzip 363 B 362 B N/A
hooks-HASH.js gzip 393 B 392 B N/A
image-HASH.js gzip 4.57 kB 4.57 kB N/A
index-HASH.js gzip 268 B 268 B
link-HASH.js gzip 2.35 kB 2.34 kB N/A
routerDirect..HASH.js gzip 328 B 328 B
script-HASH.js gzip 397 B 397 B
withRouter-HASH.js gzip 323 B 326 B N/A
1afbb74e6ecf..834.css gzip 106 B 106 B
Overall change 3.59 kB 3.59 kB
Client Build Manifests
vercel/next.js canary JamBalaya56562/next.js mdx Change
_buildManifest.js gzip 749 B 747 B N/A
Overall change 0 B 0 B
Rendered Page Sizes
vercel/next.js canary JamBalaya56562/next.js mdx Change
index.html gzip 523 B 523 B
link.html gzip 539 B 537 B N/A
withRouter.html gzip 519 B 520 B N/A
Overall change 523 B 523 B
Edge SSR bundle Size
vercel/next.js canary JamBalaya56562/next.js mdx Change
edge-ssr.js gzip 128 kB 128 kB N/A
page.js gzip 206 kB 206 kB N/A
Overall change 0 B 0 B
Middleware size
vercel/next.js canary JamBalaya56562/next.js mdx Change
middleware-b..fest.js gzip 669 B 668 B N/A
middleware-r..fest.js gzip 155 B 156 B N/A
middleware.js gzip 31.2 kB 31.2 kB N/A
edge-runtime..pack.js gzip 844 B 844 B
Overall change 844 B 844 B
Next Runtimes
vercel/next.js canary JamBalaya56562/next.js mdx Change
274-experime...dev.js gzip 322 B 322 B
274.runtime.dev.js gzip 314 B 314 B
app-page-exp...dev.js gzip 364 kB 364 kB
app-page-exp..prod.js gzip 129 kB 129 kB
app-page-tur..prod.js gzip 142 kB 142 kB
app-page-tur..prod.js gzip 138 kB 138 kB
app-page.run...dev.js gzip 352 kB 352 kB
app-page.run..prod.js gzip 125 kB 125 kB
app-route-ex...dev.js gzip 37.5 kB 37.5 kB
app-route-ex..prod.js gzip 25.6 kB 25.6 kB
app-route-tu..prod.js gzip 25.6 kB 25.6 kB
app-route-tu..prod.js gzip 25.4 kB 25.4 kB
app-route.ru...dev.js gzip 39.2 kB 39.2 kB
app-route.ru..prod.js gzip 25.4 kB 25.4 kB
pages-api-tu..prod.js gzip 9.69 kB 9.69 kB
pages-api.ru...dev.js gzip 11.6 kB 11.6 kB
pages-api.ru..prod.js gzip 9.68 kB 9.68 kB
pages-turbo...prod.js gzip 21.7 kB 21.7 kB
pages.runtim...dev.js gzip 27.5 kB 27.5 kB
pages.runtim..prod.js gzip 21.7 kB 21.7 kB
server.runti..prod.js gzip 916 kB 916 kB
Overall change 2.45 MB 2.45 MB
build cache Overall increase ⚠️
vercel/next.js canary JamBalaya56562/next.js mdx Change
0.pack gzip 2.09 MB 2.08 MB N/A
index.pack gzip 73.6 kB 74.7 kB ⚠️ +1.02 kB
Overall change 73.6 kB 74.7 kB ⚠️ +1.02 kB
Diff details
Diff for main-HASH.js

Diff too large to display

Commit: faa19e9

Copy link
Member

@samcx samcx left a comment

Choose a reason for hiding this comment

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

Thank you for submitting a PR!

:lgtm:

@samcx samcx merged commit 832c77d into vercel:canary Jan 8, 2025
103 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
examples Issue was opened via the examples template. tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants