Add VSCode launch configurations (appium#10683)

* Added debug, attach to debug, test-all, and test-current-file
* The debug and attach to debug allow you to run Appium server
* Made some changes to how package.json is located to support being able to run Mocha tests directly from 'test/' instead of from 'build/test/'

Author: dpgraham

.npmignore

@@ -5,6 +5,7 @@ coverage/
 commands-yml/
 docs/
 sample-code/
+.vscode/
 
 _vimrc_local.vim
 *.swp

.vscode/launch.json

@@ -0,0 +1,46 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Debug",
+            "type": "node",
+            "request": "launch",
+            "cwd": "${workspaceFolder}",
+            "console": "integratedTerminal",
+            "args": [
+                "."
+            ]
+        },
+        {
+            "name": "Attach Debug",
+            "type": "node",
+            "request": "attach",
+            "cwd": "${workspaceFolder}",
+            "port": 9229
+        },
+        {
+            "name": "Test All",
+            "type": "node",
+            "request": "launch",
+            "program": "${workspaceFolder}/node_modules/.bin/_mocha",
+            "args": [
+                "--require", "babel-core/register",
+                "--timeout", "999999",
+                "--colors",
+                "${workspaceFolder}/test"
+            ]
+        },
+        {
+            "name": "Test Current File",
+            "type": "node",
+            "request": "launch",
+            "program": "${workspaceFolder}/node_modules/.bin/_mocha",
+            "args": [
+                "--require", "babel-core/register",
+                "--timeout", "999999",
+                "--colors",
+                "${file}"
+            ]
+        }
+    ]
+}

docs/en/contributing-to-appium/appium-from-source.md

@@ -177,6 +177,19 @@ Appium is running in another window with `node .`) with:
 npm run e2e-test
 ```
 
+### Debugging Node
+
+This project has multiple launch configurations for running NodeJS code from within [VSCode](https://code.visualstudio.com/)
+
+* _Debug_: Runs Appium server in debug mode so you can set breakpoints inside VSCode source files
+* _Attach Debug_: Attach to a currently running Appium server
+  * Example Usage
+    * From root, run `node --inspect-brk . --port 5555`
+    * Run `attach debug`
+    * Setup breakpoints in VSCode
+* _Test All_: Runs all mocha tests in `test/`. Can setup breakpoints in test code and source code
+* _Test Current File_: Runs the currently focused-on mocha file. Fails if it's not valid mocha test
+
 ### Committing code
 
 Each Appium package installs a pre-commit hook which will run the [linter](https://eslint.org/) and

lib/config.js

@@ -2,11 +2,10 @@ import _ from 'lodash';
 import path from 'path';
 import { mkdirp, fs } from 'appium-support';
 import { exec } from 'teen_process';
+import { rootDir } from './utils';
 import logger from './logger';
-import pkgObj from '../../package.json'; // eslint-disable-line import/no-unresolved
 
-
-const APPIUM_VER = pkgObj.version;
+const APPIUM_VER = require(path.resolve(rootDir, 'package.json')).version;
 
 function getNodeVersion () {
   // expect v<major>.<minor>.<patch>
@@ -16,10 +15,9 @@ function getNodeVersion () {
 }
 
 async function getGitRev () {
-  let cwd = path.resolve(__dirname, "..", "..");
   let rev = null;
   try {
-    let {stdout} = await exec("git", ["rev-parse", "HEAD"], {cwd});
+    let {stdout} = await exec("git", ["rev-parse", "HEAD"], {rootDir});
     rev = stdout.trim();
   } catch (ign) {}
   return rev;

lib/parser.js

@@ -2,8 +2,7 @@ import fs from 'fs';
 import path from 'path';
 import _ from 'lodash';
 import { ArgumentParser } from 'argparse';
-import pkgObj from '../../package.json';  // eslint-disable-line import/no-unresolved
-
+import { rootDir } from './utils';
 
 const args = [
   [['--shell'], {
@@ -801,7 +800,7 @@ function parseDefaultCaps (caps) {
 
 function getParser () {
   let parser = new ArgumentParser({
-    version: pkgObj.version,
+    version: require(path.resolve(rootDir, 'package.json')).version,
     addHelp: true,
     description: 'A webdriver-compatible server for use with native and hybrid iOS and Android applications.',
     prog: process.argv[1] || 'Appium'

lib/utils.js

@@ -1,7 +1,7 @@
 import _ from 'lodash';
 import logger from './logger';
 import { processCapabilities, BaseDriver } from 'appium-base-driver';
-
+import findRoot from 'find-root';
 
 function inspectObject (args) {
   function getValueArray (obj, indent = '  ') {
@@ -149,4 +149,6 @@ function insertAppiumPrefixes (caps) {
   return prefixedCaps;
 }
 
-export { inspectObject, parseCapsForInnerDriver, insertAppiumPrefixes };
+const rootDir = findRoot(__dirname);
+
+export { inspectObject, parseCapsForInnerDriver, insertAppiumPrefixes, rootDir };

package.json

@@ -53,6 +53,7 @@
     "bluebird": "3.x",
     "continuation-local-storage": "3.x",
     "dateformat": "^3.0.3",
+    "find-root": "^1.1.0",
     "lodash": "4.x",
     "npmlog": "4.x",
     "request": "^2.81.0",
@@ -84,7 +85,7 @@
     "appium-gulp-plugins": "2.x",
     "babel-cli": "^6.26.0",
     "babel-eslint": "7.x",
-    "babel-preset-env": "^1.6.0",
+    "babel-preset-env": "^1.7.0",
     "chai": "4.x",
     "chai-as-promised": "7.x",
     "eslint": "3.x",