marko 5.30.1 → 5.30.2
Sign up to get free protection for your applications and to get access to all the features.
- package/docs/marko-5-upgrade.md +22 -6
- package/package.json +1 -1
package/docs/marko-5-upgrade.md
CHANGED
|
@@ -32,6 +32,8 @@ Run your application and tests and ensure that there are no deprecation warnings
|
|
|
32
32
|
|
|
33
33
|
Additionally, any deprecation warnings that start with `MIGRATION` are automatically migratable by [`marko migrate`](https://github.com/marko-js/cli/blob/master/packages/migrate/README.md). Most migrations are 100% safe and will run automatically. However, there are a few migrations which are considered unsafe: they may only get you 90% of the way there. These migrations will prompt and ask if you want to run the migration. It is highly recommended to run these only on a single component at a time and then finish the migration manually using the guide below so that your app is always in a working state.
|
|
34
34
|
|
|
35
|
+
> **Note**: Deprecations related to `marko-widgets` are not necessary to address before upgrading.
|
|
36
|
+
|
|
35
37
|
## Step 3 - Upgrade dependencies
|
|
36
38
|
|
|
37
39
|
Before upgrading to Marko 5, it is recommended to make sure that your Marko-related dependencies are up-to-date. Many packages have versions that support both Marko 4 and Marko 5. If one of your dependencies doesn't have a version that supports both, you'll need to wait to upgrade it until you're upgrading Marko.
|
|
@@ -42,17 +44,31 @@ After upgrading, run your application and tests to ensure that everything is sti
|
|
|
42
44
|
|
|
43
45
|
Phew! With all the prep out of the way we're finally ready to upgrade `marko`!
|
|
44
46
|
|
|
45
|
-
|
|
46
|
-
npm install marko@^5
|
|
47
|
-
```
|
|
47
|
+
Note that some features removed in Marko 4 do not log deprecations since they do not need to be resolved to get up and running with Marko 5. However for Marko 5 to support some of the features removed after Marko 4 you need to install a `compat` module.
|
|
48
48
|
|
|
49
|
-
|
|
49
|
+
There are currently two `compat` modules you can install, one which supports the `marko-widget`'s api from Marko@3 and one with just the compat needed for Marko@4 components.
|
|
50
|
+
|
|
51
|
+
**For apps with `marko-widgets` installed, add the following modules:**
|
|
50
52
|
|
|
53
|
+
```bash
|
|
54
|
+
# Upgrade using npm
|
|
55
|
+
npm install marko@^5 @marko/compiler marko-widgets@^8
|
|
56
|
+
|
|
57
|
+
# Or with yarn
|
|
58
|
+
yarn install marko@^5 @marko/compiler marko-widgets@^8
|
|
51
59
|
```
|
|
52
|
-
|
|
60
|
+
|
|
61
|
+
**For apps which were not using the Marko@3 compat layer, add the following modules:**
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
# Upgrade using npm
|
|
65
|
+
npm install marko@^5 @marko/compiler @marko/compat-v4
|
|
66
|
+
|
|
67
|
+
# Or with yarn
|
|
68
|
+
yarn install marko@^5 @marko/compiler @marko/compat-v4
|
|
53
69
|
```
|
|
54
70
|
|
|
55
|
-
> **Note**: Marko 5 has changed to using ES Modules. This means if you are using CJS modules to `require` a Marko template you will need to use the `.default` property exported.
|
|
71
|
+
> **Note**: Marko 5 has changed to using ES Modules. This means if you are using CJS modules to `require` a Marko template you will need to use the `.default` property exported. When using @marko/compat-v4 this is handled automatically.
|
|
56
72
|
>
|
|
57
73
|
> ```js
|
|
58
74
|
> const template = require("./template.marko");
|