Skip to content
This repository has been archived by the owner on Apr 19, 2021. It is now read-only.

Commit

Permalink
[docs] Add Elm in Gitpod
Browse files Browse the repository at this point in the history
  • Loading branch information
Sean Hellum committed Mar 13, 2020
1 parent 525f05b commit 6da74ae
Show file tree
Hide file tree
Showing 4 changed files with 73 additions and 0 deletions.
68 changes: 68 additions & 0 deletions src/docs/elm-in-gitpod.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# Elm in Gitpod

## Examples

<div class="table-container">

| Repository | Description | Try It |
|------------|--------------|--------|
|[elm-spa-example](https://github.com/svenefftinge/elm-spa-example) | A Single Page Application written in Elm | [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/svenefftinge/elm-spa-example)

</div>

## Installing Elm

To install Elm please add the following to your [.gitpod.Dockerfile](https://www.gitpod.io/docs/config-gitpod-file/)

```Dockerfile
# Install Elm
RUN curl -L -o elm.gz https://github.com/elm/compiler/releases/download/0.19.1/binary-for-linux-64-bit.gz \
&& gunzip elm.gz \
&& chmod +x elm \
&& sudo mv elm /usr/local/bin/
```

## Formatting Elm Code

To auto-format Elm code add the following to your [.gitpod.Dockerfile](https://www.gitpod.io/docs/config-gitpod-file/)

```Dockerfile
RUN npm install -g elm-format
```

## Testing Elm Code

To test your Elm code please add the following to your [.gitpod.Dockerfile](https://www.gitpod.io/docs/config-gitpod-file/)
```Dockerfile
RUN npm install -g elm-test
```

## Linting Elm Code

To lint your Elm code please add the following to your [.gitpod.Dockerfile](https://www.gitpod.io/docs/config-gitpod-file/)

```Dockerfile
RUN npm install -g elm-analyse
```

## VSCode Extensions

### Elm

![Demo of the Elm extension](images/ElmExtensionDemo.png)

This extension adds many features:

- Peek/Goto definition
- [Intellisense](https://code.visualstudio.com/docs/editor/intellisense)/Code completion
- Hover documentation
- Autoformatting
- Rename symbols

To add this VSCode extension to your repository please add the following to your [.gitpod.yml](https://www.gitpod.io/docs/config-gitpod-file/) file

```yaml
vscode:
extensions:
- [email protected]:rb3k4mPelyC4Fqod9UBvvA==
```
Binary file added src/docs/images/ElmExtensionDemo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions src/docs/languages-and-frameworks.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@ Below is a list of language and framework specific tips & tricks.
* [Rust](/docs/rust-in-gitpod/)
* [Julia](/docs/julia-in-gitpod/)
* [R](/docs/r-in-gitpod/)
* [Elm](/docs/elm-in-gitpod/)
4 changes: 4 additions & 0 deletions src/docs/menu.ts
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,10 @@ export const MENU: MenuEntry[] = [
M(
"R",
"r-in-gitpod"
),
M(
"Elm",
"elm-in-gitpod"
)
]
),
Expand Down

0 comments on commit 6da74ae

Please sign in to comment.