Merge branch 'develop' into renovate/apple-actions-import-codesign-certs-5.x

Author: eliandoran

.dockerignore

@@ -34,10 +34,11 @@ npm-debug.log
 
 # exceptions
 !/bin/copy-dist.ts
-!/bin/electron-forge/sign-windows.cjs
+!/bin/cleanupNodeModules.ts
 
 # temporary exception to make copy-dist inside Docker build not fail
-# TriliumNextTODO: make copy-dist *not* requiring to copy this file for builds other than electron-forge
+# TriliumNextTODO: make copy-dist *not* requiring to copy these file for builds other than electron-forge
 !forge.config.cjs
 !/bin/tpl
-!/bin/electron-forge/desktop.ejs
+!/bin/electron-forge/desktop.ejs
+!/bin/electron-forge/sign-windows.cjs

.dprint.json

@@ -0,0 +1,44 @@
+{
+  "typescript": {
+    "indentWidth": 4,
+    "quoteStyle": "preferDouble",
+    "semiColons": "prefer",
+    "quoteProps": "asNeeded",
+    "newLineKind": "lf",
+    "lineWidth": 200,
+    "trailingCommas": "never",
+    "arrayPattern.spaceAround": true,
+    "arrayExpression.spaceAround": true
+  },
+  "json": {
+  },
+  "markdown": {
+  },
+  "dockerfile": {
+  },
+  "malva": {
+  },
+  "markup": {
+  },
+  "yaml": {
+  },
+  "excludes": [
+    "**/node_modules",
+    "**/*-lock.json",
+    "*.html",
+    "*.md",
+    "*.yml",
+    "libraries/*",
+    "docs/*",
+    "src/public/app/doc_notes"
+  ],
+  "plugins": [
+    "https://plugins.dprint.dev/typescript-0.94.0.wasm",
+    "https://plugins.dprint.dev/json-0.20.0.wasm",
+    "https://plugins.dprint.dev/markdown-0.18.0.wasm",
+    "https://plugins.dprint.dev/dockerfile-0.3.2.wasm",
+    "https://plugins.dprint.dev/g-plane/malva-v0.11.1.wasm",
+    "https://plugins.dprint.dev/g-plane/markup_fmt-v0.19.0.wasm",
+    "https://plugins.dprint.dev/g-plane/pretty_yaml-v0.5.0.wasm"
+  ]
+}

.github/actions/build-electron/action.yml

@@ -81,7 +81,7 @@ runs:
         APPLE_ID: ${{ env.APPLE_ID }}
         APPLE_ID_PASSWORD: ${{ env.APPLE_ID_PASSWORD }}
         WINDOWS_SIGN_EXECUTABLE: ${{ env.WINDOWS_SIGN_EXECUTABLE }}
-        TRILIUM_ARTIFACT_NAME_HINT: TriliumNextNotes ${{ inputs.os }} ${{ inputs.arch }}
+        TRILIUM_ARTIFACT_NAME_HINT: TriliumNextNotes-${{ github.ref_name }}-${{ inputs.os }}-${{ inputs.arch }}
       run: |
         npm run electron-forge:make -- \
           --arch=${{ inputs.arch }} \

.prettierignore

@@ -39,8 +39,11 @@ COPY --from=builder /usr/src/app ./
 
 RUN sed -i "/electron/d" package.json && \
     npm ci --omit=dev && \
+    node --experimental-strip-types ./bin/cleanupNodeModules.ts . --skip-prune-dev-deps && \
     npm cache clean --force && \
-    rm -rf /tmp/node-compile-cache
+    rm -rf \
+      /tmp/node-compile-cache \
+      /usr/src/app/bin/cleanupNodeModules.ts
 
 # Configure container
 EXPOSE 8080

.prettierrc

@@ -34,8 +34,11 @@ COPY --from=builder /usr/src/app ./
 
 RUN sed -i "/electron/d" package.json && \
     npm ci --omit=dev && \
+    node --experimental-strip-types ./bin/cleanupNodeModules.ts . --skip-prune-dev-deps && \
     npm cache clean --force && \
-    rm -rf /tmp/node-compile-cache
+    rm -rf \
+      /tmp/node-compile-cache \
+      /usr/src/app/bin/cleanupNodeModules.ts
 
 # Add application user
 RUN adduser -s /bin/false node; exit 0

Dockerfile

@@ -79,10 +79,11 @@ xattr -c "/path/to/Trilium Next.app"
 
 ### Mobile
 
-To use TriliumNext on a mobile device:
+To use TriliumNext on a mobile device, you can use a mobile web browser to access the mobile interface of a server installation (see below).
 
