Integrate markdownlint and remove Prettier for docs

- Replace Prettier with markdownlint for documentation formatting. - Rename `docs-pr.yaml` to `docs-lint.yaml` for clarity. - Adjust `Makefile` to use `fmt/biome` instead of `fmt/prettier`. - Remove `.prettierignore` and `.prettierignore.include` files. - Apply markdownlint formatting across relevant documentation files.
coder · matifali · Jan 3, 2025 · Nov 25, 2024 · Nov 25, 2024 · Nov 25, 2024
commit fcaa91733d51c76f007d1f508f6f0817b4f1bc70
diff --git a/.github/workflows/docs-pr.yaml → .github/workflows/docs-lint.yaml b/.github/workflows/docs-pr.yaml → .github/workflows/docs-lint.yaml
@@ -17,9 +17,9 @@ jobs:
           files: "docs/**/*.md"
           files_ignore: "docs/reference/*.md"
           separator: ","
-      - uses: DavidAnson/markdownlint-cli2-action@v18
+      - name: lint
         if: steps.changed-files.outputs.any_changed == 'true'
-        with:
-          globs: ${{ steps.changed-files.outputs.all_changed_files }}
-          separator: ","
-          config: ".github/actions/docs/markdownlint-cli2/.markdownlint.json"
+        run: |
+          cd site
+          ../scripts/pnpm_install.sh
+          pnpm exec markdownlint-cli2 --fix {{ steps.changed-files.outputs.all_changed_files }}
diff --git a/.prettierignore b/.prettierignore
diff --git a/.prettierignore.include b/.prettierignore.include
diff --git a/Makefile b/Makefile
@@ -414,7 +414,7 @@ BOLD := $(shell tput bold 2>/dev/null)
 GREEN := $(shell tput setaf 2 2>/dev/null)
 RESET := $(shell tput sgr0 2>/dev/null)
 
-fmt: fmt/ts fmt/go fmt/terraform fmt/shfmt fmt/prettier
+fmt: fmt/ts fmt/go fmt/terraform fmt/shfmt fmt/biome
 .PHONY: fmt
 
 fmt/go:
@@ -436,15 +436,16 @@ else
 endif
 .PHONY: fmt/ts
 
-fmt/prettier: .prettierignore
-	echo "$(GREEN)==>$(RESET) $(BOLD)fmt/prettier$(RESET)"
+fmt/biome:
+	echo "$(GREEN)==>$(RESET) $(BOLD)fmt/biome$(RESET)"
+	cd site
 # Avoid writing files in CI to reduce file write activity
 ifdef CI
 	pnpm run format:check
 else
 	pnpm run format
 endif
-.PHONY: fmt/prettier
+.PHONY: fmt/biome
 
 fmt/terraform: $(wildcard *.tf)
 	echo "$(GREEN)==>$(RESET) $(BOLD)fmt/terraform$(RESET)"
@@ -461,7 +462,7 @@ else
 endif
 .PHONY: fmt/shfmt
 
-lint: lint/shellcheck lint/go lint/ts lint/examples lint/helm lint/site-icons
+lint: lint/shellcheck lint/go lint/ts lint/examples lint/helm lint/site-icons lint/markdown
 .PHONY: lint
 
 lint/site-icons:
@@ -495,6 +496,12 @@ lint/helm:
 	make lint
 .PHONY: lint/helm
 
+lint/markdown:
+	cd site
+	../scripts/pnpm_install.sh
+	pnpm exec markdownlint-cli2 --fix ../docs/**/*.md
+.PHONY: lint/markdown
+
 # All files generated by the database should be added here, and this can be used
 # as a target for jobs that need to run after the database is generated.
 DB_GEN_FILES := \
@@ -530,8 +537,6 @@ gen: \
 	docs/reference/cli/index.md \
 	docs/admin/security/audit-logs.md \
 	coderd/apidoc/swagger.json \
-	.prettierignore.include \
-	.prettierignore \
 	provisioner/terraform/testdata/version \
 	site/e2e/provisionerGenerated.ts \
 	site/src/theme/icons.json \
@@ -560,8 +565,6 @@ gen/mark-fresh:
 		docs/reference/cli/index.md \
 		docs/admin/security/audit-logs.md \
 		coderd/apidoc/swagger.json \
-		.prettierignore.include \
-		.prettierignore \
 		site/e2e/provisionerGenerated.ts \
 		site/src/theme/icons.json \
 		examples/examples.gen.json \
