Skip to content

Build your personal knowledge base with Trilium Notes

client/text editor/multicolumn layout: fix an issue

Adorian Doranc293e9e10f5a
diff --git a/apps/desktop/scripts/build.ts b/apps/desktop/scripts/build.ts
index c3831f21aa..d440f16459 100644
--- a/apps/desktop/scripts/build.ts
+++ b/apps/desktop/scripts/build.ts
@@ -41,6 +41,7 @@ async function main() {
build.trimBetterSqlite3({ includeMusl: false });
build.copy("/node_modules/ckeditor5/dist/ckeditor5-content.css", "ckeditor5-content.css");
+ build.copy("/packages/ckeditor5/src/theme/multicolumn.css", "ckeditor5-multicolumn.css");
build.buildFrontend();
diff --git a/apps/desktop/spec/build-checks/artifacts.spec.ts b/apps/desktop/spec/build-checks/artifacts.spec.ts
index 9b20eb6818..6a41f552a6 100644
--- a/apps/desktop/spec/build-checks/artifacts.spec.ts
+++ b/apps/desktop/spec/build-checks/artifacts.spec.ts
@@ -31,7 +31,8 @@ describe("Check artifacts are present", () => {
it("includes necessary assets", async () => {
const paths = [
"assets",
- "share-theme"
+ "share-theme",
+ "ckeditor5-multicolumn.css"
];
ensurePathsExist(paths);
diff --git a/apps/edit-docs/scripts/build.ts b/apps/edit-docs/scripts/build.ts
index 880b393343..d1081e6a87 100644
--- a/apps/edit-docs/scripts/build.ts
+++ b/apps/edit-docs/scripts/build.ts
@@ -14,6 +14,7 @@ async function main() {
build.triggerBuildAndCopyTo("packages/share-theme", "share-theme/assets/", "dist");
build.copy("/packages/share-theme/src/templates", "share-theme/templates/");
build.copy("/node_modules/ckeditor5/dist/ckeditor5-content.css", "ckeditor5-content.css");
+ build.copy("/packages/ckeditor5/src/theme/multicolumn.css", "ckeditor5-multicolumn.css");
build.buildFrontend();
// Copy node modules dependencies
diff --git a/apps/edit-docs/spec/build-checks/artifacts.spec.ts b/apps/edit-docs/spec/build-checks/artifacts.spec.ts
index 2e9c878f3c..e01c12141d 100644
--- a/apps/edit-docs/spec/build-checks/artifacts.spec.ts
+++ b/apps/edit-docs/spec/build-checks/artifacts.spec.ts
@@ -32,7 +32,8 @@ describe("Check artifacts are present", () => {
const paths = [
"assets",
"share-theme",
- "ckeditor5-content.css"
+ "ckeditor5-content.css",
+ "ckeditor5-multicolumn.css"
];
ensurePathsExist(paths);
diff --git a/apps/server/scripts/build.ts b/apps/server/scripts/build.ts
index 33f4d5bcfb..efed2fb231 100644
--- a/apps/server/scripts/build.ts
+++ b/apps/server/scripts/build.ts
@@ -37,6 +37,7 @@ async function main() {
build.copyNodeModules([ "better-sqlite3" ]);
build.trimBetterSqlite3();
build.copy("/node_modules/ckeditor5/dist/ckeditor5-content.css", "ckeditor5-content.css");
+ build.copy("/packages/ckeditor5/src/theme/multicolumn.css", "ckeditor5-multicolumn.css");
build.buildFrontend();
}
diff --git a/apps/server/spec/build-checks/artifacts.spec.ts b/apps/server/spec/build-checks/artifacts.spec.ts
index 9b20eb6818..6a41f552a6 100644
--- a/apps/server/spec/build-checks/artifacts.spec.ts
+++ b/apps/server/spec/build-checks/artifacts.spec.ts
@@ -31,7 +31,8 @@ describe("Check artifacts are present", () => {
it("includes necessary assets", async () => {
const paths = [
"assets",
- "share-theme"
+ "share-theme",
+ "ckeditor5-multicolumn.css"
];
ensurePathsExist(paths);
diff --git a/apps/server/src/services/export/zip/factory.spec.ts b/apps/server/src/services/export/zip/factory.spec.ts
index a0ac124f73..b9a6fcdf6a 100644
--- a/apps/server/src/services/export/zip/factory.spec.ts
+++ b/apps/server/src/services/export/zip/factory.spec.ts
@@ -1,4 +1,5 @@
import fs from "fs";
+import path from "path";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
// --- Mocks (hoisted above the module-under-test import) ---
@@ -40,7 +41,9 @@ async function importFactory(dev: boolean) {
let readFileSyncSpy: ReturnType<typeof vi.spyOn>;
beforeEach(() => {
- readFileSyncSpy = vi.spyOn(fs, "readFileSync").mockReturnValue("body { color: red; }" as any);
+ readFileSyncSpy = vi.spyOn(fs, "readFileSync").mockImplementation(((file: string) =>
+ (String(file).endsWith("multicolumn.css") ? ".columns {}" : "body { color: red; }")
+ ) as any);
});
afterEach(() => {
@@ -54,22 +57,30 @@ describe("serverZipExportProviderFactory", () => {
const provider = await factory("html", data);
expect(provider).toBeInstanceOf(FakeHtml);
- expect((provider as any).opts.contentCss).toBe("body { color: red; }");
+ expect((provider as any).opts.contentCss).toBe("body { color: red; }\n.columns {}");
// production reads the bundled css next to the resource dir
- const readPath = readFileSyncSpy.mock.calls[0][0] as string;
- expect(readPath).toContain("ckeditor5-content.css");
- expect(readPath).not.toContain("node_modules");
+ const readPaths = readFileSyncSpy.mock.calls.map(([ file ]) => String(file));
+ expect(readPaths).toHaveLength(2);
+ expect(path.basename(readPaths[0])).toBe("ckeditor5-content.css");
+ expect(path.basename(readPaths[1])).toBe("ckeditor5-multicolumn.css");
+ expect(readPaths.some((file) => file.includes("node_modules"))).toBe(false);
});
it("builds an HTML provider, resolving content CSS from the ckeditor5 package in dev mode", async () => {
const factory = await importFactory(true);
- await factory("html", data);
+ const provider = await factory("html", data);
- const readPath = readFileSyncSpy.mock.calls[0][0] as string;
- expect(readPath).toContain("ckeditor5-content.css");
+ const readPaths = readFileSyncSpy.mock.calls.map(([ file ]) => String(file));
+ expect(readPaths).toHaveLength(2);
+ expect(readPaths[0]).toContain("ckeditor5-content.css");
// dev resolves the file from the ckeditor5 package (under node_modules),
// unlike the production path which reads from the resource dir.
- expect(readPath).toContain("node_modules");
+ expect(readPaths[0]).toContain("node_modules");
+ // The multicolumn stylesheet comes from the workspace's own editor package.
+ expect(path.normalize(readPaths[1]))
+ .toContain(path.join("packages", "ckeditor5", "src", "theme", "multicolumn.css"));
+ expect(fs.existsSync(readPaths[1])).toBe(true);
+ expect((provider as any).opts.contentCss).toBe("body { color: red; }\n.columns {}");
});
it("builds a Markdown provider without reading any CSS", async () => {
diff --git a/apps/server/src/services/export/zip/factory.ts b/apps/server/src/services/export/zip/factory.ts
index e5a56ae456..8fd347ee44 100644
--- a/apps/server/src/services/export/zip/factory.ts
+++ b/apps/server/src/services/export/zip/factory.ts
@@ -4,11 +4,17 @@ import path from "path";
import { getResourceDir, isDev } from "../../utils.js";
+/** The stylesheet of an HTML export: CKEditor's content styles, then the multicolumn layout's. */
function readContentCss(): string {
- const cssFile = isDev
- ? path.join(require.resolve("ckeditor5/ckeditor5-content.css"))
- : path.join(getResourceDir(), "ckeditor5-content.css");
- return fs.readFileSync(cssFile, "utf-8");
+ const cssFiles = isDev
+ ? [
+ require.resolve("ckeditor5/ckeditor5-content.css"),
+ // In development the resource directory is `apps/server/src`.
+ path.join(getResourceDir(), "../../../packages/ckeditor5/src/theme/multicolumn.css")
+ ]
+ : [ "ckeditor5-content.css", "ckeditor5-multicolumn.css" ]
+ .map((fileName) => path.join(getResourceDir(), fileName));
+ return cssFiles.map((cssFile) => fs.readFileSync(cssFile, "utf-8")).join("\n");
}
export async function serverZipExportProviderFactory(format: ExportFormat, data: ZipExportProviderData): Promise<ZipExportProvider> {
diff --git a/apps/standalone/src/lightweight/zip_export_provider_factory.spec.ts b/apps/standalone/src/lightweight/zip_export_provider_factory.spec.ts
index ffa96fa7b8..56bafc28c4 100644
--- a/apps/standalone/src/lightweight/zip_export_provider_factory.spec.ts
+++ b/apps/standalone/src/lightweight/zip_export_provider_factory.spec.ts
@@ -5,6 +5,9 @@ import BrowserZipProvider from "./zip_provider.js";
import { standaloneZipExportProviderFactory } from "./zip_export_provider_factory.js";
vi.mock("virtual:share-theme-assets", () => ({ default: [ "styles.css", "scripts.js" ] }));
+// Vitest imports a stylesheet with `?raw` as an empty string, so the two stand in with markers.
+vi.mock("@triliumnext/ckeditor5/src/theme/ck-content.css?raw", () => ({ default: ".content {}" }));
+vi.mock("@triliumnext/ckeditor5/src/theme/multicolumn.css?raw", () => ({ default: ".columns {}" }));
function makeData(content = "<p>No diagrams.</p>"): ZipExportProviderData {
const note = {
@@ -26,11 +29,14 @@ afterEach(() => {
});
describe("standaloneZipExportProviderFactory", () => {
- it("creates an HTML export provider", async () => {
+ it("creates an HTML export provider, styled with the content and column styles", async () => {
const data = makeData();
const provider = await standaloneZipExportProviderFactory("html", data);
expect(provider.constructor.name).toBe("HtmlExportProvider");
expect(provider.branch).toBe(data.branch);
+
+ const { options } = provider as unknown as { options: { contentCss?: string } };
+ expect(options.contentCss).toBe(".content {}\n.columns {}");
});
it("creates a Markdown export provider", async () => {
diff --git a/apps/standalone/src/lightweight/zip_export_provider_factory.ts b/apps/standalone/src/lightweight/zip_export_provider_factory.ts
index a6176cccab..3c195a5b9b 100644
--- a/apps/standalone/src/lightweight/zip_export_provider_factory.ts
+++ b/apps/standalone/src/lightweight/zip_export_provider_factory.ts
@@ -13,12 +13,13 @@ import type {
} from "@triliumnext/core/src/services/export/zip/share_theme.js";
import contentCss from "@triliumnext/ckeditor5/src/theme/ck-content.css?raw";
+import multicolumnCss from "@triliumnext/ckeditor5/src/theme/multicolumn.css?raw";
export async function standaloneZipExportProviderFactory(format: ExportFormat, data: ZipExportProviderData): Promise<ZipExportProvider> {
switch (format) {
case "html": {
const { default: HtmlExportProvider } = await import("@triliumnext/core/src/services/export/zip/html.js");
- return new HtmlExportProvider(data, { contentCss });
+ return new HtmlExportProvider(data, { contentCss: `${contentCss}\n${multicolumnCss}` });
}
case "markdown": {
const { default: MarkdownExportProvider } = await import("@triliumnext/core/src/services/export/zip/markdown.js");