flow-upgrade 2.0.2 → 2.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +8 -11
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -2,30 +2,27 @@
2
2
 
3
3
  A utility for upgrading your codebase to the latest version of Flow.
4
4
 
5
- To run this utility to upgrade your codebase you can use `yarn create`:
5
+ Install using `yarn add flow-upgrade`. We expect `prettier` to be installed as a [peer dependency](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#peerdependencies) wherever you are running `flow-upgrade`.
6
6
 
7
- [`yarn create`]: https://yarnpkg.com/en/docs/cli/create#search
7
+ You can then run:
8
8
 
9
9
  ```
10
- yarn create flow-upgrade
10
+ yarn run flow-upgrade <current flow version> <target flow version>
11
11
  ```
12
12
 
13
- This is a shorter version which is equivalent to:
13
+ You may also use [`npx`](https://www.npmjs.com/package/npx):
14
14
 
15
15
  ```
16
- yarn global add flow-upgrade
17
- flow-upgrade
16
+ npx flow-upgrade <current flow version> <target flow version>
18
17
  ```
19
18
 
20
- You may also use `npx`:
21
-
22
- [`npx`]: https://www.npmjs.com/package/npx
19
+ We also supply the `flow-codemod` binary:
23
20
 
24
21
  ```
25
- npx flow-upgrade
22
+ yarn run flow-codemod <codemod name>
26
23
  ```
27
24
 
28
- We expect `prettier` to be installed as a [peer dependency](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#peerdependencies) wherever you are running `flow-upgrade`.
25
+ If you just want to run a codemod without specifying Flow versions.
29
26
 
30
27
  ## Options
31
28
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "flow-upgrade",
3
- "version": "2.0.2",
3
+ "version": "2.0.3",
4
4
  "description": "A utility for upgrading your codebase to the latest version of Flow.",
5
5
  "engines": {
6
6
  "node": ">=14"