publicWagsHome/modules
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

chore: add prettier terraform formatting in markdown files (#134)

Browse Source
This commit is contained in:
Mathias Fredriksson
2024-01-27 15:02:40 +02:00
committed by GitHub
parent 7d31865c94
commit 376c0cae31
27 changed files with 230 additions and 223 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
.sample/README.md
View File

@@ -11,7 +11,7 @@ tags: [helper]
<!-- Describes what this module does -->
```hcl
```tf
module "MODULE_NAME" {
source = "registry.coder.com/modules/MODULE_NAME/coder"
version = "1.0.0"
@@ -26,7 +26,7 @@ module "MODULE_NAME" {
Install the Dracula theme from [OpenVSX](https://open-vsx.org/):
```hcl
```tf
module "MODULE_NAME" {
source = "registry.coder.com/modules/MODULE_NAME/coder"
version = "1.0.0"
@@ -43,7 +43,7 @@ Enter the `<author>.<name>` into the extensions array and code-server will autom
Configure VS Code's [settings.json](https://code.visualstudio.com/docs/getstarted/settings#_settingsjson) file:
```hcl
```tf
module "MODULE_NAME" {
source = "registry.coder.com/modules/MODULE_NAME/coder"
version = "1.0.0"
@@ -59,7 +59,7 @@ module "MODULE_NAME" {
Run code-server in the background, don't fetch it from GitHub:
```hcl
```tf
module "MODULE_NAME" {
source = "registry.coder.com/modules/MODULE_NAME/coder"
version = "1.0.0"

2
CONTRIBUTING.md
View File

@@ -19,7 +19,7 @@ $ bun test -t '<module>'
You can test a module locally by updating the source as follows
```hcl
```tf
module "example" {
source = "git::https://github.com/<USERNAME>/<REPO>.git//<MODULE-NAME>?ref=<BRANCH-NAME>"
}

2
README.md
View File

@@ -14,7 +14,7 @@ Modules extend Templates to create reusable components for your development envi
e.g.
```hcl
```tf
module "code-server" {
source = "registry.coder.com/modules/code-server/coder"
version = "1.0.0"

6
aws-region/README.md
View File

@@ -14,7 +14,7 @@ the region closest to them.
Customize the preselected parameter value:
```hcl
```tf
module "aws-region" {
source = "registry.coder.com/modules/aws-region/coder"
version = "1.0.0"
@@ -34,7 +34,7 @@ provider "aws" {
Change the display name and icon for a region using the corresponding maps:
```hcl
```tf
module "aws-region" {
source = "registry.coder.com/modules/aws-region/coder"
version = "1.0.0"
@@ -58,7 +58,7 @@ provider "aws" {
Hide the Asia Pacific regions Seoul and Osaka:
```hcl
```tf
module "aws-region" {
source = "registry.coder.com/modules/aws-region/coder"
version = "1.0.0"

6
azure-region/README.md
View File

@@ -11,7 +11,7 @@ tags: [helper, parameter, azure, regions]
This module adds a parameter with all Azure regions, allowing developers to select the region closest to them.
```hcl
```tf
module "azure_region" {
source = "registry.coder.com/modules/azure-region/coder"
version = "1.0.0"
@@ -31,7 +31,7 @@ resource "azurem_resource_group" "example" {
Change the display name and icon for a region using the corresponding maps:
```hcl
```tf
module "azure-region" {
source = "registry.coder.com/modules/azure-region/coder"
version = "1.0.0"
@@ -54,7 +54,7 @@ resource "azurerm_resource_group" "example" {
Hide all regions in Australia except australiacentral:
```hcl
```tf
module "azure-region" {
source = "registry.coder.com/modules/azure-region/coder"
version = "1.0.0"

12
code-server/README.md
View File

@@ -11,7 +11,7 @@ tags: [helper, ide, web]
Automatically install [code-server](https://github.com/coder/code-server) in a workspace, create an app to access it via the dashboard, install extensions, and pre-configure editor settings.
```hcl
```tf
module "code-server" {
source = "registry.coder.com/modules/code-server/coder"
version = "1.0.0"
@@ -25,7 +25,7 @@ module "code-server" {
### Pin Versions
```hcl
```tf
module "code-server" {
source = "registry.coder.com/modules/code-server/coder"
version = "1.0.0"
@@ -38,7 +38,7 @@ module "code-server" {
Install the Dracula theme from [OpenVSX](https://open-vsx.org/):
```hcl
```tf
module "code-server" {
source = "registry.coder.com/modules/code-server/coder"
version = "1.0.0"
@@ -55,7 +55,7 @@ Enter the `<author>.<name>` into the extensions array and code-server will autom
Configure VS Code's [settings.json](https://code.visualstudio.com/docs/getstarted/settings#_settingsjson) file:
```hcl
```tf
module "settings" {
source = "registry.coder.com/modules/code-server/coder"
version = "1.0.0"
@@ -71,7 +71,7 @@ module "settings" {
Just run code-server in the background, don't fetch it from GitHub:
```hcl
```tf
module "settings" {
source = "registry.coder.com/modules/code-server/coder"
version = "1.0.0"
@@ -84,7 +84,7 @@ module "settings" {
Just run code-server in the background, don't fetch it from GitHub:
```hcl
```tf
module "settings" {
source = "registry.coder.com/modules/code-server/coder"
version = "1.0.0"

2
coder-login/README.md
View File

@@ -11,7 +11,7 @@ tags: [helper]
Automatically logs the user into Coder when creating their workspace.
```hcl
```tf
module "coder-login" {
source = "registry.coder.com/modules/coder-login/coder"
version = "1.0.0"

2
dotfiles/README.md
View File

@@ -11,7 +11,7 @@ tags: [helper]
Allow developers to optionally bring their own [dotfiles repository](https://dotfiles.github.io)! Under the hood, this module uses the [coder dotfiles](https://coder.com/docs/v2/latest/dotfiles) command.
```hcl
```tf
module "dotfiles" {
source = "registry.coder.com/modules/dotfiles/coder"
version = "1.0.0"

12
exoscale-instance-type/README.md
View File

@@ -14,7 +14,7 @@ their desired virtuell machine for the workspace.
Customize the preselected parameter value:
```hcl
```tf
module "exoscale-instance-type" {
source = "registry.coder.com/modules/exoscale-instance-type/coder"
version = "1.0.0"
@@ -23,7 +23,7 @@ module "exoscale-instance-type" {
resource "exoscale_compute_instance" "instance" {
type = module.exoscale-instance-type.value
...
# ...
}
resource "coder_metadata" "workspace_info" {
@@ -42,7 +42,7 @@ resource "coder_metadata" "workspace_info" {
Change the display name a type using the corresponding maps:
```hcl
```tf
module "exoscale-instance-type" {
source = "registry.coder.com/modules/exoscale-instance-type/coder"
version = "1.0.0"
@@ -57,7 +57,7 @@ module "exoscale-instance-type" {
resource "exoscale_compute_instance" "instance" {
type = module.exoscale-instance-type.value
...
# ...
}
resource "coder_metadata" "workspace_info" {
@@ -74,7 +74,7 @@ resource "coder_metadata" "workspace_info" {
Show only gpu1 types
```hcl
```tf
module "exoscale-instance-type" {
source = "registry.coder.com/modules/exoscale-instance-type/coder"
version = "1.0.0"
@@ -94,7 +94,7 @@ module "exoscale-instance-type" {
resource "exoscale_compute_instance" "instance" {
type = module.exoscale-instance-type.value
...
# ...
}
resource "coder_metadata" "workspace_info" {

12
exoscale-zone/README.md
View File

@@ -14,7 +14,7 @@ the zone closest to them.
Customize the preselected parameter value:
```hcl
```tf
module "exoscale-zone" {
source = "registry.coder.com/modules/exoscale-zone/coder"
version = "1.0.0"
@@ -29,7 +29,7 @@ data "exoscale_compute_template" "my_template" {
resource "exoscale_compute_instance" "instance" {
zone = module.exoscale-zone.value
....
# ...
}
```
@@ -41,7 +41,7 @@ resource "exoscale_compute_instance" "instance" {
Change the display name and icon for a zone using the corresponding maps:
```hcl
```tf
module "exoscale-zone" {
source = "registry.coder.com/modules/exoscale-zone/coder"
version = "1.0.0"
@@ -61,7 +61,7 @@ data "exoscale_compute_template" "my_template" {
resource "exoscale_compute_instance" "instance" {
zone = module.exoscale-zone.value
....
# ...
}
```
@@ -71,7 +71,7 @@ resource "exoscale_compute_instance" "instance" {
Hide the Switzerland zones Geneva and Zurich
```hcl
```tf
module "exoscale-zone" {
source = "registry.coder.com/modules/exoscale-zone/coder"
version = "1.0.0"
@@ -85,7 +85,7 @@ data "exoscale_compute_template" "my_template" {
resource "exoscale_compute_instance" "instance" {
zone = module.exoscale-zone.value
....
# ...
}
```

6
filebrowser/README.md
View File

@@ -11,7 +11,7 @@ tags: [helper, filebrowser]
A file browser for your workspace.
```hcl
```tf
module "filebrowser" {
source = "registry.coder.com/modules/filebrowser/coder"
version = "1.0.0"
@@ -25,7 +25,7 @@ module "filebrowser" {
### Serve a specific directory
```hcl
```tf
module "filebrowser" {
source = "registry.coder.com/modules/filebrowser/coder"
version = "1.0.0"
@@ -36,7 +36,7 @@ module "filebrowser" {
### Specify location of `filebrowser.db`
```hcl
```tf
module "filebrowser" {
source = "registry.coder.com/modules/filebrowser/coder"
version = "1.0.0"

6
fly-region/README.md
View File

@@ -13,7 +13,7 @@ This module adds Fly.io regions to your Coder template. Regions can be whitelist
We can use the simplest format here, only adding a default selection as the `atl` region.
```hcl
```tf
module "fly-region" {
source = "registry.coder.com/modules/fly-region/coder"
version = "1.0.0"
@@ -29,7 +29,7 @@ module "fly-region" {
The regions argument can be used to display only the desired regions in the Coder parameter.
```hcl
```tf
module "fly-region" {
source = "registry.coder.com/modules/fly-region/coder"
version = "1.0.0"
@@ -44,7 +44,7 @@ module "fly-region" {
Set custom icons and names with their respective maps.
```hcl
```tf
module "fly-region" {
source = "registry.coder.com/modules/fly-region/coder"
version = "1.0.0"

8
gcp-region/README.md
View File

@@ -11,7 +11,7 @@ tags: [gcp, regions, parameter, helper]
This module adds Google Cloud Platform regions to your Coder template.
```hcl
```tf
module "gcp_region" {
source = "registry.coder.com/modules/gcp-region/coder"
version = "1.0.0"
@@ -31,7 +31,7 @@ resource "google_compute_instance" "example" {
Note: setting `gpu_only = true` and using a default region without GPU support, the default will be set to `null`.
```hcl
```tf
module "gcp_region" {
source = "registry.coder.com/modules/gcp-region/coder"
version = "1.0.0"
@@ -47,7 +47,7 @@ resource "google_compute_instance" "example" {
### Add all zones in the Europe West region
```hcl
```tf
module "gcp_region" {
source = "registry.coder.com/modules/gcp-region/coder"
version = "1.0.0"
@@ -62,7 +62,7 @@ resource "google_compute_instance" "example" {
### Add a single zone from each region in US and Europe that laos has GPUs
```hcl
```tf
module "gcp_region" {
source = "registry.coder.com/modules/gcp-region/coder"
version = "1.0.0"

6
git-clone/README.md
View File

@@ -11,7 +11,7 @@ tags: [git, helper]
This module allows you to automatically clone a repository by URL and skip if it exists in the base directory provided.
```hcl
```tf
module "git-clone" {
source = "registry.coder.com/modules/git-clone/coder"
version = "1.0.0"
@@ -22,7 +22,7 @@ module "git-clone" {
To use with [Git Authentication](https://coder.com/docs/v2/latest/admin/git-providers), add the provider by ID to your template:
```hcl
```tf
data "coder_git_auth" "github" {
id = "github"
}
@@ -32,7 +32,7 @@ data "coder_git_auth" "github" {
### Custom Path
```hcl
```tf
module "git-clone" {
source = "registry.coder.com/modules/git-clone/coder"
version = "1.0.0"

2
git-commit-signing/README.md
View File

@@ -16,7 +16,7 @@ Please observe that using the SSH key that's part of your Coder account for comm
This module has a chance of conflicting with the user's dotfiles / the personalize module if one of those has configuration directives that overwrite this module's / each other's git configuration.
```hcl
```tf
module "git-commit-signing" {
source = "registry.coder.com/modules/git-commit-signing/coder"
version = "1.0.0"

6
git-config/README.md
View File

@@ -11,7 +11,7 @@ tags: [helper, git]
Runs a script that updates git credentials in the workspace to match the user's Coder credentials, optionally allowing to the developer to override the defaults.
```hcl
```tf
module "git-config" {
source = "registry.coder.com/modules/git-config/coder"
version = "1.0.0"
@@ -25,7 +25,7 @@ TODO: Add screenshot
### Allow users to override both username and email
```hcl
```tf
module "git-config" {
source = "registry.coder.com/modules/git-config/coder"
version = "1.0.0"
@@ -38,7 +38,7 @@ TODO: Add screenshot
## Disallowing users from overriding both username and email
```hcl
```tf
module "git-config" {
source = "registry.coder.com/modules/git-config/coder"
version = "1.0.0"

4
jetbrains-gateway/README.md
View File

@@ -11,7 +11,7 @@ tags: [ide, jetbrains, helper, parameter]
This module adds a JetBrains Gateway Button to open any workspace with a single click.
```hcl
```tf
module "jetbrains_gateway" {
source = "registry.coder.com/modules/jetbrains-gateway/coder"
version = "1.0.0"
@@ -28,7 +28,7 @@ module "jetbrains_gateway" {
### Add GoLand and WebStorm with the default set to GoLand
```hcl
```tf
module "jetbrains_gateway" {
source = "registry.coder.com/modules/jetbrains-gateway/coder"
version = "1.0.0"

10
jfrog-oauth/README.md
View File

@@ -14,7 +14,7 @@ Install the JF CLI and authenticate package managers with Artifactory using OAut
![JFrog OAuth](../.images/jfrog-oauth.png)
```hcl
```tf
module "jfrog" {
source = "registry.coder.com/modules/jfrog-oauth/coder"
version = "1.0.0"
@@ -40,7 +40,7 @@ This module is usable by JFrog self-hosted (on-premises) Artifactory as it requi
Configure the Python pip package manager to fetch packages from Artifactory while mapping the Coder email to the Artifactory username.
```hcl
```tf
module "jfrog" {
source = "registry.coder.com/modules/jfrog-oauth/coder"
version = "1.0.0"
@@ -67,7 +67,7 @@ pip install requests
The [JFrog extension](https://open-vsx.org/extension/JFrog/jfrog-vscode-extension) for VS Code allows you to interact with Artifactory from within the IDE.
```hcl
```tf
module "jfrog" {
source = "registry.coder.com/modules/jfrog-oauth/coder"
version = "1.0.0"
@@ -87,9 +87,9 @@ module "jfrog" {
JFrog Access token is also available as a terraform output. You can use it in other terraform resources. For example, you can use it to configure an [Artifactory docker registry](https://jfrog.com/help/r/jfrog-artifactory-documentation/docker-registry) with the [docker terraform provider](https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs).
```hcl
```tf
provider "docker" {
...
# ...
registry_auth {
address = "https://example.jfrog.io/artifactory/api/docker/REPO-KEY"
username = module.jfrog.username

10
jfrog-token/README.md
View File

@@ -12,7 +12,7 @@ tags: [integration, jfrog]
Install the JF CLI and authenticate package managers with Artifactory using Artifactory terraform provider.
```hcl
```tf
module "jfrog" {
source = "registry.coder.com/modules/jfrog-token/coder"
version = "1.0.0"
@@ -38,7 +38,7 @@ For detailed instructions, please see this [guide](https://coder.com/docs/v2/lat
### Configure npm, go, and pypi to use Artifactory local repositories
```hcl
```tf
module "jfrog" {
source = "registry.coder.com/modules/jfrog-token/coder"
version = "1.0.0"
@@ -71,7 +71,7 @@ pip install requests
The [JFrog extension](https://open-vsx.org/extension/JFrog/jfrog-vscode-extension) for VS Code allows you to interact with Artifactory from within the IDE.
```hcl
```tf
module "jfrog" {
source = "registry.coder.com/modules/jfrog-token/coder"
version = "1.0.0"
@@ -91,10 +91,10 @@ module "jfrog" {
JFrog Access token is also available as a terraform output. You can use it in other terraform resources. For example, you can use it to configure an [Artifactory docker registry](https://jfrog.com/help/r/jfrog-artifactory-documentation/docker-registry) with the [docker terraform provider](https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs).
```hcl
```tf
provider "docker" {
...
# ...
registry_auth {
address = "https://YYYY.jfrog.io/artifactory/api/docker/REPO-KEY"
username = module.jfrog.username

2
jupyter-notebook/README.md
View File

@@ -13,7 +13,7 @@ A module that adds Jupyter Notebook in your Coder template.
![Jupyter Notebook](../.images/jupyter-notebook.png)
```hcl
```tf
module "jupyter-notebook" {
source = "registry.coder.com/modules/jupyter-notebook/coder"
version = "1.0.0"

2
jupyterlab/README.md
View File

@@ -13,7 +13,7 @@ A module that adds JupyterLab in your Coder template.
![JupyterLab](../.images/jupyterlab.png)
```hcl
```tf
module "jupyterlab" {
source = "registry.coder.com/modules/jupyterlab/coder"
version = "1.0.0"

13
package.json
View File

@@ -2,17 +2,24 @@
"name": "modules",
"scripts": {
"test": "bun test",
"fmt": "bun x prettier --plugin prettier-plugin-sh -w **/*.sh .sample/run.sh new.sh **/*.ts **/*.md *.md && terraform fmt **/*.tf .sample/main.tf",
"fmt:ci": "bun x prettier --plugin prettier-plugin-sh --check **/*.sh .sample/run.sh new.sh **/*.ts **/*.md *.md && terraform fmt -check **/*.tf .sample/main.tf",
"fmt": "bun x prettier -w **/*.sh .sample/run.sh new.sh **/*.ts **/*.md *.md && terraform fmt **/*.tf .sample/main.tf",
"fmt:ci": "bun x prettier --check **/*.sh .sample/run.sh new.sh **/*.ts **/*.md *.md && terraform fmt -check **/*.tf .sample/main.tf",
"lint": "bun run lint.ts"
},
"devDependencies": {
"bun-types": "^1.0.18",
"gray-matter": "^4.0.3",
"marked": "^11.1.0",
"prettier-plugin-sh": "^0.13.1"
"prettier-plugin-sh": "^0.13.1",
"prettier-plugin-terraform-formatter": "^1.2.1"
},
"peerDependencies": {
"typescript": "^5.3.3"
},
"prettier": {
"plugins": [
"prettier-plugin-sh",
"prettier-plugin-terraform-formatter"
]
}
}

2
personalize/README.md
View File

@@ -11,7 +11,7 @@ tags: [helper]
Run a script on workspace start that allows developers to run custom commands to personalize their workspace.
```hcl
```tf
module "personalize" {
source = "registry.coder.com/modules/personalize/coder"
version = "1.0.0"

4
slackme/README.md
View File

@@ -54,7 +54,7 @@ slackme npm run long-build
3. Restart your Coder deployment. Any Template can now import the Slack Me module, and `slackme` will be available on the `$PATH`:
```hcl
```tf
module "slackme" {
source = "registry.coder.com/modules/slackme/coder"
version = "1.0.0"
@@ -70,7 +70,7 @@ slackme npm run long-build
- `$COMMAND` is replaced with the command the user executed.
- `$DURATION` is replaced with a human-readable duration the command took to execute.
```hcl
```tf
module "slackme" {
source = "registry.coder.com/modules/slackme/coder"
version = "1.0.0"

8
vault-github/README.md
View File

@@ -11,7 +11,7 @@ tags: [helper, integration, vault, github]
This module lets you authenticate with [Hashicorp Vault](https://www.vaultproject.io/) in your Coder workspaces using [external auth](https://coder.com/docs/v2/latest/admin/external-auth) for GitHub.
```hcl
```tf
module "vault" {
source = "registry.coder.com/modules/vault-github/coder"
version = "1.0.0"
@@ -42,7 +42,7 @@ To configure the Vault module, you must set up a Vault GitHub auth method. See t
### Configure Vault integration with a different Coder GitHub external auth ID (i.e., not the default `github`)
```hcl
```tf
module "vault" {
source = "registry.coder.com/modules/vault-github/coder"
version = "1.0.0"
@@ -54,7 +54,7 @@ module "vault" {
### Configure Vault integration with a different Coder GitHub external auth ID and a different Vault GitHub auth path
```hcl
```tf
module "vault" {
source = "registry.coder.com/modules/vault-github/coder"
version = "1.0.0"
@@ -67,7 +67,7 @@ module "vault" {
### Configure Vault integration and install a specific version of the Vault CLI
```hcl
```tf
module "vault" {
source = "registry.coder.com/modules/vault-github/coder"
version = "1.0.0"

4
vscode-desktop/README.md
View File

@@ -13,7 +13,7 @@ Add a button to open any workspace with a single click.
Uses the [Coder Remote VS Code Extension](https://github.com/coder/vscode-coder).
```hcl
```tf
module "vscode" {
source = "registry.coder.com/modules/vscode-desktop/coder"
version = "1.0.0"
@@ -25,7 +25,7 @@ module "vscode" {
### Open in a specific directory
```hcl
```tf
module "vscode" {
source = "registry.coder.com/modules/vscode-desktop/coder"
version = "1.0.0"

4
vscode-web/README.md
View File

@@ -11,7 +11,7 @@ tags: [helper, ide, vscode, web]
Automatically install [Visual Studio Code Server](https://code.visualstudio.com/docs/remote/vscode-server) in a workspace using the [VS Code CLI](https://code.visualstudio.com/docs/editor/command-line) and create an app to access it via the dashboard.
```hcl
```tf
module "vscode-web" {
source = "registry.coder.com/modules/vscode-web/coder"
version = "1.0.0"
@@ -26,7 +26,7 @@ module "vscode-web" {
### Install VS Code Web to a custom folder
```hcl
```tf
module "vscode-web" {
source = "registry.coder.com/modules/vscode-web/coder"
version = "1.0.0"