@@ -650,11 +653,15 @@ site/e2e/provisionerGenerated.ts: provisionerd/proto/provisionerd.pb.go provisio
 
 site/src/theme/icons.json: $(wildcard scripts/gensite/*) $(wildcard site/static/icon/*)
 	go run ./scripts/gensite/ -icons "$@"
-	./scripts/pnpm_install.sh
-	pnpm -C site/ exec biome format --write src/theme/icons.json
+	cd site
+	../scripts/pnpm_install.sh
+	pnpm exec biome format --write src/theme/icons.json
 
 examples/examples.gen.json: scripts/examplegen/main.go examples/examples.go $(shell find ./examples/templates)
 	go run ./scripts/examplegen/main.go > examples/examples.gen.json
+	cd site
+	../scripts/pnpm_install.sh
+	pnpm exec biome format --write examples/examples.gen.json
 
 coderd/rbac/object_gen.go: scripts/typegen/rbacobject.gotmpl scripts/typegen/main.go coderd/rbac/object.go coderd/rbac/policy/policy.go
 	go run scripts/typegen/main.go rbac object > coderd/rbac/object_gen.go
@@ -673,23 +680,29 @@ site/src/api/countriesGenerated.ts: scripts/typegen/countries.tstmpl scripts/typ
 
 docs/admin/integrations/prometheus.md: scripts/metricsdocgen/main.go scripts/metricsdocgen/metrics
 	go run scripts/metricsdocgen/main.go
-	./scripts/pnpm_install.sh
-	pnpm exec prettier --write ./docs/admin/integrations/prometheus.md
+	cd site
+	../scripts/pnpm_install.sh
+	pnpm exec markdownlint-cli2 --write ../docs/admin/integrations/prometheus.md
 
 docs/reference/cli/index.md: scripts/clidocgen/main.go examples/examples.gen.json $(GO_SRC_FILES)
 	CI=true BASE_PATH="." go run ./scripts/clidocgen
-	./scripts/pnpm_install.sh
-	pnpm exec prettier --write ./docs/reference/cli/index.md ./docs/reference/cli/*.md ./docs/manifest.json
+	cd site
+	../scripts/pnpm_install.sh
+	pnpm exec markdownlint-cli2 --fix ../docs/reference/cli/index.md ../docs/reference/cli/*.md
+	pnpm exec biome format --write ../docs/manifest.json
 
 docs/admin/security/audit-logs.md: coderd/database/querier.go scripts/auditdocgen/main.go enterprise/audit/table.go coderd/rbac/object_gen.go
 	go run scripts/auditdocgen/main.go
-	./scripts/pnpm_install.sh
-	pnpm exec prettier --write ./docs/admin/security/audit-logs.md
+	cd site
+	../scripts/pnpm_install.sh
+	pnpm exec markdownlint-cli2 --fix ../docs/admin/security/audit-logs.md
 
 coderd/apidoc/swagger.json: $(shell find ./scripts/apidocgen $(FIND_EXCLUSIONS) -type f) $(wildcard coderd/*.go) $(wildcard enterprise/coderd/*.go) $(wildcard codersdk/*.go) $(wildcard enterprise/wsproxy/wsproxysdk/*.go) $(DB_GEN_FILES) .swaggo docs/manifest.json coderd/rbac/object_gen.go
 	./scripts/apidocgen/generate.sh
-	./scripts/pnpm_install.sh
-	pnpm exec prettier --write ./docs/reference/api ./docs/manifest.json ./coderd/apidoc/swagger.json
+	cd site
+	../scripts/pnpm_install.sh
+	pnpm exec markdownlint-cli2 --fix ../docs/reference/api
+	pnpm exec biome format --write ../docs/manifest.json ../coderd/apidoc/swagger.json
 
 update-golden-files: \
 	cli/testdata/.gen-golden \
@@ -750,15 +763,6 @@ scripts/ci-report/testdata/.gen-golden: $(wildcard scripts/ci-report/testdata/*)
 	go test ./scripts/ci-report -run=TestOutputMatchesGoldenFile -update
 	touch "$@"
 
-# Combine .gitignore with .prettierignore.include to generate .prettierignore.
-.prettierignore: .gitignore .prettierignore.include
-	echo "# Code generated by Makefile ($^). DO NOT EDIT." > "$@"
-	echo "" >> "$@"
-	for f in $^; do
-		echo "# $${f}:" >> "$@"
-		cat "$$f" >> "$@"
-	done
-
 test:
 	$(GIT_FLAGS) gotestsum --format standard-quiet -- -v -short -count=1 ./...
 .PHONY: test

diff --git a/coderd/prometheusmetrics/insights/testdata/insights-metrics.json b/coderd/prometheusmetrics/insights/testdata/insights-metrics.json
@@ -1,13 +1,13 @@
 {
-  "coderd_insights_applications_usage_seconds[application_name=JetBrains,slug=,template_name=golden-template]": 60,
-  "coderd_insights_applications_usage_seconds[application_name=Visual Studio Code,slug=,template_name=golden-template]": 60,
-  "coderd_insights_applications_usage_seconds[application_name=Web Terminal,slug=,template_name=golden-template]": 0,
-  "coderd_insights_applications_usage_seconds[application_name=SSH,slug=,template_name=golden-template]": 60,
-  "coderd_insights_applications_usage_seconds[application_name=Golden Slug,slug=golden-slug,template_name=golden-template]": 180,
-  "coderd_insights_parameters[parameter_name=first_parameter,parameter_type=string,parameter_value=Foobar,template_name=golden-template]": 1,
-  "coderd_insights_parameters[parameter_name=first_parameter,parameter_type=string,parameter_value=Baz,template_name=golden-template]": 1,
-  "coderd_insights_parameters[parameter_name=second_parameter,parameter_type=bool,parameter_value=true,template_name=golden-template]": 2,
-  "coderd_insights_parameters[parameter_name=third_parameter,parameter_type=number,parameter_value=789,template_name=golden-template]": 1,
-  "coderd_insights_parameters[parameter_name=third_parameter,parameter_type=number,parameter_value=999,template_name=golden-template]": 1,
-  "coderd_insights_templates_active_users[template_name=golden-template]": 1
+	"coderd_insights_applications_usage_seconds[application_name=JetBrains,slug=,template_name=golden-template]": 60,
+	"coderd_insights_applications_usage_seconds[application_name=Visual Studio Code,slug=,template_name=golden-template]": 60,
+	"coderd_insights_applications_usage_seconds[application_name=Web Terminal,slug=,template_name=golden-template]": 0,
+	"coderd_insights_applications_usage_seconds[application_name=SSH,slug=,template_name=golden-template]": 60,
+	"coderd_insights_applications_usage_seconds[application_name=Golden Slug,slug=golden-slug,template_name=golden-template]": 180,
+	"coderd_insights_parameters[parameter_name=first_parameter,parameter_type=string,parameter_value=Foobar,template_name=golden-template]": 1,
+	"coderd_insights_parameters[parameter_name=first_parameter,parameter_type=string,parameter_value=Baz,template_name=golden-template]": 1,
+	"coderd_insights_parameters[parameter_name=second_parameter,parameter_type=bool,parameter_value=true,template_name=golden-template]": 2,
+	"coderd_insights_parameters[parameter_name=third_parameter,parameter_type=number,parameter_value=789,template_name=golden-template]": 1,
+	"coderd_insights_parameters[parameter_name=third_parameter,parameter_type=number,parameter_value=999,template_name=golden-template]": 1,
+	"coderd_insights_templates_active_users[template_name=golden-template]": 1
 }
diff --git a/coderd/prometheusmetrics/testdata/agent-stats.json b/coderd/prometheusmetrics/testdata/agent-stats.json
@@ -1,26 +1,26 @@
 {
-  "testuser:workspace-1:example:coderd_agentstats_connection_count": 9,
-  "testuser:workspace-1:example:coderd_agentstats_connection_median_latency_seconds": 8,
-  "testuser:workspace-1:example:coderd_agentstats_rx_bytes": 9,
-  "testuser:workspace-1:example:coderd_agentstats_session_count_jetbrains": 6,
-  "testuser:workspace-1:example:coderd_agentstats_session_count_reconnecting_pty": 7,
-  "testuser:workspace-1:example:coderd_agentstats_session_count_ssh": 8,
-  "testuser:workspace-1:example:coderd_agentstats_session_count_vscode": 5,
-  "testuser:workspace-1:example:coderd_agentstats_tx_bytes": 6,
-  "testuser:workspace-2:example:coderd_agentstats_connection_count": 10,
-  "testuser:workspace-2:example:coderd_agentstats_connection_median_latency_seconds": 10,
-  "testuser:workspace-2:example:coderd_agentstats_rx_bytes": 15,
-  "testuser:workspace-2:example:coderd_agentstats_session_count_jetbrains": 10,
-  "testuser:workspace-2:example:coderd_agentstats_session_count_reconnecting_pty": 12,
-  "testuser:workspace-2:example:coderd_agentstats_session_count_ssh": 14,
-  "testuser:workspace-2:example:coderd_agentstats_session_count_vscode": 8,
-  "testuser:workspace-2:example:coderd_agentstats_tx_bytes": 9,
-  "testuser:workspace-3:example:coderd_agentstats_connection_count": 11,
-  "testuser:workspace-3:example:coderd_agentstats_connection_median_latency_seconds": 12,
-  "testuser:workspace-3:example:coderd_agentstats_rx_bytes": 21,
-  "testuser:workspace-3:example:coderd_agentstats_session_count_jetbrains": 16,
-  "testuser:workspace-3:example:coderd_agentstats_session_count_reconnecting_pty": 18,
-  "testuser:workspace-3:example:coderd_agentstats_session_count_ssh": 20,
-  "testuser:workspace-3:example:coderd_agentstats_session_count_vscode": 14,
-  "testuser:workspace-3:example:coderd_agentstats_tx_bytes": 12
+	"testuser:workspace-1:example:coderd_agentstats_connection_count": 9,
+	"testuser:workspace-1:example:coderd_agentstats_connection_median_latency_seconds": 8,
+	"testuser:workspace-1:example:coderd_agentstats_rx_bytes": 9,
+	"testuser:workspace-1:example:coderd_agentstats_session_count_jetbrains": 6,
+	"testuser:workspace-1:example:coderd_agentstats_session_count_reconnecting_pty": 7,
+	"testuser:workspace-1:example:coderd_agentstats_session_count_ssh": 8,
+	"testuser:workspace-1:example:coderd_agentstats_session_count_vscode": 5,
+	"testuser:workspace-1:example:coderd_agentstats_tx_bytes": 6,
+	"testuser:workspace-2:example:coderd_agentstats_connection_count": 10,
+	"testuser:workspace-2:example:coderd_agentstats_connection_median_latency_seconds": 10,
+	"testuser:workspace-2:example:coderd_agentstats_rx_bytes": 15,
+	"testuser:workspace-2:example:coderd_agentstats_session_count_jetbrains": 10,
+	"testuser:workspace-2:example:coderd_agentstats_session_count_reconnecting_pty": 12,
+	"testuser:workspace-2:example:coderd_agentstats_session_count_ssh": 14,
+	"testuser:workspace-2:example:coderd_agentstats_session_count_vscode": 8,
+	"testuser:workspace-2:example:coderd_agentstats_tx_bytes": 9,
+	"testuser:workspace-3:example:coderd_agentstats_connection_count": 11,
+	"testuser:workspace-3:example:coderd_agentstats_connection_median_latency_seconds": 12,
+	"testuser:workspace-3:example:coderd_agentstats_rx_bytes": 21,
+	"testuser:workspace-3:example:coderd_agentstats_session_count_jetbrains": 16,
+	"testuser:workspace-3:example:coderd_agentstats_session_count_reconnecting_pty": 18,
+	"testuser:workspace-3:example:coderd_agentstats_session_count_ssh": 20,
+	"testuser:workspace-3:example:coderd_agentstats_session_count_vscode": 14,
+	"testuser:workspace-3:example:coderd_agentstats_tx_bytes": 12
 }
diff --git a/docs/changelogs/v2.1.1.md b/docs/changelogs/v2.1.1.md
@@ -7,7 +7,7 @@
   ![Last used](https://user-images.githubusercontent.com/22407953/262407146-06cded4e-684e-4cff-86b7-4388270e7d03.png)
   > You can use `last_used_before` and `last_used_after` in the workspaces
   > search with [RFC3339Nano](https://www.rfc-editor.org/rfc/rfc3339) datetime
-- Add `daily_cost`` to `coder ls` to show
+- Add `daily_cost`` to`coder ls` to show
   [quota](https://coder.com/docs/admin/quotas) consumption (#9200)
   (@ammario)
 - Added `coder_app` usage to template insights (#9138) (@mafredri)

diff --git a/docs/changelogs/v2.1.5.md b/docs/changelogs/v2.1.5.md
@@ -17,11 +17,13 @@
   [display apps](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#nested-schema-for-display_apps)
   in your template, such as VS Code (Insiders), web terminal, SSH, etc. (#9100)
   (@sreya) To add VS Code insiders into your template, you can set:
+
   ```tf
   display_apps {
     vscode_insiders = true
   }
   ```
+
   ![Add insiders](https://user-images.githubusercontent.com/4856196/263852602-94a5cb56-b7c3-48cb-928a-3b5e0f4e964b.png)
 - Create a workspace from any template version (#9471) (@aslilac)
 - Add DataDog Go tracer (#9411) (@ammario)

diff --git a/docs/changelogs/v2.5.0.md b/docs/changelogs/v2.5.0.md
@@ -92,7 +92,7 @@
 ### Documentation
 
 - Align CODER_HTTP_ADDRESS with document (#10779) (@JounQin)
-- Migrate all deprecated `CODER_ADDRESS `to `CODER_HTTP_ADDRESS` (#10780) (@JounQin)
+- Migrate all deprecated `CODER_ADDRESS`to `CODER_HTTP_ADDRESS` (#10780) (@JounQin)
 - Add documentation for template update policies (experimental) (#10804) (@sreya)
 - Fix typo in additional-clusters.md (#10868) (@bpmct)
 - Update FE guide (#10942) (@BrunoQuaresma)