v6.6.0
Changelog
Important
While this release includes preliminary support for Yarn v4, upgrading to it is completely optional. If anything doesn't work, you can always downgrade back to Yarn v3. We expect most rough edges to be with deploy providers. If you run into anything, please open an issue!
Features
-
chore(deps): update yarn to v4 #9343
New Redwood projects will use Yarn v4 out of the box. Yarn v4 includes many new features and fixes like an improved UI, the ability to write constraints in JS instead of Prolog, and a simpler way to get set up all together.
For existing projects, upgrading to Yarn v4 is fairly simple, but may require changes based on your deploy provider. Here are the steps locally:
-
Enable corepack
corepack enable
Corepack is a manager for package managers if you will. It's a tool shipped with Node.js 16+ that automatically selects the right package manager and version to run depending on the project you're working on.
-
Update the
packageManager
field in your project's rootpackage.json
toyarn@4.0.2
- "packageManager": "yarn@3.7.0" // Or whatever version it happened to be at + "packageManager": "yarn@4.0.2"
Corepack uses the
packageManager
field in your rootpackage json
to select the package manager and version. -
Remove
yarnPath
in.yarnrc.yml
and remove.yarn/releases
Now that you're using Corepack, you don't need
yarnPath
or the binary in.yarn/releases
anymore. You can still use them if you prefer this workflow, but they're not necessary and will take precedence overpackageManager
. -
If you previously installed yarn via hombrew or NPM we recommend removing that installation since it can conflict with corepack in some cases:
brew uninstall yarn
See Yarn's announcement post for more details: https://yarnpkg.com/blog/release/4.0.
-
-
Support custom
@id
column name in scaffold #8264 by @samthuangAn improvement to the scaffold generator now allows columns with custom names to serve as the
@id
field in the Prisma datamodel. Previously the scaffold generator assumed that the@id
field was named "id". This change provides flexibility to specify any name for the@id
column if it's marked with the@id
attribute in the Prisma datamodel. -
Adds new
<Metadata>
component for proper<meta>
tag generation #9315 by @cannikinThe new
<Metadata>
component allows for a more natural and powerful way to set<head>
tags, like<meta ... />
. See the new docs at https://redwoodjs.com/docs/seo-head#setting-meta-tags-and-opengraph-directives-with-metadata. -
Add vscode web debugger and compound #9567 by @xmaxcooking
Adds two debug configurations to
.vscode/launch.json
:- Web Debugger (launches the built-in chrome web debugger)
- Compound of Dev + Api + Web (launches a fully-debuggable redwood with a single configuration)
-
Studio: Make port configurable #9709 by @Tobbe
Makes it possible to configure the base port Redwood Studio uses. The default is
4318
. Mailer will usebasePort + 1
. -
Preserve trailing whitespace for Markdown, HTML & MJML (RedwoodJS project + create-redwood-app template) #5869 by @Philzen
While trailing whitespace is just noise in code (well, 99 % of the time...), for markdown it has actual significance. This changes the VS Code configuration to respect it in markdown files.
-
✨ Added autodocs to component Storybook Stories #9547 by @ahaywood
For the Storybook component template,
tags: ['autodocs']
is added to themeta
block:const meta: Meta<typeof ${pascalName}> = { component: ${pascalName}, + tags: ['autodocs'] }
-
Export SignupHandlerOptions interface and update its userAttributes type #9049 by @c-ciobanu
You can now use TypeScript generics to get correct typings for
userAttributes
. For more context, see https://community.redwoodjs.com/t/signuphandleroptions-userattributes-type/5231.
Fixes
-
fix: sentry no longer supports tracing as a seperate package #9542 by @ageddesi
-
fix: Safeguard for Sentry default templates + nitpick #9012 by @HazAT
This, and the fix above both make sure our Sentry setup script follows the latest best practices and also enables the HTTP Tracing integration for the frontend.
-
Update
.vscode/settings.json
files for ESLint setting #9723 by @morganmspencer -
fix(gitpod): enable corepack to get proper node version #9732 by @colbywhite
-
fix(CLI): fix
getDevNodeOptions
#9735 by @jtoarNODE_OPTIONS="..." yarn rw dev
now works as expected. -
fix(fastify): Server not handling periods in query params #9714
Docs
- Proofreading fixes for realtime docs #9657 by @Tobbe
- docs: auth - Clerk - Corrects Home Page generation instructions #9662 by @dthyresson
- Update Toast Notifications Docs with Example of Async Toast using
toast.promise
#9710 by @xmaxcooking - docs(#9006) - Update redwoodjs cli to include correct forum url #9721 by @ageddesi
- 💬 Fixed formatting within the docs #9587 by @ahaywood
- fix "Core Team" link #9621 by @sqs
- Fix grammar #9720 by @wingedotter5
- Fixed closing tag used as opening tag in several places #9724 by @joshdotjs
- Fix typo #9725 by @joshdotjs
- Add a note about build and runtime environments #9726 by @Tobbe
- fix(docs): update webAuthn import in dbauth doc #9170 #9178 by @jlthompso
Core Dependencies
- fix(deps): update storybook monorepo to v7.6.4 #9647
- chore(deps): update yarn to v4 #9343
- chore(deps): update babel monorepo #9718
- chore(deps): update dependency typescript to v5.3.3 #9645
Dependencies
Click to see all upgraded dependencies
- chore(deps): update dependency @clerk/clerk-react to v4.28.3 #9643
- fix(deps): update dependency @clerk/clerk-sdk-node to v4.13.1 #9648
- fix(deps): update dependency clsx to v2 #9681
- chore(deps): update postgres docker tag to v16 #9679
- fix(deps): update dependency ci-info to v4 #9680
- fix(deps): update dependency core-js to v3.34.0 #9649
- chore(deps): update dependency @clerk/types to v3.60.0 #9644
- chore(deps): update dependency typescript to v5.3.3 #9645