This repository has been archived by the owner on Apr 19, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 75
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Sean Hellum
committed
Feb 5, 2020
1 parent
336cd4d
commit 978aec7
Showing
4 changed files
with
78 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# Bash in Gitpod | ||
|
||
Bash is the default shell for Gitpod. However, if you're developing a Bash script yourself, you may want to configure additional language support. | ||
|
||
## Bash Examples | ||
|
||
<div class="table-container"> | ||
|
||
| Repository | Description | Try It | | ||
|------------|--------------|--------| | ||
|[inlets/inlets](https://github.com/inlets/inlets) | Reverse proxy and service tunnel | [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/inlets/inlets) | ||
|
||
</div> | ||
|
||
## VSCode Extensions | ||
|
||
### ShellCheck | ||
|
||
ShellCheck provides linting for common mistakes in your shell script. | ||
|
||
To use ShellCheck in Gitpod, first, we must install the `shellcheck` tool. Here is a simple Dockerfile to get you started: | ||
|
||
```Dockerfile | ||
FROM gitpod/workspace-full | ||
|
||
USER gitpod | ||
|
||
RUN brew install shellcheck | ||
``` | ||
|
||
You should also install the shellcheck VS Code extension in Gitpod, by adding a [`.gitpod.yml`](https://www.gitpod.io/docs/41_config_gitpod_file/) configuration file to your repository that looks like this (notice the `vscode` extensions section): | ||
|
||
```yaml | ||
image: | ||
file: .gitpod.Dockerfile | ||
|
||
vscode: | ||
extensions: | ||
- [email protected]:hsU/Rd39aqPYowTqL+DbXg== | ||
``` | ||
Not sure about ShellCheck? Try it in Gitpod! | ||
[![JesterOrNot/Gitpod-ShellCheck](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/JesterOrNot/Gitpod-ShellCheck) | ||
### Bash IDE | ||
![](images/bashIDE.png) | ||
<br/> | ||
Just to name a few things Bash IDE adds: Code completion, hovers, and diagnostic reporting. | ||
To install Bash IDE to your repository add the following to your [`.gitpod.Dockerfile`](https://www.gitpod.io/docs/config-docker/) | ||
|
||
```dockerfile | ||
RUN npm i -g bash-language-server | ||
``` | ||
|
||
Also the following in your | ||
[`.gitpod.yml`](https://www.gitpod.io/docs/41-config-gitpod-file/) | ||
|
||
```yaml | ||
vscode: | ||
extensions: | ||
- [email protected]:/qx+rdXE/fGTGWhelNf3aQ== | ||
``` | ||
|
||
Not sure about Bash IDE? Try it in Gitpod | ||
|
||
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/JesterOrNot/Gitpod-BashIDE) | ||
|
||
## External Resources | ||
|
||
- For more on ShellCheck see https://shellcheck.net |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters