From d1d6b8bfaa8decc6ab61ea845372093ff3b97c08 Mon Sep 17 00:00:00 2001 From: Mathias Fredriksson Date: Sat, 27 Jan 2024 14:42:56 +0200 Subject: [PATCH] rename `hcl` codeblocks to `tf` to enable formatter --- .sample/README.md | 8 ++++---- CONTRIBUTING.md | 2 +- README.md | 2 +- aws-region/README.md | 6 +++--- azure-region/README.md | 6 +++--- code-server/README.md | 12 ++++++------ coder-login/README.md | 2 +- dotfiles/README.md | 2 +- exoscale-instance-type/README.md | 6 +++--- exoscale-zone/README.md | 6 +++--- filebrowser/README.md | 6 +++--- fly-region/README.md | 6 +++--- gcp-region/README.md | 8 ++++---- git-clone/README.md | 6 +++--- git-commit-signing/README.md | 2 +- git-config/README.md | 6 +++--- jetbrains-gateway/README.md | 4 ++-- jfrog-oauth/README.md | 8 ++++---- jfrog-token/README.md | 8 ++++---- jupyter-notebook/README.md | 2 +- jupyterlab/README.md | 2 +- personalize/README.md | 2 +- slackme/README.md | 4 ++-- vault-github/README.md | 8 ++++---- vscode-desktop/README.md | 4 ++-- vscode-web/README.md | 4 ++-- 26 files changed, 66 insertions(+), 66 deletions(-) diff --git a/.sample/README.md b/.sample/README.md index f50a101..c842c67 100644 --- a/.sample/README.md +++ b/.sample/README.md @@ -11,7 +11,7 @@ tags: [helper] -```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 `.` 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" diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b45c1f3..cebf71f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,7 +19,7 @@ $ bun test -t '' You can test a module locally by updating the source as follows -```hcl +```tf module "example" { source = "git::https://github.com//.git//?ref=" } diff --git a/README.md b/README.md index 522477b..9d12df4 100644 --- a/README.md +++ b/README.md @@ -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" diff --git a/aws-region/README.md b/aws-region/README.md index 824d7d9..5d2302e 100644 --- a/aws-region/README.md +++ b/aws-region/README.md @@ -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" diff --git a/azure-region/README.md b/azure-region/README.md index b22dedf..e64e827 100644 --- a/azure-region/README.md +++ b/azure-region/README.md @@ -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" diff --git a/code-server/README.md b/code-server/README.md index 9bc0417..347ed0f 100644 --- a/code-server/README.md +++ b/code-server/README.md @@ -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 `.` 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" diff --git a/coder-login/README.md b/coder-login/README.md index 0c5f8d9..d12a41d 100644 --- a/coder-login/README.md +++ b/coder-login/README.md @@ -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" diff --git a/dotfiles/README.md b/dotfiles/README.md index 1383c09..ab42969 100644 --- a/dotfiles/README.md +++ b/dotfiles/README.md @@ -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" diff --git a/exoscale-instance-type/README.md b/exoscale-instance-type/README.md index 4868c9f..000df16 100644 --- a/exoscale-instance-type/README.md +++ b/exoscale-instance-type/README.md @@ -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" @@ -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" @@ -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" diff --git a/exoscale-zone/README.md b/exoscale-zone/README.md index 360c54b..b0617fd 100644 --- a/exoscale-zone/README.md +++ b/exoscale-zone/README.md @@ -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" @@ -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" @@ -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" diff --git a/filebrowser/README.md b/filebrowser/README.md index bde76f6..c141309 100644 --- a/filebrowser/README.md +++ b/filebrowser/README.md @@ -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" diff --git a/fly-region/README.md b/fly-region/README.md index 7e5040f..7a46a36 100644 --- a/fly-region/README.md +++ b/fly-region/README.md @@ -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" diff --git a/gcp-region/README.md b/gcp-region/README.md index a78ed41..e860ed9 100644 --- a/gcp-region/README.md +++ b/gcp-region/README.md @@ -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" diff --git a/git-clone/README.md b/git-clone/README.md index 817a22c..a0e8e46 100644 --- a/git-clone/README.md +++ b/git-clone/README.md @@ -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" diff --git a/git-commit-signing/README.md b/git-commit-signing/README.md index c13e1f8..5dc15a5 100644 --- a/git-commit-signing/README.md +++ b/git-commit-signing/README.md @@ -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" diff --git a/git-config/README.md b/git-config/README.md index 6c9d696..ca60b5a 100644 --- a/git-config/README.md +++ b/git-config/README.md @@ -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" diff --git a/jetbrains-gateway/README.md b/jetbrains-gateway/README.md index c6c473d..4cccfa7 100644 --- a/jetbrains-gateway/README.md +++ b/jetbrains-gateway/README.md @@ -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" diff --git a/jfrog-oauth/README.md b/jfrog-oauth/README.md index 3231e2e..6144797 100644 --- a/jfrog-oauth/README.md +++ b/jfrog-oauth/README.md @@ -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,7 +87,7 @@ 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 { diff --git a/jfrog-token/README.md b/jfrog-token/README.md index 3ea0f9a..aeb2ae1 100644 --- a/jfrog-token/README.md +++ b/jfrog-token/README.md @@ -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,7 +91,7 @@ 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" { ... diff --git a/jupyter-notebook/README.md b/jupyter-notebook/README.md index 69b6176..d181542 100644 --- a/jupyter-notebook/README.md +++ b/jupyter-notebook/README.md @@ -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" diff --git a/jupyterlab/README.md b/jupyterlab/README.md index 8984da2..f89c0e2 100644 --- a/jupyterlab/README.md +++ b/jupyterlab/README.md @@ -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" diff --git a/personalize/README.md b/personalize/README.md index 4ddb036..18dfecb 100644 --- a/personalize/README.md +++ b/personalize/README.md @@ -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" diff --git a/slackme/README.md b/slackme/README.md index 28b1f6a..e542d3d 100644 --- a/slackme/README.md +++ b/slackme/README.md @@ -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" diff --git a/vault-github/README.md b/vault-github/README.md index 8c81d14..b6bfb36 100644 --- a/vault-github/README.md +++ b/vault-github/README.md @@ -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" diff --git a/vscode-desktop/README.md b/vscode-desktop/README.md index f3d05f7..d819cfd 100644 --- a/vscode-desktop/README.md +++ b/vscode-desktop/README.md @@ -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" diff --git a/vscode-web/README.md b/vscode-web/README.md index ae8b48a..bd0dd75 100644 --- a/vscode-web/README.md +++ b/vscode-web/README.md @@ -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"