flow-upgrade 2.0.2 → 2.1.0

package/README.md

@@ -2,30 +2,27 @@
 
 A utility for upgrading your codebase to the latest version of Flow.
 
-To run this utility to upgrade your codebase you can use `yarn create`:
+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`.
 
-[`yarn create`]: https://yarnpkg.com/en/docs/cli/create#search
+You can then run:
 
 ```
-yarn create flow-upgrade
+yarn run flow-upgrade <current flow version> <target flow version>
 ```
 
-This is a shorter version which is equivalent to:
+You may also use [`npx`](https://www.npmjs.com/package/npx):
 
 ```
-yarn global add flow-upgrade
-flow-upgrade
+npx flow-upgrade <current flow version> <target flow version>
 ```
 
-You may also use `npx`:
-
-[`npx`]: https://www.npmjs.com/package/npx
+We also supply the `flow-codemod` binary:
 
 ```
-npx flow-upgrade
+yarn run flow-codemod <codemod name>
 ```
 
-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`.
+If you just want to run a codemod without specifying Flow versions.
 
 ## Options
 
@@ -41,7 +38,41 @@ yarn create flow-upgrade --all
 ### `prettierrc`
 
 Path to a `.prettierrc` file to use.
-Upgrade codemods rely upon [`prettier`][] to print the resulting code after transformation.
+Upgrade codemods rely upon [`prettier`](https://www.npmjs.com/package/prettier) to print the resulting code after transformation.
 If this is not provided, we will just use the defaults.
 
-[`prettier`]: https://www.npmjs.com/package/prettier
+## Codemods available
+
+### Collapse object initialization
+Converts static object assignments (e.g. `const o = {}; o.a = 1;`) to inline properties (e.g. `const o = {a: 1};`).
+
+Run with `yarn run flow-codemod collapseObjectInitialization`.
+
+### Convert type parameter bound exact empty object to inexact
+Replaces `T: {}` with `T: {...}` in type parameter bounds. The former is almost always wrong.
+
+Run with `yarn run flow-codemod typeParameterBoundExactEmptyObjectToInexact`.
+
+### Convert implicit inexact object types
+Converts implicitly inexact object type syntax `{}` to explicitly inexact `{...}`.
+
+Run with `yarn run flow-codemod convertImplicitInexactObjectTypes`.
+
+### Remove explicitly exact object type syntax
+Converts explicitly exact object type syntax `{| |}` to be just be `{ }`. To be done after you turn on `exact_by_default=true` in your `.flowconfig`.
+
+Run with `yarn run flow-codemod removeExplicitlyExactObjectTypeSyntax`.
+
+### Remove annotations in destructuring
+Removes annotations nested inside of destructuring (e.g. `const [o: number] = foo;`). These are not valid Flow syntax.
+
+Run with `yarn run flow-codemod removeAnnotationsInDestructuring`.
+
+Part of upgrade to 0.176
+
+### Remove duplicate class properties
+Removes useless duplicate class properties and fixes bad constructor binding in those classes.
+
+Run with `yarn run flow-codemod removeDuplicateClassProperties`.
+
+Part of upgrade to 0.170

package/dist/codemods/removeExplicitlyExactObjectTypeSyntax.js

@@ -0,0 +1,34 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _Types = require("../Types");
+
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @format
+ * 
+ */
+var _default = (0, _Types.codemod)({
+  title: 'Remove explicitly exact object type syntax',
+  description: 'Convert explicitly exact object type syntax `{| |}` to be just be `{ }`. To be done after you turn on `exact_by_default=true` in your `.flowconfig`.',
+  transform: context => {
+    return {
+      'ObjectTypeAnnotation[exact=true]'(node) {
+        context.modifyNodeInPlace(node, {
+          exact: false
+        });
+      }
+
+    };
+  }
+});
+
+exports.default = _default;

package/dist/codemods/typeParameterBoundExactEmptyObjectToInexact.js

@@ -0,0 +1,51 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _Types = require("../Types");
+
+var _hermesTransform = require("hermes-transform");
+
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @format
+ * 
+ */
+var _default = (0, _Types.codemod)({
+  title: 'Replace `T: {}` with `T: {...}` in type parameter bounds',
+  description: 'Replace `T: {}` with `T: {...}` in type parameter bounds',
+  transform: context => {
+    return {
+      TypeParameter(node) {
+        if (node.bound != null) {
+          const annotation = node.bound.typeAnnotation;
+
+          if (annotation.type === 'ObjectTypeAnnotation' && !annotation.inexact && annotation.properties.length === 0 && annotation.callProperties.length === 0 && annotation.indexers.length === 0 && annotation.internalSlots.length === 0) {
+            context.replaceNode(annotation, _hermesTransform.t.ObjectTypeAnnotation({
+              properties: [],
+              callProperties: [],
+              exact: false,
+
+              /* $FlowExpectedError[incompatible-call]
+               * TODO: hermes-transform mandates that inexact must be
+               * `false`, which is wrong. */
+              inexact: true,
+              indexers: [],
+              internalSlots: []
+            }));
+          }
+        }
+      }
+
+    };
+  }
+});
+
+exports.default = _default;

package/dist/upgrades/index.js

@@ -5,9 +5,11 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.VERSION_UPGRADES = void 0;
 
-var _ = _interopRequireDefault(require("./0.170.0"));
+var _ = _interopRequireDefault(require("./0.84.0"));
 
-var _2 = _interopRequireDefault(require("./0.176.0"));
+var _2 = _interopRequireDefault(require("./0.170.0"));
+
+var _3 = _interopRequireDefault(require("./0.176.0"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
@@ -25,5 +27,5 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * Holds all of the upgrades that need to be run to upgrade to each version from
  * the last version of Flow.
  */
-const VERSION_UPGRADES = [_.default, _2.default];
+const VERSION_UPGRADES = [_.default, _2.default, _3.default];
 exports.VERSION_UPGRADES = VERSION_UPGRADES;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flow-upgrade",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "A utility for upgrading your codebase to the latest version of Flow.",
   "engines": {
     "node": ">=14"
@@ -41,7 +41,7 @@
     "yargs": "^17.0.1"
   },
   "peerDependencies": {
-    "prettier": "^2.4.1"
+    "prettier": "2.7.1"
   },
   "devDependencies": {
     "@babel/cli": "^7.14.8",
@@ -51,6 +51,6 @@
     "flow-bin": "^0.178.0",
     "jest": "^27.5.1",
     "memfs": "^3.4.3",
-    "prettier": "^2.4.1"
+    "prettier": "2.7.1"
   }
 }