imp: migrate platform-android to TypeScript (react-native-community…

…#597)
NickGerleman · Aug 1, 2019 · 5e5d50d · 5e5d50d
1 parent e18c858
commit 5e5d50d
Show file tree

Hide file tree

Showing 58 changed files with 439 additions and 229 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -1,3 +1,5 @@
+const prettierConfig = require('./.prettierrc');
+
 module.exports = {
   extends: ['@react-native-community', 'plugin:import/errors'],
   env: {
@@ -32,5 +34,11 @@ module.exports = {
         jest: true,
       },
     },
+    {
+      files: ['*.ts', '**/*.ts'],
+      rules: {
+        'prettier/prettier': [2, {prettierConfig, parser: 'typescript'}],
+      },
+    },
   ],
 };
diff --git a/docs/projects.md b/docs/projects.md
@@ -76,7 +76,6 @@ type ProjectParamsAndroidT = {
   settingsGradlePath?: string;
   assetsPath?: string;
   buildGradlePath?: string;
-  packageName?: string;
 };
 
 type ProjectParamsIOST = {

diff --git a/package.json b/package.json
@@ -28,7 +28,7 @@
     "@babel/preset-typescript": "^7.3.3",
     "@react-native-community/eslint-config": "^0.0.5",
     "@types/jest": "^24.0.11",
-    "@types/node": "^11.13.0",
+    "@types/node": "8",
     "@types/node-fetch": "^2.3.7",
     "babel-jest": "^24.6.0",
     "babel-plugin-module-resolver": "^3.2.0",

diff --git a/packages/platform-android/package.json b/packages/platform-android/package.json
@@ -9,11 +9,17 @@
     "execa": "^1.0.0",
     "jetifier": "^1.6.2",
     "logkitty": "^0.5.0",
-    "slash": "^2.0.0",
-    "xmldoc": "^0.4.0"
+    "slash": "^3.0.0",
+    "xmldoc": "^1.1.2"
   },
   "files": [
     "build",
     "native_modules.gradle"
-  ]
+  ],
+  "devDependencies": {
+    "@types/execa": "^0.9.0",
+    "@types/fs-extra": "^8.0.0",
+    "@types/glob": "^7.1.1",
+    "@types/xmldoc": "^1.1.4"
+  }
 }
diff --git a/...es/platform-android/src/commands/index.js → ...es/platform-android/src/commands/index.ts b/...es/platform-android/src/commands/index.js → ...es/platform-android/src/commands/index.ts
@@ -1,6 +1,3 @@
-/**
- * @flow
- */
 import logAndroid from './logAndroid';
 import runAndroid from './runAndroid';
 

