Merge branch 'main' into scala_update

Author: scholarsmate

.github/workflows/ratCheck.yml

@@ -30,7 +30,7 @@ jobs:
 
     steps:
       - name: Setup Java ☕
-        uses: actions/setup-java@v4.4.0
+        uses: actions/setup-java@v4.5.0
         with:
           distribution: temurin
           java-version: 8

.github/workflows/release.yml

@@ -190,7 +190,7 @@ jobs:
           echo "UPLOAD_URL=$UPLOAD_URL" >> $GITHUB_ENV
 
       - name: Setup Java ☕
-        uses: actions/setup-java@v4.4.0
+        uses: actions/setup-java@v4.5.0
         with:
           distribution: temurin
           java-version: 8
@@ -200,7 +200,7 @@ jobs:
         run: mkdir -p _install
 
       - name: Download linux x86 library file 🔻
-        uses: dawidd6/action-download-artifact@v3
+        uses: dawidd6/action-download-artifact@v6
         with:
           workflow: tests.yml
           branch: main
@@ -209,7 +209,7 @@ jobs:
           path: _install/libomega_edit_linux_amd64.so
 
       - name: Download linux arm64 library file 🔻
-        uses: dawidd6/action-download-artifact@v3
+        uses: dawidd6/action-download-artifact@v6
         with:
           workflow: tests.yml
           branch: main
@@ -218,7 +218,7 @@ jobs:
           path: _install/libomega_edit_linux_aarch64.so
 
       - name: Download macos-12 library file 🔻
-        uses: dawidd6/action-download-artifact@v3
+        uses: dawidd6/action-download-artifact@v6
         with:
           workflow: tests.yml
           branch: main
@@ -227,7 +227,7 @@ jobs:
           path: _install/libomega_edit_macos_aarch64.dylib
 
       - name: Download macos-14 library file 🔻
-        uses: dawidd6/action-download-artifact@v3
+        uses: dawidd6/action-download-artifact@v6
         with:
           workflow: tests.yml
           branch: main
@@ -236,7 +236,7 @@ jobs:
           path: _install/libomega_edit_macos_x86_64.dylib
 
       - name: Download windows library file 🔻
-        uses: dawidd6/action-download-artifact@v3
+        uses: dawidd6/action-download-artifact@v6
         with:
           workflow: tests.yml
           branch: main

CMakeLists.txt

@@ -13,7 +13,7 @@ cmake_minimum_required(VERSION 3.13)
 
 # Project information
 project(omega_edit
-        VERSION 0.9.82
+        VERSION 0.9.83
         DESCRIPTION "Apache open source library for building editors"
         HOMEPAGE_URL "https://github.com/ctc-oss/omega-edit"
         LANGUAGES C CXX)

Makefile

@@ -34,9 +34,22 @@ lib/$(LIBNAME): CMakeLists.txt core/CMakeLists.txt
 	cp _install/lib/$(LIBNAME) $@
 
 update-version:
-	sed -i '' -e 's|"version": .*|"version": "$(version)",|' package.json packages/server/package.json packages/client/package.json
-	sed -i '' -e 's|"\@omega-edit\/server": .*|"\@omega-edit\/server": "$(version)",|' packages/client/package.json
-	sed -i '' -e '/project(omega_edit/{N;s|.* VERSION .*|project(omega_edit\n        VERSION $(version)|;}' CMakeLists.txt
+  # Make sure version is set for this target
+	@if [ -z "$(version)" ]; then \
+		echo "version is not set, please run \`make update-version version=1.2.3\` where 1.2.3 is the new version"; \
+		exit 1; \
+	fi
+	@sed -i '' -e 's|"version": .*|"version": "$(version)",|' package.json packages/server/package.json packages/client/package.json
+	@sed -i '' -e 's|"\@omega-edit\/server": .*|"\@omega-edit\/server": "$(version)",|' packages/client/package.json
+	@sed -i '' -e '/project(omega_edit/{N;s|.* VERSION .*|project(omega_edit\n        VERSION $(version)|;}' CMakeLists.txt
+	@echo "------------------------------------------------------------------------"
+	@echo "Updated version to v$(version), next steps:"
+	@echo "  git commit -am \"v$(version) [node_publish]\""
+	@echo "  git push origin main"
+	@echo "Wait for CI to pass, then tag the release to publish the artifacts:"
+	@echo "  git tag -a v$(version) -m \"v$(version)\""
+	@echo "  git push origin v$(version)"
+	@echo "------------------------------------------------------------------------"
 
 clean:
 	rm -rf _build _install lib/$(LIBNAME)
@@ -45,3 +58,4 @@ all: lib/$(LIBNAME)
 	@echo $<
 
 .default: all
+.phony: all clean update-version

core/CMakeLists.txt

@@ -79,7 +79,7 @@ if (BUILD_TESTS)
             Catch2
             GIT_SHALLOW TRUE
             GIT_REPOSITORY https://github.com/catchorg/Catch2.git
