Setup formatting check task

andyleejordan · andyleejordan · commit ea1b203deb74 · 2025-05-16T09:56:30.000-07:00
Specificially not using Prettier for Markdown.
diff --git a/package.json b/package.json
@@ -104,6 +104,7 @@
     "compile": "esbuild ./src/extension.ts --outdir=dist --sourcemap --bundle --external:vscode --platform=node",
     "watch": "npm run compile -- --watch",
     "lint": "eslint src test --ext .ts",
+    "format": "prettier --check '**/*.{ts,json,yml,mjs,code-workspace}'",
     "package": "vsce package --out out/ --no-gitHubIssueLinking",
     "publish": "vsce publish",
     "pretest": "npm run compile",
diff --git a/pwsh-extension-dev.code-workspace b/pwsh-extension-dev.code-workspace
@@ -24,14 +24,15 @@
   "settings": {
     "window.title": "PowerShell VS Code Extension Development",
     "debug.onTaskErrors": "prompt",
+    "editor.formatOnSave": true,
+    "editor.formatOnSaveMode": "modifications",
+    "editor.formatOnPaste": true,
     "editor.codeActionsOnSave": {
       "source.fixAll": "explicit",
     },
-    "[typescript][javascript][json]": {
+    "[typescript][javascript][json][jsonc]": {
       "editor.defaultFormatter": "esbenp.prettier-vscode",
-      "editor.formatOnPaste": true,
-      "editor.formatOnSave": true,
-      "editor.formatOnSaveMode": "modificationsIfAvailable",
+      "editor.formatOnSaveMode": "file",
     },
     "files.associations": {
       "**/snippets/*.json": "jsonc", // Use JSONC instead of JSON because that's how VS Code interprets snippet files, and it enables better source documentation.
diff --git a/vscode-powershell.build.ps1 b/vscode-powershell.build.ps1
@@ -86,6 +86,8 @@ task CleanEditorServices -If (Get-EditorServicesPath) {
 task Lint RestoreNodeOptional, {
     Write-Build DarkMagenta "Linting TypeScript"
     Invoke-BuildExec { & npm run lint }
+    Write-Build DarkMagenta "Checking formatting of TypeScript, JSON, etc."
+    Invoke-BuildExec { & npm run format }
 }
 
 task Build RestoreEditorServices, RestoreNode, {

Original file line number	Diff line number	Diff line change
`@@ -86,6 +86,8 @@ task CleanEditorServices -If (Get-EditorServicesPath) {`
`86`	`86`	`task Lint RestoreNodeOptional, {`
`87`	`87`	`Write-Build DarkMagenta "Linting TypeScript"`
`88`	`88`	`Invoke-BuildExec { & npm run lint }`
	`89`	`+ Write-Build DarkMagenta "Checking formatting of TypeScript, JSON, etc."`
	`90`	`+ Invoke-BuildExec { & npm run format }`
`89`	`91`	`}`
`90`	`92`
`91`	`93`	`task Build RestoreEditorServices, RestoreNode, {`