Skip to content
This repository has been archived by the owner on Nov 30, 2023. It is now read-only.

Commit

Permalink
Updated Ruby README, test project
Browse files Browse the repository at this point in the history
  • Loading branch information
Chuxel committed Apr 22, 2019
1 parent 8075916 commit d4d28c3
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 11 deletions.
2 changes: 1 addition & 1 deletion containers/ruby-2/.vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"version": "0.2.0",
"configurations": [
{
"name": "Debug Local File",
"name": "Debug Hello",
"type": "Ruby",
"request": "launch",
"cwd": "${workspaceRoot}",
Expand Down
34 changes: 29 additions & 5 deletions containers/ruby-2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,40 @@
| *Definition type* | Dockerfile |
| *Languages, platforms* | Ruby |

## Usage
## Using this definition with an existing folder

[See here for information on using this definition with an existing project](../../README.md#using-a-definition).
This definition does require any special steps to use. Just follow these steps:

If you prefer, you can also just look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.

If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code.
2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
3. Select the Ruby 2 definition.

3. To use latest-and-greatest copy of this definition from the repository:
1. Clone this repository.
2. Copy the contents of `containers/ruby-2/.devcontainer` to the root of your project folder.
3. Start VS Code and open your project folder.

4. After following step 2 or 3, the contents of the `.devcontainer` folder in your project can be adapted to meet your needs.

5. Finally, press <kbd>F1</kbd> and run **Remote-Containers: Reopen Folder in Container** to start using the definition.

## Testing the definition

This definition includes some test code that will help you verify it is working as expected on your system. Follow these steps:

1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
2. Clone this repository.
3. Start VS Code, press <kbd>F1</kbd>, and select **Remote-Containers: Open Folder in Container...**
4. Select the `containers/ruby-2` folder.
5. After the folder has opened in the container, press <kbd>F5</kbd> to start the project.
6. You should see "Hello, Remote Extension Host!" followed by "Hello, Local Extension Host!" in the Debug Console after the program executes.
7. From here, you can add breakpoints or edit the contents of the `test-project` folder to do further testing.

## License

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the MIT License. See [LICENSE](../../LICENSE).
Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE).
9 changes: 4 additions & 5 deletions containers/ruby-2/test-project/hello.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,11 @@
# Licensed under the MIT License. See LICENSE in the project root for license information.
#-----------------------------------------------------------------------------------------

def sayGoodnight(name)
result = "Goodnight, " + name
def sayHello(name)
result = "Hello, " + name + "!"
return result
end


# Time for bed...
puts sayGoodnight("John-Boy")
puts sayGoodnight("Mary-Ellen")
puts sayHello("Remote Extension Host")
puts sayHello("Local Extension Host")

0 comments on commit d4d28c3

Please sign in to comment.