diff --git a/...-android/src/commands/logAndroid/index.js → ...-android/src/commands/logAndroid/index.ts b/...-android/src/commands/logAndroid/index.js → ...-android/src/commands/logAndroid/index.ts
@@ -19,7 +19,7 @@ async function logAndroid() {
 
   const emitter = logkitty({
     platform: 'android',
-    minPriority: AndroidPriority.VERBOSE,
+    priority: AndroidPriority.VERBOSE,
     filter: makeTagsFilter('ReactNative', 'ReactNativeJS'),
   });
 

diff --git a/...Android/__tests__/runOnAllDevices.test.js → ...Android/__tests__/runOnAllDevices.test.ts b/...Android/__tests__/runOnAllDevices.test.js → ...Android/__tests__/runOnAllDevices.test.ts
@@ -22,6 +22,7 @@ describe('--appFolder', () => {
   });
 
   it('uses task "install[Variant]" as default task', () => {
+    // @ts-ignore
     runOnAllDevices({
       variant: 'debug',
     });
@@ -30,6 +31,7 @@ describe('--appFolder', () => {
   });
 
   it('uses appFolder and default variant', () => {
+    // @ts-ignore
     runOnAllDevices({
       appFolder: 'someApp',
       variant: 'debug',
@@ -39,6 +41,7 @@ describe('--appFolder', () => {
   });
 
   it('uses appFolder and custom variant', () => {
+    // @ts-ignore
     runOnAllDevices({
       appFolder: 'anotherApp',
       variant: 'staging',
@@ -50,6 +53,7 @@ describe('--appFolder', () => {
   });
 
   it('uses only task argument', () => {
+    // @ts-ignore
     runOnAllDevices({
       tasks: ['someTask'],
       variant: 'debug',
@@ -59,6 +63,7 @@ describe('--appFolder', () => {
   });
 
   it('uses appFolder and custom task argument', () => {
+    // @ts-ignore
     runOnAllDevices({
       appFolder: 'anotherApp',
       tasks: ['someTask'],
@@ -69,13 +74,15 @@ describe('--appFolder', () => {
   });
 
   it('uses multiple tasks', () => {
+    // @ts-ignore
     runOnAllDevices({
       appFolder: 'app',
       tasks: ['clean', 'someTask'],
     });
 
     expect(execFileSync.mock.calls[0][1]).toContain(
       'app:clean',
+      // @ts-ignore
       'app:someTask',
     );
   });

diff --git a/...rm-android/src/commands/runAndroid/adb.js → ...rm-android/src/commands/runAndroid/adb.ts b/...rm-android/src/commands/runAndroid/adb.js → ...rm-android/src/commands/runAndroid/adb.ts
@@ -4,8 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @format
- * @flow
  */
 
 import {execSync, execFileSync} from 'child_process';

diff --git a/...oid/src/commands/runAndroid/getAdbPath.js → ...oid/src/commands/runAndroid/getAdbPath.ts b/...oid/src/commands/runAndroid/getAdbPath.js → ...oid/src/commands/runAndroid/getAdbPath.ts
@@ -4,7 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @flow
  */
 
 function getAdbPath() {

diff --git a/...-android/src/commands/runAndroid/index.js → ...-android/src/commands/runAndroid/index.ts b/...-android/src/commands/runAndroid/index.js → ...-android/src/commands/runAndroid/index.ts
@@ -4,14 +4,13 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @flow
  */
 
 import path from 'path';
 import execa from 'execa';
 import chalk from 'chalk';
 import fs from 'fs';
-import type {ConfigT} from 'types';
+import {Config} from '../../types';
 import adb from './adb';
 import runOnAllDevices from './runOnAllDevices';
 import tryRunAdbReverse from './tryRunAdbReverse';
@@ -26,29 +25,29 @@ import {
 import warnAboutManuallyLinkedLibs from '../../link/warnAboutManuallyLinkedLibs';
 
 // Verifies this is an Android project
-function checkAndroid(root) {
+function checkAndroid(root: string) {
   return fs.existsSync(path.join(root, 'android/gradlew'));
 }
 
-export type FlagsT = {|
-  tasks?: Array<string>,
-  root: string,
-  variant: string,
-  appFolder: string,
-  appId: string,
-  appIdSuffix: string,
-  mainActivity: string,
-  deviceId?: string,
-  packager: boolean,
-  port: number,
-  terminal: string,
-  jetifier: boolean,
-|};
+export interface Flags {
+  tasks?: Array<string>;
+  root: string;
+  variant: string;
+  appFolder: string;
+  appId: string;
+  appIdSuffix: string;
+  mainActivity: string;
+  deviceId?: string;
+  packager: boolean;
+  port: number;
+  terminal: string;
+  jetifier: boolean;
+}
 
 /**
  * Starts the app on a connected Android emulator or device.
  */
-async function runAndroid(argv: Array<string>, config: ConfigT, args: FlagsT) {
+async function runAndroid(_argv: Array<string>, config: Config, args: Flags) {
   if (!checkAndroid(args.root)) {
     logger.error(
       'Android project not found. Are you sure this is a React Native project?',
@@ -104,7 +103,11 @@ async function runAndroid(argv: Array<string>, config: ConfigT, args: FlagsT) {
   });
 }
 
-function getPackageNameWithSuffix(appId, appIdSuffix, packageName) {
+function getPackageNameWithSuffix(
+  appId: string,
+  appIdSuffix: string,
+  packageName: string,
+) {
   if (appId) {
     return appId;
   }
@@ -116,15 +119,15 @@ function getPackageNameWithSuffix(appId, appIdSuffix, packageName) {
 }
 
 // Builds the app and runs it on a connected emulator / device.
-function buildAndRun(args) {
+function buildAndRun(args: Flags) {
   process.chdir(path.join(args.root, 'android'));
   const cmd = process.platform.startsWith('win') ? 'gradlew.bat' : './gradlew';
 
   // "app" is usually the default value for Android apps with only 1 app
   const {appFolder} = args;
+  // @ts-ignore
   const packageName = fs
     .readFileSync(`${appFolder}/src/main/AndroidManifest.xml`, 'utf8')
-    // $FlowFixMe
     .match(/package="(.+?)"/)[1];
 
   const packageNameWithSuffix = getPackageNameWithSuffix(
@@ -154,11 +157,11 @@ function buildAndRun(args) {
 }
 
 function runOnSpecificDevice(
-  args,
-  gradlew,
-  packageNameWithSuffix,
-  packageName,
-  adbPath,
+  args: Flags,
+  gradlew: 'gradlew.bat' | './gradlew',
+  packageNameWithSuffix: string,
+  packageName: string,
+  adbPath: string,
 ) {
   const devices = adb.getDevices(adbPath);
   const {deviceId} = args;
@@ -183,7 +186,7 @@ function runOnSpecificDevice(
   }
 }
 
-function buildApk(gradlew) {
+function buildApk(gradlew: string) {
   try {
     // using '-x lint' in order to ignore linting errors while building the apk
     const gradleArgs = ['build', '-x', 'lint'];
@@ -195,7 +198,7 @@ function buildApk(gradlew) {
   }
 }
 
-function tryInstallAppOnDevice(args, adbPath, device) {
+function tryInstallAppOnDevice(args: Flags, adbPath: string, device: string) {
   try {
     // "app" is usually the default value for Android apps with only 1 app
     const {appFolder} = args;
@@ -222,11 +225,11 @@ function tryInstallAppOnDevice(args, adbPath, device) {
 }
 
 function getInstallApkName(
-  appFolder,
-  adbPath,
-  variant,
-  device,
-  buildDirectory,
+  appFolder: string,
+  adbPath: string,
+  variant: string,
+  device: string,
+  buildDirectory: string,
 ) {
   const availableCPUs = adb.getAvailableCPUs(adbPath, device);
 
@@ -248,11 +251,11 @@ function getInstallApkName(
 }
 
 function installAndLaunchOnDevice(
-  args,
-  selectedDevice,
-  packageNameWithSuffix,
-  packageName,
-  adbPath,
+  args: Flags,
+  selectedDevice: string,
+  packageNameWithSuffix: string,
+  packageName: string,
+  adbPath: string,
 ) {
   tryRunAdbReverse(args.port, selectedDevice);
   tryInstallAppOnDevice(args, adbPath, selectedDevice);
@@ -265,7 +268,12 @@ function installAndLaunchOnDevice(
   );
 }
 
-function startServerInNewWindow(port, terminal, reactNativePath) {
+// @ts-ignore
+function startServerInNewWindow(
+  port: number,
+  terminal: string,
+  reactNativePath: string,
+) {
   /**
    * Set up OS-specific filenames and commands
    */
@@ -310,7 +318,7 @@ function startServerInNewWindow(port, terminal, reactNativePath) {
    */
   const scriptsDir = path.dirname(launchPackagerScript);
   const packagerEnvFile = path.join(scriptsDir, packagerEnvFilename);
-  const procConfig: Object = {cwd: scriptsDir};
+  const procConfig: execa.SyncOptions = {cwd: scriptsDir};
 
   /**
    * Ensure we overwrite file by passing the `w` flag

diff --git a/...rc/commands/runAndroid/runOnAllDevices.js → ...rc/commands/runAndroid/runOnAllDevices.ts b/...rc/commands/runAndroid/runOnAllDevices.js → ...rc/commands/runAndroid/runOnAllDevices.ts
@@ -4,7 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @flow
  */
 
 import chalk from 'chalk';
@@ -13,7 +12,7 @@ import {logger, CLIError} from '@react-native-community/cli-tools';
 import adb from './adb';
 import tryRunAdbReverse from './tryRunAdbReverse';
 import tryLaunchAppOnDevice from './tryLaunchAppOnDevice';
-import type {FlagsT} from '.';
+import {Flags} from '.';
 
 function getTaskNames(
   appFolder: string,
@@ -29,7 +28,7 @@ function toPascalCase(value: string) {
 }
 
 function runOnAllDevices(
-  args: FlagsT,
+  args: Flags,
   cmd: string,
   packageNameWithSuffix: string,
   packageName: string,
@@ -54,19 +53,21 @@ function runOnAllDevices(
   }
   const devices = adb.getDevices(adbPath);
 
-  (devices.length > 0 ? devices : [undefined]).forEach(device => {
-    tryRunAdbReverse(args.port, device);
-    tryLaunchAppOnDevice(
-      device,
-      packageNameWithSuffix,
-      packageName,
-      adbPath,
-      args.mainActivity,
-    );
-  });
+  (devices.length > 0 ? devices : [undefined]).forEach(
+    (device: string | void) => {
+      tryRunAdbReverse(args.port, device);
+      tryLaunchAppOnDevice(
+        device,
+        packageNameWithSuffix,
+        packageName,
+        adbPath,
+        args.mainActivity,
+      );
+    },
+  );
 }
 
-function createInstallError(error) {
+function createInstallError(error: Error & {stderr: string}) {
   const stderr = (error.stderr || '').toString();
   const docs =
     'https://facebook.github.io/react-native/docs/getting-started.html#android-development-environment';
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,7 +4,6 @@ @@
      * This source code is licensed under the MIT license found in the
      * LICENSE file in the root directory of this source tree.
      *
-     * @flow
      */
     function getAdbPath() {
@@ Expand Down @@