From 786f3e8d406f6e2d026eebd04117f9855d8a5fbb Mon Sep 17 00:00:00 2001 From: Panagiotis Papadopoulos Date: Thu, 13 Feb 2025 22:51:51 +0100 Subject: [PATCH] chore(scripts): namespace server:start --- .gitpod.yml | 2 +- README-ZH_CN.md | 2 +- README.es.md | 2 +- README.it.md | 2 +- README.ja.md | 2 +- README.md | 2 +- README.ru.md | 2 +- docs/X4N03xLYEWnN.html | 4 ++-- docs/XxqZW6JjkW2g.html | 2 +- docs/backend_api/index.html | 2 +- docs/backend_api/media/README-ZH_CN.md | 2 +- docs/backend_api/media/README.es.md | 2 +- docs/backend_api/media/README.it.md | 2 +- docs/backend_api/media/README.ja.md | 2 +- docs/backend_api/media/README.md | 2 +- docs/backend_api/media/README.ru.md | 2 +- docs/btM6L9JtG301.html | 2 +- package.json | 4 ++-- 18 files changed, 20 insertions(+), 20 deletions(-) diff --git a/.gitpod.yml b/.gitpod.yml index 2b77be7b7..f87a115d0 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -4,7 +4,7 @@ image: tasks: - before: nvm install 20.15.1 && nvm use 20.15.1 init: npm install - command: npm run start-server + command: npm run server:start ports: - port: 8080 diff --git a/README-ZH_CN.md b/README-ZH_CN.md index f6aa860b1..1f6bbaf55 100644 --- a/README-ZH_CN.md +++ b/README-ZH_CN.md @@ -78,7 +78,7 @@ Trilium 也提供 Flatpak： ```shell npm install -npm run start-server +npm run server:start ``` ## 👏 致谢 diff --git a/README.es.md b/README.es.md index a2ea94144..bfa57fe45 100644 --- a/README.es.md +++ b/README.es.md @@ -86,7 +86,7 @@ Clone localmente y ejecute ```shell npm install -npm run start-server +npm run server:start ``` ## 👏 Reconocimientos diff --git a/README.it.md b/README.it.md index a778230c7..750027c1a 100644 --- a/README.it.md +++ b/README.it.md @@ -73,7 +73,7 @@ Clona localmente ed esegui ```shell npm install -npm run start-server +npm run server:start ``` ## 👏 Riconoscimenti diff --git a/README.ja.md b/README.ja.md index 110b779c5..757638770 100644 --- a/README.ja.md +++ b/README.ja.md @@ -54,7 +54,7 @@ Trilium は Flatpak としても提供されます： ```shell npm install -npm run start-server +npm run server:start ``` ## 📢 シャウトアウト diff --git a/README.md b/README.md index e2a81aa4c..0170c8135 100644 --- a/README.md +++ b/README.md @@ -102,7 +102,7 @@ You can also read [Patterns of personal knowledge base](https://triliumnext.gith git clone https://github.com/TriliumNext/Notes.git cd Notes npm install -npm run start-server +npm run server:start ``` ### Documentation diff --git a/README.ru.md b/README.ru.md index d78738915..e2336efb3 100644 --- a/README.ru.md +++ b/README.ru.md @@ -44,7 +44,7 @@ Trilium предоставляется в виде десктопного при ```shell npm install -npm run start-server +npm run server:start ``` ## 👏 Благодарности diff --git a/docs/X4N03xLYEWnN.html b/docs/X4N03xLYEWnN.html index 2b686480d..9e9bcfef6 100644 --- a/docs/X4N03xLYEWnN.html +++ b/docs/X4N03xLYEWnN.html @@ -38,12 +38,12 @@
-

The native node bindings

better-sqlite3 has native Node bindings. With updates of better-sqlite3, but also of Electron and Node.js versions, these bindings need to be updated.

Note that Electron and Node.js versions need different versions of these bindings, since Electron usually packs a different version of Node.js.

