Merge pull request #365 from franciscocpg/vscode-debug

Vscode debug

Author: HyperBrain

README.md

@@ -548,6 +548,11 @@ Options are:
 :exclamation: The serve command has been removed. See above how to achieve the
 same functionality with the [`serverless-offline`][link-serverless-offline] plugin.
 
+### vscode debugging
+
+To debug your functions using `serverless invoke local` or `serverless-offline`
+check this [`.vscode/launch.json example`][link-examples-babel-webpack-4-vscode-launch].
+
 ## Example with Babel
 
 In the [`examples`][link-examples] folder there is a Serverless project using this
@@ -757,6 +762,7 @@ me to take it over and continue working on the project. That helped to revive it
 [link-webpack-tree]: https://webpack.js.org/guides/tree-shaking/
 [link-webpack-externals]: https://webpack.js.org/configuration/externals/
 [link-examples]: ./examples
+[link-examples-babel-webpack-4-vscode-launch]: ./examples/babel-webpack-4/.vscode/launch.json
 [link-serverless-offline]: https://www.npmjs.com/package/serverless-offline
 [ico-serverless-offline]: https://img.shields.io/npm/v/serverless-offline.svg
 [link-serverless-dynamodb-local]: https://www.npmjs.com/package/serverless-dynamodb-local

examples/babel-webpack-4/.vscode/launch.json

@@ -0,0 +1,77 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+      {
+          "type": "node",
+          "request": "launch",
+          "name": "Launch Serverless Offline",
+          "program": "${workspaceRoot}/node_modules/serverless/bin/serverless",
+          "args": [ "offline", "--noTimeout", "--dontPrintOutput", "--stage=dev" ],
+          "sourceMaps": true,
+          "runtimeArgs": [
+            "--lazy"
+          ],
+          "outFiles": [
+            "${workspaceFolder}/.webpack/**/*.js"
+          ],
+          "protocol": "inspector",
+          "runtimeExecutable": "node",
+          "env": {
+            // Here we set some environment vars that should be set locally.
+            // They can and will overwrite the ones coming from your serverless.yml
+          },
+          "windows": {
+            "program": "${workspaceRoot}\\node_modules\\serverless\\bin\\serverless",
+          }
+      },
+      {
+          "type": "node",
+          "request": "launch",
+          "name": "Launch Invoke Local - first function",
+          "program": "${workspaceRoot}/node_modules/serverless/bin/serverless",
+          "args": [ "invoke", "local", "-f", "first", "--data", "{}" ],
+          "sourceMaps": true,
+          "runtimeArgs": [
+            "--lazy"
+          ],
+          "outFiles": [
+            "${workspaceFolder}/.webpack/**/*.js"
+          ],
+          "protocol": "inspector",
+          "runtimeExecutable": "node",
+          "env": {
+            // Here we set some environment vars that should be set locally.
+            // They can and will overwrite the ones coming from your serverless.yml
+          },
+          "windows": {
+            "program": "${workspaceRoot}\\node_modules\\serverless\\bin\\serverless",
+          }
+      },
+      {
+          "type": "node",
+          "request": "launch",
+          "name": "Launch Invoke Local - second function",
+          "program": "${workspaceRoot}/node_modules/serverless/bin/serverless",
+          "args": [ "invoke", "local", "-f", "second", "--data", "{}" ],
+          "sourceMaps": true,
+          "runtimeArgs": [
+            "--lazy"
+          ],
+          "outFiles": [
+            "${workspaceFolder}/.webpack/**/*.js"
+          ],
+          "protocol": "inspector",
+          "runtimeExecutable": "node",
+          "env": {
+            // Here we set some environment vars that should be set locally.
+            // They can and will overwrite the ones coming from your serverless.yml
+          },
+          "windows": {
+            "program": "${workspaceRoot}\\node_modules\\serverless\\bin\\serverless",
+          }
+      },
+  ]
+}

examples/babel-webpack-4/README.md

@@ -1,6 +1,12 @@
-This is the default babel webpack-4 example to look at, because only dynamic entry point resolution lets you use Serverless completely. Individual packaging with a per-function dependency optimization is only available with that approach.
+This is the default babel webpack-4 example to look at, because only dynamic
+entry point resolution lets you use Serverless completely.
+Individual packaging with a per-function dependency optimization is only
+available with that approach.
 
 You can also try to invoke a function locally:
 ```
 serverless invoke local --function=first --path=./event.json
-```
+```
+
+Also it has a [.vscode/launch.json](.vscode/launch.json) file for debugging the
+functions using `vscode`.