diff --git a/README.md b/README.md index 3ed20cd1666..6f8d1026c61 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,32 @@ # AWS Toolkit for Visual Studio Code -| System | Status | -| ------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Build ([master](https://github.com/aws/aws-toolkit-vscode/tree/master) branch) | [![TravisCI Build Status - master branch](https://travis-ci.org/aws/aws-toolkit-vscode.svg?branch=master)](https://travis-ci.org/aws/aws-toolkit-vscode) ![CodeBuild Build Status - master branch](https://codebuild.us-west-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiMlluaDRTMnZLdmMvcFREQVQ4RjFoK0FUSTZPdlRVcWJlQ2gwRElLT2gxZDhMeno5MThZZnlXdURDVFFjOWdqSEQ5QjVBYm0xSURoU3E1RTVHejltcnZrPSIsIml2UGFyYW1ldGVyU3BlYyI6IkY3SE9CaG1oMHhJUmsyakkiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master) [![Coverage](https://img.shields.io/codecov/c/github/aws/aws-toolkit-vscode/master.svg)](https://codecov.io/gh/aws/aws-toolkit-vscode/branch/master) [![LGTM Grade](https://img.shields.io/lgtm/grade/javascript/github/aws/aws-toolkit-vscode)](https://lgtm.com/projects/g/aws/aws-toolkit-vscode/) | -| [Marketplace](https://marketplace.visualstudio.com/items?itemName=AmazonWebServices.aws-toolkit-vscode) | [![Marketplace Version](https://img.shields.io/vscode-marketplace/v/AmazonWebServices.aws-toolkit-vscode.svg) ![Marketplace Downloads](https://img.shields.io/vscode-marketplace/d/AmazonWebServices.aws-toolkit-vscode.svg)](https://marketplace.visualstudio.com/items?itemName=AmazonWebServices.aws-toolkit-vscode) | +| System | Status | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Build ([main branch](https://github.com/aws/aws-toolkit-vscode/commits/master)) | [![GitHub CI status](https://github.com/aws/aws-toolkit-vscode/workflows/CI/badge.svg)](https://github.com/aws/aws-toolkit-vscode/actions) ![CodeBuild Build Status - main branch](https://codebuild.us-west-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiMlluaDRTMnZLdmMvcFREQVQ4RjFoK0FUSTZPdlRVcWJlQ2gwRElLT2gxZDhMeno5MThZZnlXdURDVFFjOWdqSEQ5QjVBYm0xSURoU3E1RTVHejltcnZrPSIsIml2UGFyYW1ldGVyU3BlYyI6IkY3SE9CaG1oMHhJUmsyakkiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master) [![Coverage](https://img.shields.io/codecov/c/github/aws/aws-toolkit-vscode/master.svg)](https://codecov.io/gh/aws/aws-toolkit-vscode/branch/master) [![LGTM Grade](https://img.shields.io/lgtm/grade/javascript/github/aws/aws-toolkit-vscode)](https://lgtm.com/projects/g/aws/aws-toolkit-vscode/) | +| [Marketplace](https://marketplace.visualstudio.com/items?itemName=AmazonWebServices.aws-toolkit-vscode) | [![Marketplace Version](https://img.shields.io/vscode-marketplace/v/AmazonWebServices.aws-toolkit-vscode.svg) ![Marketplace Downloads](https://img.shields.io/vscode-marketplace/d/AmazonWebServices.aws-toolkit-vscode.svg)](https://marketplace.visualstudio.com/items?itemName=AmazonWebServices.aws-toolkit-vscode) | The AWS Toolkit for Visual Studio Code is an extension for working with AWS services such as AWS Lambda. The Toolkit is available from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/itemdetails?itemName=AmazonWebServices.aws-toolkit-vscode). -This is an open source project because we want you to be involved. We love issues, feature requests, code reviews, pull -requests or any positive contribution. See [CONTRIBUTING](CONTRIBUTING.md) for how to help. +This is an open source project because we want you to be involved. We love issues, feature requests, code reviews, pull +requests or any positive contribution. See [CONTRIBUTING.md](CONTRIBUTING.md). ## Documentation -- The [Quick Start Guide](extension-readme.md) provides a summary of the Toolkit and the most common tasks. -- The [User Guide](https://docs.aws.amazon.com/console/toolkit-for-vscode/welcome) contains detailed instructions for getting up and running with the Toolkit. +- The [Quick Start Guide](README.quickstart.vscode.md) provides an overview + of common Toolkit tasks. +- The [User Guide](https://docs.aws.amazon.com/console/toolkit-for-vscode/welcome) + contains detailed instructions for getting up and running with the Toolkit. ## Feedback We want your feedback! -- Upvote 👍 [feature requests](https://github.com/aws/aws-toolkit-vscode/issues?q=is%3Aissue+is%3Aopen+label%3Afeature-request+sort%3Areactions-%2B1-desc) -- [Ask a question](https://github.com/aws/aws-toolkit-vscode/issues/new?labels=guidance&template=guidance_request.md) -- [Request a new feature](https://github.com/aws/aws-toolkit-vscode/issues/new?labels=feature-request&template=feature_request.md) -- [File an issue](https://github.com/aws/aws-toolkit-vscode/issues/new?labels=bug&template=bug_report.md) - -## Debugging from the Debug panel - -CodeLenses appear above Serverless Application Lambda Functions, allowing you to locally debug the Function. If you would like [more control](https://code.visualstudio.com/docs/editor/debugging#_launch-configurations) over the debugging experience, the following links can help you set up debug configurations for your project. - -- [Debugging NodeJS Lambda Functions](docs/debugging-nodejs-lambda-functions.md) -- [Debugging Python Lambda Functions](docs/debugging-python-lambda-functions.md) -- [Debugging .NET Core Lambda Functions](docs/debugging-dotnet-lambda-functions.md) +- Upvote 👍 [feature requests](https://github.com/aws/aws-toolkit-vscode/issues?q=is%3Aissue+is%3Aopen+label%3Afeature-request+sort%3Areactions-%2B1-desc) +- [Ask a question](https://github.com/aws/aws-toolkit-vscode/issues/new?labels=guidance&template=guidance_request.md) +- [Request a new feature](https://github.com/aws/aws-toolkit-vscode/issues/new?labels=feature-request&template=feature_request.md) +- [File an issue](https://github.com/aws/aws-toolkit-vscode/issues/new?labels=bug&template=bug_report.md) ## License diff --git a/docs/debugging-dotnet-lambda-functions.md b/docs/debugging-dotnet-lambda-functions.md index 7212fbc6753..d04bc8db88d 100644 --- a/docs/debugging-dotnet-lambda-functions.md +++ b/docs/debugging-dotnet-lambda-functions.md @@ -10,8 +10,8 @@ You can debug your Serverless Application's AWS Lambda function locally using th 1. Open the folder that contains `template.yaml`. 1. Open a terminal in the folder containing `template.yaml` and set up the debugger by running the following commands: - * Replace `` (in two places) with the *absolute path that corresponds to* the `CodeUri` property (not the `CodeUri` property itself) from `template.yaml` for the resource that you wish to debug. - * If appropriate, replace `dotnetcore2.1` with the framework identifier for the runtime that you are targeting. + - Replace `` (in two places) with the _absolute path that corresponds to_ the `CodeUri` property (not the `CodeUri` property itself) from `template.yaml` for the resource that you wish to debug. + - If appropriate, replace `dotnetcore2.1` with the framework identifier for the runtime that you are targeting. ```bash mkdir /.vsdbg @@ -22,7 +22,7 @@ You can debug your Serverless Application's AWS Lambda function locally using th 1. Open `/.vscode/launch.json` (create a new file if it does not already exist), and add the following contents: - * If desired, replace `5679` with the port that you wish to use for debugging. + - If desired, replace `5679` with the port that you wish to use for debugging. ```jsonc { @@ -35,20 +35,14 @@ You can debug your Serverless Application's AWS Lambda function locally using th "processId": "1", "pipeTransport": { "pipeProgram": "sh", - "pipeArgs": [ - "-c", - "docker exec -i $(docker ps -q -f publish=5679) ${debuggerCommand}" - ], + "pipeArgs": ["-c", "docker exec -i $(docker ps -q -f publish=5679) ${debuggerCommand}"], "debuggerPath": "/tmp/lambci_debug_files/vsdbg", "pipeCwd": "" }, "windows": { "pipeTransport": { "pipeProgram": "powershell", - "pipeArgs": [ - "-c", - "docker exec -i $(docker ps -q -f publish=5679) ${debuggerCommand}" - ], + "pipeArgs": ["-c", "docker exec -i $(docker ps -q -f publish=5679) ${debuggerCommand}"], "debuggerPath": "/tmp/lambci_debug_files/vsdbg", "pipeCwd": "" } @@ -73,8 +67,8 @@ You can debug your Serverless Application's AWS Lambda function locally using th 1. Set a breakpoint anywhere in your lambda handler. 2. Open a terminal in the folder containing `template.yaml`, and run the following commands. The SAM CLI will invoke your lambda handler, and wait for a debugger to attach to it. - * Replace `HelloWorldFunction` with the name of the function that you want to invoke. - * Replace `5679` with the port that you specified in `launch.json`. + - Replace `HelloWorldFunction` with the name of the function that you want to invoke. + - Replace `5679` with the port that you specified in `launch.json`. ```bash # Bash @@ -99,7 +93,7 @@ With the above steps, you need to manually invoke SAM CLI from the command line, 1. Open `/.vscode/tasks.json` (create a new file if it does not already exist). 2. Add the following contents to `tasks.json`: - * Replace `HelloWorldFunction` with the function that you wish to debug. + - Replace `HelloWorldFunction` with the function that you wish to debug. ```jsonc { diff --git a/docs/debugging-nodejs-lambda-functions.md b/docs/debugging-nodejs-lambda-functions.md index 835e643b6a6..14407ffd347 100644 --- a/docs/debugging-nodejs-lambda-functions.md +++ b/docs/debugging-nodejs-lambda-functions.md @@ -16,7 +16,7 @@ Throughout these instructions, replace the following: | ----------------------- | ------------------------------------------------------------------------------------- | | `` | The root of your SAM app (typically this is the directory containing `template.yaml`) | | `` | The root of your Node.js source code (the directory containing `package.json`) | -| `` | Either `inspector` (for Node.js 6.3+) or `legacy` (for prior versions of Node.js) | +| `` | Either `inspector` (for Node.js 6.3+) or `legacy` (for prior versions of Node.js) | 1. Open `/.vscode/launch.json` (create a new file if it does not already exist), and add the following contents. diff --git a/docs/debugging-python-lambda-functions.md b/docs/debugging-python-lambda-functions.md index 4c602583d68..d847f25c5d9 100644 --- a/docs/debugging-python-lambda-functions.md +++ b/docs/debugging-python-lambda-functions.md @@ -14,10 +14,10 @@ You can debug your Serverless Application's AWS Lambda function locally using th Throughout these instructions, replace the following: -|Name|Replace With| -|-|-| -|``|The root of your SAM app (typically this is the directory containing `template.yaml`)| -|``|The root of your Python source code (typically this is the directory containing `requirements.txt`)| +| Name | Replace With | +| ----------------------- | --------------------------------------------------------------------------------------------------- | +| `` | The root of your SAM app (typically this is the directory containing `template.yaml`) | +| `` | The root of your Python source code (typically this is the directory containing `requirements.txt`) | 1. Add the line `ptvsd==4.2.4` to `/requirements.txt` 2. Open a terminal in ``, then run: @@ -50,8 +50,8 @@ Throughout these instructions, replace the following: 1. Open `/.vscode/launch.json` (create a new file if it does not already exist), and add the following contents. - * Due to a bug in how VS Code handles path mappings, Windows users must provide an absolute path for `localRoot`. If you use a path relative to `${workspaceFolder}`, the path mappings will not work. - * If desired, replace `5678` with the port that you wish to use for debugging. + - Due to a bug in how VS Code handles path mappings, Windows users must provide an absolute path for `localRoot`. If you use a path relative to `${workspaceFolder}`, the path mappings will not work. + - If desired, replace `5678` with the port that you wish to use for debugging. ```jsonc {