During development, npm install tries to build or reuse prebuilt natives for the current Node.js version. This makes npm run start-server work out of the box. Trying to run npm run start-electron with these versions generally causes an error such as this:

Uncaught Exception:
+                
The native node bindings
better-sqlite3 has native Node bindings. With updates of better-sqlite3, but also of Electron and Node.js versions, these bindings need to be updated.
Note that Electron and Node.js versions need different versions of these bindings, since Electron usually packs a different version of Node.js.
During development, npm install tries to build or reuse prebuilt natives for the current Node.js version. This makes npm run server:start work out of the box. Trying to run npm run start-electron with these versions generally causes an error such as this:
Uncaught Exception:
 Error: The module '/Users/elian/Projects/Notes/node_modules/better-sqlite3/build/Release/better_sqlite3.node'
 was compiled against a different Node.js version using
 NODE_MODULE_VERSION 108. This version of Node.js requires
 NODE_MODULE_VERSION 116. Please try re-compiling or re-installing
-the module (for instance, using `npm rebuild` or `npm install`).
How the natives are handled
Locally, this can be fixed by rebuilding the binaries, which is what npm run switch-electron does, which uses electron-rebuild under the hood.
When the deliveries are built (see Build deliveries locally), it is not feasible to rebuild the dependencies since we are building for multiple platforms. Luckily, better-sqlite3 provides these prebuilt binaries from us, available as artifacts on their GitHub releases page. 
The build script manages the natives for better-sqlite3 by keeping a copy of the .node file for every platform in bin/better-sqlite3.
Whenever the version of better-sqlite3 changes, the .node files must also be renewed based on their releases page. To simplify this process, a script was created in bin/better-sqlite3/update.sh.
How to update the natives
The update script needs to know the version of Electron or Node.js for which to download the prebuilt binaries.
If you get errors during download, check on the releases page to ensure that this particular combination of Electron/Node actually exists for the given release.
To determine the NODE_MODULE_VERSION that is required, look for This version of Node.js requires
NODE_MODULE_VERSION in the error when starting Trilium via:
  • npm run start-electron (or run any Electron delivery), case in which the ELECTRON_VERSION variable needs to be changed.
  • npm run start-server (or run the Linux server delivery), case in which the NODE_VERSION variable needs to be changed.
Check which files got changed after running the update script and for each platform that got changed, test it locally via Build deliveries locally or via the CI.

+the module (for instance, using `npm rebuild` or `npm install`).

How the natives are handled

Locally, this can be fixed by rebuilding the binaries, which is what npm run switch-electron does, which uses electron-rebuild under the hood.

When the deliveries are built (see Build deliveries locally), it is not feasible to rebuild the dependencies since we are building for multiple platforms. Luckily, better-sqlite3 provides these prebuilt binaries from us, available as artifacts on their GitHub releases page. 

The build script manages the natives for better-sqlite3 by keeping a copy of the .node file for every platform in bin/better-sqlite3.

Whenever the version of better-sqlite3 changes, the .node files must also be renewed based on their releases page. To simplify this process, a script was created in bin/better-sqlite3/update.sh.

How to update the natives

The update script needs to know the version of Electron or Node.js for which to download the prebuilt binaries.

If you get errors during download, check on the releases page to ensure that this particular combination of Electron/Node actually exists for the given release.

To determine the NODE_MODULE_VERSION that is required, look for This version of Node.js requires
NODE_MODULE_VERSION in the error when starting Trilium via:

Check which files got changed after running the update script and for each platform that got changed, test it locally via Build deliveries locally or via the CI.

diff --git a/docs/XxqZW6JjkW2g.html b/docs/XxqZW6JjkW2g.html index 3307c8c4f..666d8ae9f 100644 --- a/docs/XxqZW6JjkW2g.html +++ b/docs/XxqZW6JjkW2g.html @@ -38,7 +38,7 @@
-

Server live reload

If running the server using npm run start-server, the server will watch for changes in src/public and trigger a frontend reload if that occurs.

