microsoft/vscode-react-native
Publicmirrored fromhttps://github.com/microsoft/vscode-react-nativeAvailable
src/extension/rn-extension.ts
167lines · modecode
| 1 | // Copyright (c) Microsoft Corporation. All rights reserved. |
| 2 | // Licensed under the MIT license. See LICENSE file in the project root for details. |
| 3 | |
| 4 | import * as fs from "fs"; |
| 5 | |
| 6 | // @ifdef DEBUG |
| 7 | try { |
| 8 | fs.statSync(`${__filename}.map`); // We check if source maps are available |
| 9 | /* tslint:disable:no-var-requires */ |
| 10 | require("source-map-support").install(); // If they are, we enable stack traces translation to typescript |
| 11 | /* tslint:enable:no-var-requires */ |
| 12 | } catch (exceptions) { |
| 13 | // If something goes wrong, we just ignore the errors |
| 14 | } |
| 15 | // @endif |
| 16 | |
| 17 | import * as Q from "q"; |
| 18 | import * as path from "path"; |
| 19 | import * as vscode from "vscode"; |
| 20 | |
| 21 | import {FileSystem} from "../common/node/fileSystem"; |
| 22 | import {CommandPaletteHandler} from "./commandPaletteHandler"; |
| 23 | import {Packager} from "../common/packager"; |
| 24 | import {EntryPointHandler} from "../common/entryPointHandler"; |
| 25 | import {ErrorHelper} from "../common/error/errorHelper"; |
| 26 | import {InternalError} from "../common/error/internalError"; |
| 27 | import {InternalErrorCode} from "../common/error/internalErrorCode"; |
| 28 | import {Log} from "../common/log/log"; |
| 29 | import {PackagerStatusIndicator} from "./packagerStatusIndicator"; |
| 30 | import {ReactNativeProjectHelper} from "../common/reactNativeProjectHelper"; |
| 31 | import {ReactDirManager} from "./reactDirManager"; |
| 32 | import {IntellisenseHelper} from "./intellisenseHelper"; |
| 33 | import {Telemetry} from "../common/telemetry"; |
| 34 | import {TelemetryHelper} from "../common/telemetryHelper"; |
| 35 | import {ExtensionServer} from "./extensionServer"; |
| 36 | import {OutputChannelLogger} from "./outputChannelLogger"; |
| 37 | |
| 38 | /* all components use the same packager instance */ |
| 39 | const globalPackager = new Packager(vscode.workspace.rootPath); |
| 40 | const packagerStatusIndicator = new PackagerStatusIndicator(); |
| 41 | const commandPaletteHandler = new CommandPaletteHandler(vscode.workspace.rootPath, globalPackager, packagerStatusIndicator); |
| 42 | |
| 43 | const outputChannelLogger = new OutputChannelLogger(vscode.window.createOutputChannel("React-Native")); |
| 44 | const entryPointHandler = new EntryPointHandler(false, outputChannelLogger); |
| 45 | const reactNativeProjectHelper = new ReactNativeProjectHelper(vscode.workspace.rootPath); |
| 46 | const fsUtil = new FileSystem(); |
| 47 | |
| 48 | interface ISetupableDisposable extends vscode.Disposable { |
| 49 | setup(): Q.Promise<any>; |
| 50 | } |
| 51 | |
| 52 | export function activate(context: vscode.ExtensionContext): void { |
| 53 | entryPointHandler.runApp("react-native", () => <string>require("../../package.json").version, |
| 54 | ErrorHelper.getInternalError(InternalErrorCode.ExtensionActivationFailed), () => { |
| 55 | return reactNativeProjectHelper.isReactNativeProject() |
| 56 | .then(isRNProject => { |
| 57 | if (isRNProject) { |
| 58 | let activateExtensionEvent = TelemetryHelper.createTelemetryEvent("activate"); |
| 59 | Telemetry.send(activateExtensionEvent); |
| 60 | |
| 61 | warnWhenReactNativeVersionIsNotSupported(); |
| 62 | entryPointHandler.runFunction("debugger.setupLauncherStub", |
| 63 | ErrorHelper.getInternalError(InternalErrorCode.DebuggerStubLauncherFailed), () => |
| 64 | setupReactNativeDebugger() |
| 65 | .then(() => |
| 66 | setupAndDispose(new ReactDirManager(), context)) |
| 67 | .then(() => |
| 68 | setupAndDispose(new ExtensionServer(globalPackager, packagerStatusIndicator), context)) |
| 69 | .then(() => {})); |
| 70 | entryPointHandler.runFunction("intelliSense.setup", |
| 71 | ErrorHelper.getInternalError(InternalErrorCode.IntellisenseSetupFailed), () => |
| 72 | IntellisenseHelper.setupReactNativeIntellisense()); |
| 73 | } |
| 74 | entryPointHandler.runFunction("debugger.setupNodeDebuggerLocation", |
| 75 | ErrorHelper.getInternalError(InternalErrorCode.NodeDebuggerConfigurationFailed), () => |
| 76 | configureNodeDebuggerLocation()); |
| 77 | registerReactNativeCommands(context); |
| 78 | }); |
| 79 | }); |
| 80 | } |
| 81 | |
| 82 | export function deactivate(): void { |
| 83 | // Kill any packager processes that we spawned |
| 84 | entryPointHandler.runFunction("extension.deactivate", |
| 85 | ErrorHelper.getInternalError(InternalErrorCode.FailedToStopPackagerOnExit), |
| 86 | () => { |
| 87 | commandPaletteHandler.stopPackager(); |
| 88 | }, /*errorsAreFatal*/ true); |
| 89 | } |
| 90 | |
| 91 | function configureNodeDebuggerLocation(): Q.Promise<void> { |
| 92 | const nodeDebugExtension = vscode.extensions.getExtension("ms-vscode.node-debug") // We try to get the new version |
| 93 | || vscode.extensions.getExtension("andreweinand.node-debug"); // If it's not available, we try to get the old version |
| 94 | if (!nodeDebugExtension) { |
| 95 | return Q.reject<void>(ErrorHelper.getInternalError(InternalErrorCode.CouldNotFindLocationOfNodeDebugger)); |
| 96 | } |
| 97 | const nodeDebugPath = nodeDebugExtension.extensionPath; |
| 98 | return fsUtil.writeFile(path.resolve(__dirname, "../", "debugger", "nodeDebugLocation.json"), JSON.stringify({ nodeDebugPath })); |
| 99 | } |
| 100 | |
| 101 | function setupAndDispose<T extends ISetupableDisposable>(setuptableDisposable: T, context: vscode.ExtensionContext): Q.Promise<T> { |
| 102 | return setuptableDisposable.setup() |
| 103 | .then(() => { |
| 104 | context.subscriptions.push(setuptableDisposable); |
| 105 | return setuptableDisposable; |
| 106 | }); |
| 107 | } |
| 108 | |
| 109 | function warnWhenReactNativeVersionIsNotSupported(): void { |
| 110 | return reactNativeProjectHelper.validateReactNativeVersion().done(() => { }, reason => { |
| 111 | TelemetryHelper.sendSimpleEvent("unsupportedRNVersion", { rnVersion: reason }); |
| 112 | const shortMessage = `React Native Tools need React Native version 0.19.0 or later to be installed in <PROJECT_ROOT>/node_modules/`; |
| 113 | const longMessage = `${shortMessage}: ${reason}`; |
| 114 | vscode.window.showWarningMessage(shortMessage); |
| 115 | Log.logMessage(longMessage); |
| 116 | }); |
| 117 | } |
| 118 | |
| 119 | function registerReactNativeCommands(context: vscode.ExtensionContext): void { |
| 120 | // Register React Native commands |
| 121 | registerVSCodeCommand(context, "runAndroid", ErrorHelper.getInternalError(InternalErrorCode.FailedToRunOnAndroid), () => commandPaletteHandler.runAndroid()); |
| 122 | registerVSCodeCommand(context, "runIos", ErrorHelper.getInternalError(InternalErrorCode.FailedToRunOnIos), () => commandPaletteHandler.runIos()); |
| 123 | registerVSCodeCommand(context, "startPackager", ErrorHelper.getInternalError(InternalErrorCode.FailedToStartPackager), () => commandPaletteHandler.startPackager()); |
| 124 | registerVSCodeCommand(context, "stopPackager", ErrorHelper.getInternalError(InternalErrorCode.FailedToStopPackager), () => commandPaletteHandler.stopPackager()); |
| 125 | } |
| 126 | |
| 127 | function registerVSCodeCommand( |
| 128 | context: vscode.ExtensionContext, commandName: string, |
| 129 | error: InternalError, commandHandler: () => Q.Promise<void>): void { |
| 130 | context.subscriptions.push(vscode.commands.registerCommand( |
| 131 | `reactNative.${commandName}`, |
| 132 | () => |
| 133 | entryPointHandler.runFunction( |
| 134 | `commandPalette.${commandName}`, error, |
| 135 | commandHandler))); |
| 136 | } |
| 137 | |
| 138 | /** |
| 139 | * Sets up the debugger for the React Native project by dropping |
| 140 | * the debugger stub into the workspace |
| 141 | */ |
| 142 | function setupReactNativeDebugger(): Q.Promise<void> { |
| 143 | const launcherPath = require.resolve("../debugger/launcher"); |
| 144 | const pkg = require("../../package.json"); |
| 145 | const extensionVersionNumber = pkg.version; |
| 146 | const extensionName = pkg.name; |
| 147 | |
| 148 | let debuggerEntryCode = |
| 149 | `// This file is automatically generated by ${extensionName}@${extensionVersionNumber} |
| 150 | // Please do not modify it manually. All changes will be lost. |
| 151 | try { |
| 152 | var path = require("path"); |
| 153 | var Launcher = require(${JSON.stringify(launcherPath)}).Launcher; |
| 154 | new Launcher(path.resolve(__dirname, "..")).launch(); |
| 155 | } catch (e) { |
| 156 | throw new Error("Unable to launch application. Try deleting .vscode/launchReactNative.js and restarting vscode."); |
| 157 | }`; |
| 158 | |
| 159 | const vscodeFolder = path.join(vscode.workspace.rootPath, ".vscode"); |
| 160 | const debugStub = path.join(vscodeFolder, "launchReactNative.js"); |
| 161 | |
| 162 | return fsUtil.ensureDirectory(vscodeFolder) |
| 163 | .then(() => fsUtil.ensureFileWithContents(debugStub, debuggerEntryCode)) |
| 164 | .catch((err: Error) => { |
| 165 | vscode.window.showErrorMessage(err.message); |
| 166 | }); |
| 167 | } |