Add prettier for basic formatting lints compatible with .editorconfig

Author: bbrks

.editorconfig

@@ -5,10 +5,8 @@ root = true
 [*]
 charset = utf-8
 end_of_line = lf
-# insert_final_newline = true
-# trim_trailing_whitespace = true
+insert_final_newline = true
+trim_trailing_whitespace = true
 
 [manifest/**.{json,xml}]
 indent_size = 4
-insert_final_newline = true
-trim_trailing_whitespace = true

.github/workflows/prettier.yml

@@ -0,0 +1,62 @@
+name: prettier
+permissions:
+  contents: read
+  pull-requests: write
+
+on:
+  push:
+    branches:
+      - 'master'
+      - 'main'
+      - 'release/*'
+      - 'feature/*'
+      - 'CBG*'
+      - 'ci-*'
+  pull_request:
+    branches:
+      - 'master'
+      - 'main'
+      - 'release/*'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: ${{ !contains(github.ref, 'release/')}}
+
+
+jobs:
+  prettier:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Prettier validation
+        uses: creyD/[email protected]
+        with:
+          dry: True
+      - name: Find Comment
+        if: failure() && github.event_name == 'pull_request'
+        uses: peter-evans/find-comment@v3
+        id: fc
+        with:
+          issue-number: ${{ github.event.pull_request.number }}
+          comment-author: 'github-actions[bot]'
+          body-includes: Prettier Formatting Validation
+      - name: Create or update comment
+        if: failure() && github.event_name == 'pull_request'
+        uses: peter-evans/create-or-update-comment@v4
+        with:
+          comment-id: ${{ steps.fc.outputs.comment-id }}
+          issue-number: ${{ github.event.pull_request.number }}
+          edit-mode: replace
+          body: |
+            ## Prettier Formatting Validation
+
+            The Prettier formatting check has identified files that do not conform to the project's coding style guidelines.
+
+            To automatically format locally, run:
+
+            ```sh
+            npm install
+            prettier --write .
+            ```

.gitignore

@@ -1,6 +1,5 @@
 *.idea
 *.sublime-workspace
-*.walrus
 **/git_info.go.bak
 \#*
 *~
@@ -10,14 +9,19 @@
 /pkg
 *.exe
 *.iml
+__pycache__
+node_modules/
+
+*.pb.gz
+*.walrus
+
 sg_config.json
 coverage*.out
 coverage*.xml
 verbose*.out*
 verbose*.xml
+
 sync_gateway
-*.pb.gz
-__pycache__
 tools/cache_perf_tool/cache_perf_tool
 cache_perf_tool
 tools/stats-definition-exporter/stats-definition-exporter

.prettierignore

@@ -0,0 +1,8 @@
+# prettier barfs on `<?xml` in these files for some reason
+*.wxs
+
+# The `db/functions/*.js` file is not strictly valid JS syntax - depends on Go embed and variable substitution to become valid
+*.fmt.js
+
+go.mod
+go.sum

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "trailingComma": "es5",
+  "singleQuote": true,
+  "plugins": ["@prettier/plugin-xml"]
+}

db/functions/js_runner.go

@@ -35,15 +35,17 @@ const kUserFunctionCacheSize = 2
 // Maximum nesting of JS user function calls (not the JS stack depth)
 var kUserFunctionMaxCallDepth = 20
 
-// The outermost JavaScript code. Evaluating it returns a function, which is then called by the
-// Runner every time it's invoked. Contains `%s` where the actual function source code goes.
+// kJavaScriptWrapperFormatString is the format string containing the outermost JavaScript code.
+// Evaluating it returns a function, which is then called by the runner every time it's invoked.
 //
-//go:embed js_wrapper.js
-var kJavaScriptWrapper string
+// Contains `%s` where the actual function source code goes.
+//
+//go:embed js_wrapper.fmt.js
+var kJavaScriptWrapperFormatString string
 
 // Creates a JSServer instance wrapping a userJSRunner, for user JS functions.
 func newFunctionJSServer(ctx context.Context, name string, what string, sourceCode string) (*sgbucket.JSServer, error) {
-	js := fmt.Sprintf(kJavaScriptWrapper, sourceCode)
+	js := fmt.Sprintf(kJavaScriptWrapperFormatString, sourceCode)
 	jsServer := sgbucket.NewJSServer(ctx, js, 0, kUserFunctionCacheSize,
 		func(ctx context.Context, fnSource string, timeout time.Duration) (sgbucket.JSServerTask, error) {
 			return newJSRunner(ctx, name, what, fnSource)

db/functions/js_wrapper.js db/functions/js_wrapper.fmt.jsdb/functions/js_wrapper.js renamed to db/functions/js_wrapper.fmt.js

@@ -0,0 +1,7 @@
+{
+  "devDependencies": {
+    "@prettier/plugin-xml": "^3.4.2",
+    "@redocly/cli": "^2.2.3",
+    "prettier": "3.6.2"
+  }
+}

package.json

@@ -1,6 +1,7 @@
-<?xml version=1.0 encoding=UTF-8?>
-<!DOCTYPE plist PUBLIC -//Apple//DTD PLIST 1.0//EN http://www.apple.com/DTDs/PropertyList-1.0.dtd>
-<plist version=1.0>
+<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN"
+  "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
 <dict>
         <key>Label</key>
         <string>com.couchbase.mobile.sync_gateway</string>
@@ -16,6 +17,6 @@
             <string>${CONFIG_TEMPLATE_VAR}</string>
         </array>
         <key>KeepAlive</key>
-        <true/>
+        <true />
 </dict>
 </plist>