Electron live reload

Similarly, npm run start-electron supports live refresh  as well.

However, a core difference is that Electron watches dist/src/public instead of src/public since Electron runs on its own copy of the files.

To ameliorate that, a separate watch script has been implemented which automatically copies files from src/public to dist/src/public whenever a change is detected. To run it:

npm run

Technical details

+

Server live reload

If running the server using npm run server:start, the server will watch for changes in src/public and trigger a frontend reload if that occurs.

Electron live reload

Similarly, npm run start-electron supports live refresh  as well.

However, a core difference is that Electron watches dist/src/public instead of src/public since Electron runs on its own copy of the files.

To ameliorate that, a separate watch script has been implemented which automatically copies files from src/public to dist/src/public whenever a change is detected. To run it:

npm run

Technical details

diff --git a/docs/backend_api/index.html b/docs/backend_api/index.html index 612058e6f..6c27bd07a 100644 --- a/docs/backend_api/index.html +++ b/docs/backend_api/index.html @@ -71,7 +71,7 @@

Server

To install TriliumNext on your own server (including via Docker from Dockerhub) follow the server installation docs.

📝 Documentation

See wiki for complete list of documentation pages.

You can also read Patterns of personal knowledge base to get some inspiration on how you might use TriliumNext.

-

💻 Contribute

Code

git clone https://github.com/TriliumNext/Notes.git
cd Notes
npm install
npm run start-server
+
💻 Contribute
Code
git clone https://github.com/TriliumNext/Notes.git
cd Notes
npm install
npm run server:start
 

 
 
Documentation
Head on over to our Docs repo

diff --git a/docs/backend_api/media/README-ZH_CN.md b/docs/backend_api/media/README-ZH_CN.md
index f6aa860b1..1f6bbaf55 100644
--- a/docs/backend_api/media/README-ZH_CN.md
+++ b/docs/backend_api/media/README-ZH_CN.md
@@ -78,7 +78,7 @@ Trilium 也提供 Flatpak：
 
 ```shell
 npm install
-npm run start-server
+npm run server:start
 ```
 
 ## 👏 致谢
diff --git a/docs/backend_api/media/README.es.md b/docs/backend_api/media/README.es.md
index a2ea94144..bfa57fe45 100644
--- a/docs/backend_api/media/README.es.md
+++ b/docs/backend_api/media/README.es.md
@@ -86,7 +86,7 @@ Clone localmente y ejecute
 
 ```shell
 npm install
-npm run start-server
+npm run server:start
 ```
 
 ## 👏 Reconocimientos
diff --git a/docs/backend_api/media/README.it.md b/docs/backend_api/media/README.it.md
index a778230c7..750027c1a 100644
--- a/docs/backend_api/media/README.it.md
+++ b/docs/backend_api/media/README.it.md
@@ -73,7 +73,7 @@ Clona localmente ed esegui
 
 ```shell
 npm install
-npm run start-server
+npm run server:start
 ```
 
 ## 👏 Riconoscimenti
diff --git a/docs/backend_api/media/README.ja.md b/docs/backend_api/media/README.ja.md
index 110b779c5..757638770 100644
--- a/docs/backend_api/media/README.ja.md
+++ b/docs/backend_api/media/README.ja.md
@@ -54,7 +54,7 @@ Trilium は Flatpak としても提供されます：
 
 ```shell
 npm install
-npm run start-server
+npm run server:start
 ```
 
 ## 📢 シャウトアウト
