Merge pull request #1178 from posit-dev/dotnomad/vscode-prettier

Format VSCode extension code with Prettier
posit-dev · Mar 21, 2024 · b1848ee · b1848ee
2 parents c8bc040 + c445189
commit b1848ee
Show file tree

Hide file tree

Showing 6 changed files with 56 additions and 3 deletions.
diff --git a/.github/workflows/vscode.yaml b/.github/workflows/vscode.yaml
@@ -30,6 +30,7 @@ jobs:
           key: ${{ matrix.runner }}-vscode-${{ env.VSCODE_VERSION }}-${{ steps.get-date.outputs.date }}
       - run: just vscode configure
       - run: just vscode lint
+      - run: just vscode check-format
       - run: just vscode test
       - uses: actions/cache/save@v3
         if: steps.cache.outputs.cache-hit != 'true'
@@ -53,6 +54,7 @@ jobs:
           key: docker-vscode-${{ env.VSCODE_VERSION }}-${{ steps.get-date.outputs.date }}
       - run: just vscode configure
       - run: just vscode lint
+      - run: just vscode check-format
       - run: just vscode test
       - uses: actions/cache/save@v3
         if: steps.cache.outputs.cache-hit != 'true'

diff --git a/extensions/vscode/.eslintrc.json b/extensions/vscode/.eslintrc.json
@@ -8,6 +8,9 @@
   "plugins": [
     "@typescript-eslint"
   ],
+  "extends": [
+    "prettier"
+  ],
   "rules": {
     "@typescript-eslint/naming-convention": "warn",
     "@typescript-eslint/semi": "warn",
@@ -22,4 +25,4 @@
     "**/*.d.ts",
     "api"
   ]
-}
+}
diff --git a/extensions/vscode/.prettierrc b/extensions/vscode/.prettierrc
@@ -0,0 +1 @@
+{}
diff --git a/extensions/vscode/justfile b/extensions/vscode/justfile
@@ -104,6 +104,20 @@ lint:
 
     npm run lint
 
+format:
+    #!/usr/bin/env bash
+    set -eou pipefail
+    {{ _with_debug }}
+
+    npm run format
+
+check-format:
+    #!/usr/bin/env bash
+    set -eou pipefail
+    {{ _with_debug }}
+
+    npm run check-format
+
 # Packages the extension.
 package os="$(just ../../os)" arch="$(just ../../arch)":
     #!/usr/bin/env bash

diff --git a/extensions/vscode/package-lock.json b/extensions/vscode/package-lock.json
diff --git a/extensions/vscode/package.json b/extensions/vscode/package.json
@@ -246,7 +246,7 @@
           "when": "viewItem == posit.publisher.deployments.tree.item.deployment",
           "group": "inline"
         },
-          {
+        {
           "command": "posit.publisher.files.addExclusion",
           "when": "viewItem == posit.publisher.files.isIncludedFile",
           "group": "inline"
@@ -444,6 +444,8 @@
     "watch": "tsc -watch -p ./",
     "pretest": "npm run compile",
     "lint": "eslint src --ext ts",
+    "format": "prettier . --write",
+    "check-format": "prettier . --check",
     "test": "node ./out/test/runTest.js"
   },
   "devDependencies": {
@@ -458,8 +460,10 @@
     "@typescript-eslint/parser": "^6.7.3",
     "@vscode/test-electron": "^2.3.8",
     "eslint": "^8.50.0",
+    "eslint-config-prettier": "^9.1.0",
     "glob": "^10.3.3",
     "mocha": "^10.2.0",
+    "prettier": "3.2.5",
     "typescript": "^5.2.2"
   },
   "dependencies": {
@@ -469,4 +473,4 @@
     "mutexify": "^1.4.0",
     "retry": "^0.13.1"
   }
-}
+}