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

Add docs for the Next.js Compiler written in Rust (leveraging SWC) #31485

Merged
merged 8 commits into from
Nov 21, 2021

Conversation

timneutkens
Copy link
Member

@timneutkens timneutkens commented Nov 16, 2021

Follow-up to #31467 with reworked wording.

Fixes #20619

  • Rust Compiler -> Next.js Compiler. Given that it is not SWC exactly and not "Compiling Rust" the "Next.js Compiler" makes more sense. next-swc could also be used as that's what we named the package.
  • Removed mention of "Supported features" as it implies those are the only things it does, and these are Next.js features which you'd expect to just work no matter the underlaying implementation
  • Removed the list from "Unsupported Features" as it implies they will never be supported and the list is not complete. The list mentioned are transforms we're actually going to work on soon. Linking to the discussions thread instead works here because this is a moving target as we're implementing improvements and items on the list every day currently.
  • Add swcMinify feedback link to ensure we keep collecting feedback if people run into issues with it
  • Reworked the styled-components section a bit to explain that the 2 transforms mentioned are all that is required in general. Also options -> transforms given that Next.js auto-configures the right options for it and you can't configure those transforms individually.
  • Updated all cases where installing canary is mentioned as all the mentioned transforms are out on stable now in 12.0.4 (they're still experimental though) 🎉
  • Reworded the mention of mobx to say "older versions of mobx" as it's no longer recommended in the mobx docs

Bug

  • Related issues linked using fixes #number
  • Integration tests added
  • Errors have helpful link attached, see contributing.md

Feature

  • Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
  • Related issues linked using fixes #number
  • Integration tests added
  • Documentation added
  • Telemetry added. In case of a feature if it's used or not.
  • Errors have helpful link attached, see contributing.md

Documentation / Examples

  • Make sure the linting passes by running yarn lint

@timneutkens timneutkens marked this pull request as draft November 16, 2021 10:30
docs/advanced-features/compiler.md Outdated Show resolved Hide resolved
docs/advanced-features/compiler.md Outdated Show resolved Hide resolved
docs/advanced-features/compiler.md Outdated Show resolved Hide resolved
docs/advanced-features/compiler.md Outdated Show resolved Hide resolved
@leerob leerob mentioned this pull request Nov 19, 2021
7 tasks
Co-authored-by: Steven <[email protected]>
Co-authored-by: Lee Robinson <[email protected]>
@timneutkens timneutkens dismissed a stale review via be5f936 November 21, 2021 11:37
@timneutkens timneutkens marked this pull request as ready for review November 21, 2021 11:42
@timneutkens timneutkens merged commit 03ce622 into canary Nov 21, 2021
@timneutkens timneutkens deleted the swc-docz branch November 21, 2021 11:42
@vercel vercel locked as resolved and limited conversation to collaborators Jan 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
created-by: Next.js team PRs by the Next.js team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feedback: nextjs.org/docs/advanced-features/customizing-babel-config
4 participants