diff --git a/docs/backend_api/media/README.md b/docs/backend_api/media/README.md
index 1800f667e..c427d98d0 100644
--- a/docs/backend_api/media/README.md
+++ b/docs/backend_api/media/README.md
@@ -102,7 +102,7 @@ You can also read [Patterns of personal knowledge base](https://triliumnext.gith
 git clone https://github.com/TriliumNext/Notes.git
 cd Notes
 npm install
-npm run start-server
+npm run server:start
 ```
 
 ### Documentation
diff --git a/docs/backend_api/media/README.ru.md b/docs/backend_api/media/README.ru.md
index d78738915..e2336efb3 100644
--- a/docs/backend_api/media/README.ru.md
+++ b/docs/backend_api/media/README.ru.md
@@ -44,7 +44,7 @@ Trilium предоставляется в виде десктопного при
 
 ```shell
 npm install
-npm run start-server
+npm run server:start
 ```
 
 ## 👏 Благодарности
diff --git a/docs/btM6L9JtG301.html b/docs/btM6L9JtG301.html
index a16f503c9..3edf3154a 100644
--- a/docs/btM6L9JtG301.html
+++ b/docs/btM6L9JtG301.html
@@ -38,7 +38,7 @@
 
         
             

-                
Run server
Run with default settings:
npm run start-server
Run with custom port:
TRILIUM_PORT=8082 npm run start-server
Run Electron
Rebuild better-sqlite3 dependency:
npm run switch-electron
Then run Electron:
npm run start-electron
To run Electron using the same data directory as the production version:
npm run start-electron-no-dir
When done, switch back the better-sqlite3 dependency:
npm run switch-server

+                
Run server
Run with default settings:
npm run server:start
Run with custom port:
TRILIUM_PORT=8082 npm run server:start
Run Electron
Rebuild better-sqlite3 dependency:
npm run switch-electron
Then run Electron:
npm run start-electron
To run Electron using the same data directory as the production version:
npm run start-electron-no-dir
When done, switch back the better-sqlite3 dependency:
npm run switch-server

             

         
 
diff --git a/package.json b/package.json
index 9829a639f..65bc95ddc 100644
--- a/package.json
+++ b/package.json
@@ -20,11 +20,11 @@
   },
   "type": "module",
   "scripts": {
-    "start-server": "cross-env TRILIUM_DATA_DIR=./data TRILIUM_ENV=dev TRILIUM_SYNC_SERVER_HOST=http://tsyncserver:4000 nodemon src/main.ts",
+    "server:start": "cross-env TRILIUM_DATA_DIR=./data TRILIUM_ENV=dev TRILIUM_SYNC_SERVER_HOST=http://tsyncserver:4000 nodemon src/main.ts",
     "start-server-safe": "cross-env TRILIUM_DATA_DIR=./data TRILIUM_ENV=dev TRILIUM_SYNC_SERVER_HOST=http://tsyncserver:4000 nodemon src/main.ts",
     "start-server-no-dir": "cross-env TRILIUM_ENV=dev TRILIUM_SYNC_SERVER_HOST=http://tsyncserver:4000 nodemon src/main.ts",
     "start-test-server": "npm run switch-server && rimraf ./data-test && cross-env TRILIUM_DATA_DIR=./data-test TRILIUM_SYNC_SERVER_HOST=http://tsyncserver:4000 TRILIUM_ENV=dev TRILIUM_PORT=9999 nodemon src/main.ts",
-    "qstart-server": "npm run switch-server && npm run start-server",
+    "qstart-server": "npm run switch-server && npm run server:start",
     "start-electron": "cross-env NODE_OPTIONS=\"--import tsx\" TRILIUM_DATA_DIR=./data TRILIUM_SYNC_SERVER_HOST=http://tsyncserver:4000 TRILIUM_ENV=dev electron ./electron-main.ts --inspect=5858 .",
     "start-electron-nix": "electron-rebuild --version 33.3.1 && cross-env NODE_OPTIONS=\"--import tsx\" TRILIUM_DATA_DIR=./data TRILIUM_SYNC_SERVER_HOST=http://tsyncserver:4000 TRILIUM_ENV=dev nix-shell -p electron_33 --run \"electron ./electron-main.ts --inspect=5858 .\"",
     "start-electron-no-dir": "cross-env NODE_OPTIONS=\"--import tsx\" TRILIUM_ENV=dev electron --inspect=5858 .",