-
-
Notifications
You must be signed in to change notification settings - Fork 251
WIP: V12 migration guide #1048
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
Open
fhammerschmidt
wants to merge
1
commit into
master
Choose a base branch
from
v12-migration-guide
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
WIP: V12 migration guide #1048
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
--- | ||
title: "Migrate to v12" | ||
description: "Instructions on upgrading to ReScript 12" | ||
canonical: "/docs/manual/v12.0.0/migrate-to-v12" | ||
--- | ||
|
||
# Migrate to ReScript 12 | ||
|
||
## Recommended Migration | ||
|
||
### Prerequisites | ||
|
||
- ReScript V11 project. | ||
- Uncurried mode must be enabled (i.e. you have not opted-out from it) | ||
- Your project must not contain any OCaml source code anymore, as support for `.ml` files is removed in this version. However there are ways to convert OCaml syntax with an older ReScript compiler version (see below). | ||
- The old configuration filename that was deprecated in v11, `bsconfig.json`, is removed. Rename it to `rescript.json`. | ||
|
||
### Standard library changes | ||
|
||
In V12, the new standard library ships with the compiler, so you can uninstall and remove the `@rescript/core` dependency from your `rescript.json` | ||
|
||
```console | ||
$ npm remove @rescript/core | ||
``` | ||
|
||
```diff | ||
{ | ||
"bs-dependencies": [ | ||
- "@rescript/core" | ||
] | ||
} | ||
``` | ||
|
||
Also remove auto opening of `RescriptCore`. | ||
|
||
```diff | ||
{ | ||
"bsc-flags": [ | ||
- "-open RescriptCore", | ||
] | ||
} | ||
``` | ||
|
||
## Replacements | ||
|
||
Some typical name changes include: | ||
|
||
`Error.t` -> `JsError.t` | ||
`raise(` -> `throw(` | ||
`Js.Exn.Error` exception -> `JsExn` | ||
`Error.make` -> `JsExn.make` | ||
`Error.raise` -> `JsExn.raise` | ||
`Error.message` -> `JsExn.message` | ||
`Int.Bitwise.lsl` -> `Int.shiftLeft` | ||
|
||
|
||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we create migrations for each of these, this section can be replaced with an explanation of how to use the migration tool
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The migration guide will also mention changes in rescript.json and stuff.
Except we will somehow auto-migrate those changes as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also at the very least there are some prerequisites to migration, like v11 in uncurried mode. So the migration guide will be required still, albeit a lot smaller than before the migrations were a thing.