-* Use a mobile web browser to access the mobile interface of a server installation (see below)
-* Use of a mobile app is not yet supported ([see here](https://github.com/TriliumNext/Notes/issues/72)) to track mobile improvements.
+If you prefer a native Android app, you can use [TriliumDroid](https://apt.izzysoft.de/fdroid/index/apk/eu.fliegendewurst.triliumdroid). Report bugs and missing features at [their repository](https://github.com/FliegendeWurst/TriliumDroid).
+
+See issue https://github.com/TriliumNext/Notes/issues/72 for more information on mobile app support.
 
 ### Server
 
@@ -107,7 +108,8 @@ npm run server:start
 
 ### Documentation
 
-Head on over to our [Docs repo](https://github.com/TriliumNext/Docs)
+We are currently transitioning to a new documentation mechanism.
+Meanwhile you can still view the [archived Docs repository](https://github.com/TriliumNext/Docs).
 
 ## 👏 Shoutouts
 

Dockerfile.alpine

@@ -25,8 +25,16 @@ NODE_VERSION=22.14.0
 
 BUILD_DIR="./build"
 DIST_DIR="./dist"
+CLEANUP_SCRIPT="./bin/cleanupNodeModules.ts"
 
-./bin/copy-trilium.sh
+
+# Trigger the build
+echo "Build start"
+npm run build:prepare-dist
+echo "Build finished"
+
+# pruning of unnecessary files and devDeps in node_modules
+node --experimental-strip-types $CLEANUP_SCRIPT $BUILD_DIR
 
 NODE_FILENAME=node-v${NODE_VERSION}-linux-${ARCH}
 
@@ -37,7 +45,9 @@ mv $NODE_FILENAME node
 cd ..
 
 
-rm -r $BUILD_DIR/node/lib/node_modules/npm \
+rm -r $BUILD_DIR/node/lib/node_modules/{npm,corepack} \
+    $BUILD_DIR/node/bin/{npm,npx,corepack} \
+    $BUILD_DIR/node/CHANGELOG.md \
     $BUILD_DIR/node/include/node \
     $BUILD_DIR/node_modules/electron* \
     $BUILD_DIR/electron*.{js,map}

README.md

@@ -0,0 +1,109 @@
+import fs from "fs-extra";
+import path from "path";
+import type { Dirent } from "fs-extra";
+import { execSync } from "node:child_process";
+
+/**
+ * Example usage with node >= v22:
+ *    node --experimental-strip-types bin/cleanupNodeModules.ts /path/to/build/folder [--skip-prune-dev-deps]
+ * Example usage with tsx:
+ *    tsx bin/cleanupNodeModules.ts /path/to/build/folder [--skip-prune-dev-deps]
+ */
+function main() {
+
+    if (process.argv.length > 4 || process.argv.length < 3) {
+        console.error("Usage: cleanupNodeModules.ts [path-to-build-folder] [--skip-prune-dev-deps]");
+        process.exit(1);
+    }
+
+    const basePath = process.argv[2];
+    const pruneDevDeps = process.argv[3] !== "--skip-prune-dev-deps";
+
+    if (!fs.existsSync(basePath)) {
+        console.error(`Supplied path '${basePath}' does not exist. Aborting.`);
+        process.exit(1);
+    }
+
+    console.log(`Starting pruning of node_modules ${!pruneDevDeps ? '(skipping npm pruning)' : ''} in '${basePath}'...`);
+    cleanupNodeModules(basePath, pruneDevDeps);
+    console.log("Successfully pruned node_modules.");
+}
+
+function cleanupNodeModules(basePath: string, pruneDevDeps: boolean = true) {
+
+    // This needs to run for the server and Docker build,
+    // but needs to be skipped for electron-forge: its
+    // built-in pruning takes care of it already
+    if (pruneDevDeps) {
+        execSync(`npm ci --omit=dev --prefix ${basePath}`);
+    }
+
+    const nodeModulesDirPath = path.join(basePath, "node_modules");
+    const nodeModulesContent = fs.readdirSync(nodeModulesDirPath, { recursive: true, withFileTypes: true });
+    //const libDir = fs.readdirSync(path.join(basePath, "./libraries"), { recursive: true, withFileTypes: true });
+
+    /**
+     * Delete unnecessary folders
+     */
+    const filterableDirs = new Set([
+        "demo",
+        "demos",
+        "doc",
+        "docs",
+        "example",
+        "examples",
+        "test",
+        "tests"
+    ]);
+
+    nodeModulesContent
+        .filter(el => el.isDirectory() && filterableDirs.has(el.name))
+        .forEach(dir => removeDirent(dir));
+
+    /**
+     * Delete unnecessary files based on file extension
+     * TODO filter out useless (README).md files
+     */
+    const filterableFileExt = new Set([
+        "ts",
+        "map"
+    ]);
+
+    nodeModulesContent
+        // TriliumNextTODO: check if we can improve this naive file ext matching, without introducing any additional dependency
+        .filter(el => el.isFile() && filterableFileExt.has(el.name.split(".").at(-1) || ""))
+        .forEach(dir => removeDirent(dir));
+
+
+    /**
+     * Delete specific unnecessary folders
+     * TODO: check if we want removeSync to throw an error, if path does not exist anymore -> currently it will silently fail
+     */
+    const extraFoldersDelete = new Set([
+        path.join(nodeModulesDirPath, ".bin"),
+        path.join(nodeModulesDirPath, "@excalidraw", "excalidraw", "dist", "dev"),
+        path.join(nodeModulesDirPath, "boxicons", "svg"),
+        path.join(nodeModulesDirPath, "boxicons", "node_modules"),
+        path.join(nodeModulesDirPath, "boxicons", "src"),
+        path.join(nodeModulesDirPath, "boxicons", "iconjar"),
+        path.join(nodeModulesDirPath, "@jimp", "plugin-print", "fonts"),
+        path.join(nodeModulesDirPath, "jimp", "dist", "browser") // missing "@" in front of jimp is not a typo here
+    ]);
+
+    nodeModulesContent
+        .filter(el => el.isDirectory() && extraFoldersDelete.has(path.join(el.parentPath, el.name)))
+        .forEach(dir => removeDirent(dir))
+}
+
+
+function removeDirent(el: Dirent) {
+    const elementToDelete = path.join(el.parentPath, el.name);
+    fs.removeSync(elementToDelete);
+
+    if (process.env.VERBOSE) {
+        console.log(`Deleted ${elementToDelete}`);
+    }
+
+}
+
+main()