Skip to content
GitLab
Switch branch/tag
Find file BlameHistoryPermalink
launchEditor.js 4.57 KiB
1 
/**
2 
 * Copyright (c) 2015-present, Facebook, Inc.
3 
 * All rights reserved.
4 
 *
5 
 * This source code is licensed under the BSD-style license found in the
6 
 * LICENSE file in the root directory of this source tree. An additional grant
7 
 * of patent rights can be found in the PATENTS file in the same directory.
8 
 */
9 
'use strict';
10
11 
var fs = require('fs');
12 
var path = require('path');
13 
var child_process = require('child_process');
14 
const shellQuote = require('shell-quote');
15
16 
function isTerminalEditor(editor) {
17 
  switch (editor) {
18 
    case 'vim':
19 
    case 'emacs':
20 
    case 'nano':
21 
      return true;
22 
  }
23 
  return false;
24 
}
25
26 
// Map from full process name to binary that starts the process
27 
// We can't just re-use full process name, because it will spawn a new instance
28 
// of the app every time
29 
var COMMON_EDITORS = {
30 
  '/Applications/Atom.app/Contents/MacOS/Atom': 'atom',
31 
  '/Applications/Atom Beta.app/Contents/MacOS/Atom Beta': '/Applications/Atom Beta.app/Contents/MacOS/Atom Beta',
32 
  '/Applications/Sublime Text.app/Contents/MacOS/Sublime Text': '/Applications/Sublime Text.app/Contents/SharedSupport/bin/subl',
33 
  '/Applications/Sublime Text 2.app/Contents/MacOS/Sublime Text 2': '/Applications/Sublime Text 2.app/Contents/SharedSupport/bin/subl',
34 
  '/Applications/Visual Studio Code.app/Contents/MacOS/Electron': 'code',
35 
};
36
37 
function addWorkspaceToArgumentsIfExists(args, workspace) {
38 
  if (workspace) {
39 
    args.unshift(workspace);
40 
  }
41 
  return args;
42 
}
43
44 
function getArgumentsForLineNumber(editor, fileName, lineNumber, workspace) {
45 
  switch (path.basename(editor)) {
46 
    case 'vim':
47 
    case 'mvim':
48 
      return [fileName, '+' + lineNumber];
49 
    case 'atom':
50 
    case 'Atom':
51 
    case 'Atom Beta':
52 
    case 'subl':
53 
    case 'sublime':
54 
    case 'wstorm':
55 
    case 'appcode':
56 
    case 'charm':
57 
    case 'idea':
58 
      return [fileName + ':' + lineNumber];
59 
    case 'joe':
60 
    case 'emacs':
61 
    case 'emacsclient':
62 
      return ['+' + lineNumber, fileName];
63 
    case 'rmate':
64 
    case 'mate':
65 
    case 'mine':
66 
      return ['--line', lineNumber, fileName];
67 
    case 'code':
68 
      return addWorkspaceToArgumentsIfExists(
69 
        ['-g', fileName + ':' + lineNumber],
70 
        workspace
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
); } // For all others, drop the lineNumber until we have // a mapping above, since providing the lineNumber incorrectly // can result in errors or confusing behavior. return [fileName]; } function guessEditor() { // Explicit config always wins if (process.env.REACT_EDITOR) { return shellQuote.parse(process.env.REACT_EDITOR); } // Using `ps x` on OSX we can find out which editor is currently running. // Potentially we could use similar technique for Windows and Linux if (process.platform === 'darwin') { try { var output = child_process.execSync('ps x').toString(); var processNames = Object.keys(COMMON_EDITORS); for (var i = 0; i < processNames.length; i++) { var processName = processNames[i]; if (output.indexOf(processName) !== -1) { return [COMMON_EDITORS[processName]]; } } } catch (error) { // Ignore... } } // Last resort, use old skool env vars if (process.env.VISUAL) { return [process.env.VISUAL]; } else if (process.env.EDITOR) { return [process.env.EDITOR]; } return [null]; } var _childProcess = null; function launchEditor(fileName, lineNumber) { if (!fs.existsSync(fileName)) { return; } // Sanitize lineNumber to prevent malicious use on win32 // via: https://github.com/nodejs/node/blob/c3bb4b1aa5e907d489619fb43d233c3336bfc03d/lib/child_process.js#L333 if (lineNumber && isNaN(lineNumber)) { return; } let [editor, ...args] = guessEditor(); if (!editor) { return; } var workspace = null; if (lineNumber) { args = args.concat( getArgumentsForLineNumber(editor, fileName, lineNumber, workspace) ); } else { args.push(fileName); } if (_childProcess && isTerminalEditor(editor)) { // There's an existing editor process already and it's attached
141142143144145146147148149150151152153154155156157158159160161162163
// to the terminal, so go kill it. Otherwise two separate editor // instances attach to the stdin/stdout which gets confusing. _childProcess.kill('SIGKILL'); } if (process.platform === 'win32') { // On Windows, launch the editor in a shell because spawn can only // launch .exe files. _childProcess = child_process.spawn( 'cmd.exe', ['/C', editor].concat(args), { stdio: 'inherit' } ); } else { _childProcess = child_process.spawn(editor, args, { stdio: 'inherit' }); } _childProcess.on('exit', function() { _childProcess = null; }); } module.exports = launchEditor;