-            GIT_TAG v3.5.4
+            GIT_TAG v3.7.0
     )
     FetchContent_MakeAvailable(Catch2)
     list(APPEND CMAKE_MODULE_PATH "${Catch2_SOURCE_DIR}/extras")

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@omega-edit/core",
-  "version": "0.9.82",
+  "version": "0.9.83",
   "private": "true",
   "description": "OmegaEdit Client and Server",
   "publisher": "CTC-OSS",
@@ -24,18 +24,18 @@
   },
   "devDependencies": {
     "@types/chai": "^4.3.12",
-    "@types/mocha": "^10.0.6",
-    "@types/node": "^20.12.11",
+    "@types/mocha": "^10.0.9",
+    "@types/node": "^22.8.1",
     "chai": "^4.3.10",
     "copy-webpack-plugin": "^11.0.0",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-prettier": "^5.1.3",
-    "mocha": "^10.4.0",
-    "prettier": "^3.2.5",
+    "eslint-plugin-prettier": "^5.2.1",
+    "mocha": "^10.7.3",
+    "prettier": "^3.3.3",
     "run-script-os": "^1.1.6",
     "ts-loader": "^9.5.1",
-    "typedoc": "^0.25.13",
+    "typedoc": "^0.26.10",
     "typescript": "^5.4.5",
     "unzip-stream": "^0.3.4",
     "webpack": "^5.95.0",

packages/client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@omega-edit/client",
-  "version": "0.9.82",
+  "version": "0.9.83",
   "description": "OmegaEdit gRPC Client",
   "publisher": "ctc-oss",
   "main": "./main.js",
@@ -44,7 +44,7 @@
   },
   "dependencies": {
     "@grpc/grpc-js": "1.12.2",
-    "@omega-edit/server": "0.9.82",
+    "@omega-edit/server": "0.9.83",
     "@types/google-protobuf": "3.15.12",
     "google-protobuf": "3.21.4",
     "pid-port": "1.0.0",

packages/server/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@omega-edit/server",
-  "version": "0.9.82",
+  "version": "0.9.83",
   "description": "OmegaEdit gRPC Server",
   "publisher": "ctc-oss",
   "main": "./out/index.js",

packages/server/src/index.ts

@@ -37,7 +37,7 @@ import * as path from 'path'
  *    OR
  *    - calls the getBinFolderPath going back a directory
  */
-const checkForBinPath = (baseDir: string) => {
+const checkForBinPath = (baseDir: string): string => {
   const serverbasePath = 'node_modules/@omega-edit/server'
 
   // These two are checked as when testing locally it will want to use out/bin
@@ -46,26 +46,28 @@ const checkForBinPath = (baseDir: string) => {
     path.join(baseDir, serverbasePath, 'out', 'bin'),
   ]
 
-  for (let i = 0; i < pathsToCheck.length; i++) {
-    if (fs.existsSync(pathsToCheck[i])) return path.resolve(pathsToCheck[i])
+  for (const p of pathsToCheck) {
+    if (fs.existsSync(p)) return path.resolve(p)
   }
 
   return getBinFolderPath(path.join(baseDir, '..'))
 }
 
 /**
- *
+ * Recursively finds the bin folder path
  * @param baseDir the base path to the directory to check against
  * @returns
  *    - path to bin directory
  *    OR
  *    - recursively calls itself till path is found
  */
-const getBinFolderPath = (baseDir: string) => {
+const getBinFolderPath = (baseDir: string): string => {
   if (!baseDir.endsWith('node_modules')) {
-    if (fs.readdirSync(baseDir).includes('node_modules'))
+    if (fs.readdirSync(baseDir).includes('node_modules')) {
       return checkForBinPath(baseDir)
-    else return getBinFolderPath(path.join(baseDir, '..'))
+    } else {
+      return getBinFolderPath(path.join(baseDir, '..'))
+    }
   } else {
     return checkForBinPath(baseDir.replace('node_modules', ''))
   }
@@ -74,7 +76,7 @@ const getBinFolderPath = (baseDir: string) => {
 /**
  * Execute the server
  * @param args arguments to pass to the server
- * @returns {ChildProcess} server process
+ * @returns {Promise<ChildProcess>} server process
  */
 async function executeServer(args: string[]): Promise<ChildProcess> {
   const serverScript = path.join(
@@ -88,9 +90,10 @@ async function executeServer(args: string[]): Promise<ChildProcess> {
 
   const serverProcess: ChildProcess = spawn(serverScript, args, {
     cwd: path.dirname(serverScript),
-    stdio: 'ignore',
     detached: true,
     shell: os.platform().startsWith('win'), // use shell on Windows because it can't execute scripts directly
+    stdio: ['ignore', 'ignore', 'ignore'],
+    windowsHide: true, // avoid showing a console window
   })
 
   serverProcess.on('error', (err: Error) => {
@@ -107,7 +110,7 @@ async function executeServer(args: string[]): Promise<ChildProcess> {
  * @param host hostname or IP address (default: 127.0.0.1)
  * @param pidfile resolved path to the PID file
  * @param logConf resolved path to a logback configuration file
- * @returns {ChildProcess} server process
+ * @returns {Promise<ChildProcess>} server process
  */
 export async function runServer(
   port: number,