microsoft/vscode-react-native

Public

mirrored from https://github.com/microsoft/vscode-react-nativeAvailable

CodeCommitsIssuesPull requestsActionsInsightsSecurity
81f88231b0c98e7265fe93cd7fb01b25ee66f67f

Branches

Tags

  • No tags available.
0Branches0Tags
Go to file
Add file
Code

Clone

HTTPS

Download ZIP

src/extension/rn-extension.ts

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