@gtkx/cli 1.3.0 → 1.5.0

package/src/deploy/notices/packages.ts

@@ -1,17 +1,11 @@
-import { isRecord, sortStringsBy, warn } from "@gtkx/utils";
-import { existsSync, readFileSync, realpathSync } from "node:fs";
+import { sortStringsBy, warn } from "@gtkx/utils";
+import { existsSync, realpathSync } from "node:fs";
 import { join, resolve } from "node:path";
+import type { RecordedPackage } from "../../internal/build-manifest.js";
 import type { DeploySettings } from "../types.js";
-import { BUNDLED_PACKAGES_FILENAME } from "../../vite-plugins/bundled-packages.js";
 import { type PackageManifest, readPackageManifest } from "../settings/package-manifest.js";
 import { copyrightLines, licenseTextIn } from "./text.js";
 
-type RecordedPackage = {
-    name: string;
-    version: string | null;
-    dir: string;
-};
-
 type BundledPackage = {
     name: string;
     version: string | null;
@@ -36,38 +30,6 @@ const realPath = (path: string): string => {
     }
 };
 
-const optionalString = (value: unknown): string | null => (typeof value === "string" ? value : null);
-
-const recordedPackage = (entry: unknown): RecordedPackage | null => {
-    if (!isRecord(entry) || typeof entry.name !== "string" || typeof entry.dir !== "string") {
-        return null;
-    }
-
-    return { name: entry.name, version: optionalString(entry.version), dir: entry.dir };
-};
-
-const recordedList = (value: unknown): RecordedPackage[] => {
-    if (!Array.isArray(value)) {
-        return [];
-    }
-
-    const entries: unknown[] = value;
-
-    return entries.map((entry) => recordedPackage(entry)).filter((entry) => entry !== null);
-};
-
-const readRecordedPackages = (settings: DeploySettings): RecordedPackage[] => {
-    const path = join(settings.paths.dist, BUNDLED_PACKAGES_FILENAME);
-
-    if (!existsSync(path)) {
-        throw new Error(`Cannot deploy: ${path} is missing. Run \`gtkx build\` first.`);
-    }
-
-    const parsed: unknown = JSON.parse(readFileSync(path, "utf8"));
-
-    return recordedList(isRecord(parsed) ? parsed.packages : null);
-};
-
 const authorLine = (manifest: PackageManifest): string[] => {
     const { name, email } = manifest.author;
 
@@ -151,10 +113,10 @@ const warnMissing = (entries: BundledPackage[]): void => {
     );
 };
 
-const bundledPackages = (settings: DeploySettings): BundledPackage[] => {
+const bundledPackages = (settings: DeploySettings, recorded: RecordedPackage[]): BundledPackage[] => {
     const root = realPath(settings.paths.root);
 
-    const entries = readRecordedPackages(settings)
+    const entries = recorded
         .map((entry) => ({ entry, dir: resolve(settings.paths.dist, entry.dir) }))
         .filter(({ dir }) => realPath(dir) !== root)
         .map(({ entry, dir }) => packageIn(entry, dir));

package/src/deploy/payload/icons.ts

@@ -1,53 +1,82 @@
-import { basename, join } from "node:path";
+import { join } from "node:path";
 import type { DeploySettings, StagedFile } from "../types.js";
+import { relativeIconPath } from "../../internal/icon-path.js";
 import { listFilesRecursive } from "../../internal/list-files.js";
 import { copyInto } from "./copy-tree.js";
 
+type ApplicationIconVariant = {
+    effectivePixels: number;
+    scalable: boolean;
+};
+
 const ICON_EXTENSIONS = [".svg", ".png", ".xpm"];
 const SHARE_ICONS = "share/icons";
-const SCALABLE_DIR = "hicolor/scalable/apps";
-const SIZE_PATTERN = /^(?<width>[1-9]\d{0,3})x(?<height>[1-9]\d{0,3})$/;
-const SIZE_SEPARATORS = /[-_.]/;
-
-const isApplicationIcon = (settings: DeploySettings, rel: string): boolean =>
-    ICON_EXTENSIONS.some((extension) => basename(rel) === `${settings.applicationId}${extension}`);
+const SIZE_PATTERN = /^(?<width>[1-9]\d{0,3})x(?<height>[1-9]\d{0,3})(?:@(?<scale>[1-9]\d*))?$/;
 
-const getSquareSize = (token: string): number | null => {
+const getSquareSize = (token: string): { pixels: number; scale: number } | null => {
     const groups = SIZE_PATTERN.exec(token)?.groups;
 
     if (groups === undefined || groups.width !== groups.height) {
         return null;
     }
 
-    return Number(groups.width);
+    const pixels = Number(groups.width);
+    const scale = Number(groups.scale ?? "1");
+
+    return Number.isSafeInteger(pixels * scale) ? { pixels, scale } : null;
+};
+
+const isIconThemeSize = (segment: string | undefined): boolean =>
+    segment === "scalable" || segment === "symbolic" ||
+    (segment !== undefined && getSquareSize(segment) !== null);
+
+const iconExtension = (applicationId: string, filename: string | undefined): string | undefined =>
+    ICON_EXTENSIONS.find((candidate) => filename === `${applicationId}${candidate}`);
+
+const isApplicationIconLayout = (segments: (string | undefined)[]): boolean => {
+    const [share, icons, theme, size, context] = segments;
+
+    return share === "share" &&
+        icons === "icons" &&
+        theme === "hicolor" &&
+        context === "apps" &&
+        isIconThemeSize(size);
 };
 
-const firstSquareSize = (tokens: string[]): number | null =>
-    tokens.map((token) => getSquareSize(token)).find((size) => size !== null) ?? null;
+const classifyApplicationIcon = (applicationId: string, rel: string): ApplicationIconVariant | null => {
+    const segments = rel.split(/[\\/]/);
+
+    if (segments.length !== 6) {
+        return null;
+    }
 
-const getIconSize = (rel: string): number | null => firstSquareSize(rel.split("/").slice(0, -1));
+    const size = segments[3];
+    const filename = segments[5];
+    const extension = iconExtension(applicationId, filename);
 
-const themeDirFor = (file: string): string => {
-    if (file.endsWith(".svg")) {
-        return SCALABLE_DIR;
+    if (extension === undefined || !isApplicationIconLayout(segments)) {
+        return null;
     }
 
-    const size = firstSquareSize(basename(file).split(SIZE_SEPARATORS));
+    const square = size === undefined ? null : getSquareSize(size);
 
-    return size === null ? SCALABLE_DIR : `hicolor/${String(size)}x${String(size)}/apps`;
+    return {
+        effectivePixels: square === null ? 0 : square.pixels * square.scale,
+        scalable: extension === ".svg",
+    };
 };
 
-const stageIconTree = (root: string, iconsDir: string): StagedFile[] =>
-    listFilesRecursive(iconsDir).map((file) => copyInto(root, join(SHARE_ICONS, file.rel), file.absPath));
+const isApplicationIcon = (settings: DeploySettings, rel: string): boolean =>
+    classifyApplicationIcon(settings.applicationId, rel) !== null;
 
-const iconPathFor = (settings: DeploySettings, iconFile: string): string => {
-    const extension = ICON_EXTENSIONS.find((candidate) => iconFile.endsWith(candidate)) ?? ".png";
+const stageIconTree = (root: string, themePath: string): StagedFile[] =>
+    listFilesRecursive(themePath).map((file) => copyInto(root, join(SHARE_ICONS, file.rel), file.absPath));
 
-    return join(themeDirFor(iconFile), `${settings.applicationId}${extension}`);
-};
+const iconPathFor = (settings: DeploySettings, iconPath: string): string =>
+    relativeIconPath(settings.applicationId, iconPath);
 
-const stageIconFile = (settings: DeploySettings, root: string, iconFile: string): StagedFile[] =>
-    [copyInto(root, join(SHARE_ICONS, iconPathFor(settings, iconFile)), iconFile)];
+const stageIconFile = (settings: DeploySettings, root: string, iconPath: string): StagedFile[] =>
+    [copyInto(root, join(SHARE_ICONS, iconPathFor(settings, iconPath)), iconPath)];
 
 const assertApplicationIcon = (settings: DeploySettings, staged: StagedFile[]): void => {
     if (staged.some((file) => isApplicationIcon(settings, file.rel))) {
@@ -55,26 +84,27 @@ const assertApplicationIcon = (settings: DeploySettings, staged: StagedFile[]):
     }
 
     throw new Error(
-        `Cannot deploy without an application icon: no ${settings.applicationId}.svg or ` +
-        `${settings.applicationId}.png under ${settings.paths.iconsDir ?? "the project's icon directory"}. ` +
+        "Cannot deploy without a usable application icon: the configured theme must contain " +
+        `${settings.applicationId}.svg, ${settings.applicationId}.png, or ${settings.applicationId}.xpm ` +
+        "under hicolor/<size>/apps. " +
         "The desktop entry names " +
         `"${settings.applicationId}" as its icon, so the file has to match. ` +
-        `Add ${settings.paths.dataDir ?? "data"}/icons/hicolor/scalable/apps/${settings.applicationId}.svg, ` +
-        "or point `deploy.icons` at one.",
+        "Set `applicationIcon` to a theme directory containing " +
+        `hicolor/scalable/apps/${settings.applicationId}.svg, or point it at a single icon file.`,
     );
 };
 
 const stageIcons = (settings: DeploySettings, root: string): StagedFile[] => {
-    const { iconsDir, iconFile } = settings.paths;
+    const source = settings.paths.applicationIcon;
 
-    if (iconFile !== null) {
-        return stageIconFile(settings, root, iconFile);
+    if (source.kind === "file") {
+        return stageIconFile(settings, root, source.path);
     }
 
-    const staged = iconsDir === null ? [] : stageIconTree(root, iconsDir);
+    const staged = source.kind === "theme" ? stageIconTree(root, source.path) : [];
     assertApplicationIcon(settings, staged);
 
     return staged;
 };
 
-export { getIconSize, iconPathFor, stageIcons };
+export { classifyApplicationIcon, iconPathFor, stageIcons, type ApplicationIconVariant };

package/src/deploy/payload/launcher.ts

@@ -18,6 +18,8 @@ const renderLauncher = (settings: DeploySettings): string => {
         "set -e",
         'self=$(readlink -f "$0")',
         'prefix=$(dirname "$(dirname "$self")")',
+        'GTKX_LOCALE_DIR="$prefix/share/locale"',
+        "export GTKX_LOCALE_DIR",
         ...(shouldUseCompileCache ? compileCacheLines(settings.binaryName) : []),
         `exec "${libDir}/${NODE_FILENAME}" "${libDir}/${BUNDLE_FILENAME}" "$@"`,
         "",

package/src/deploy/payload/stage.ts

@@ -2,12 +2,12 @@ import { sortStringsBy } from "@gtkx/utils";
 import { existsSync, rmSync } from "node:fs";
 import { join, resolve } from "node:path";
 import type { DeploySettings, DeployTargetName, NodeRuntime, NoticeSection, StagedFile } from "../types.js";
+import { LOCALE_DIRNAME } from "../../i18n/catalogs.js";
+import { BUILD_MANIFEST_FILENAME } from "../../internal/build-manifest.js";
 import { listFilesRecursive } from "../../internal/list-files.js";
-import { BUNDLED_PACKAGES_FILENAME } from "../../vite-plugins/bundled-packages.js";
 import { BUNDLE_FILENAME } from "../../vite-plugins/esm-extension.js";
 import { renderCopyright } from "../freedesktop/copyright.js";
 import { renderDbusService } from "../freedesktop/dbus-service.js";
-import { renderDesktopEntry } from "../freedesktop/desktop-entry.js";
 import { renderNotices } from "../notices/render.js";
 import { copyInto, EXECUTABLE_MODE, executableModeFor, writeInto } from "./copy-tree.js";
 import { stageIcons } from "./icons.js";
@@ -27,6 +27,7 @@ type StagedMetadata = {
 };
 
 const DIST_ICONS_DIR = "icons";
+const LEGACY_PACKAGES_MANIFEST_FILENAME = "gtkx-packages.json";
 const NOTICES_FILENAME = "THIRD-PARTY-NOTICES";
 const NODE_LICENSE_FILENAME = "LICENSE";
 const SHARE_APPLICATIONS = "share/applications";
@@ -35,6 +36,7 @@ const SHARE_MIME_PACKAGES = "share/mime/packages";
 const SHARE_DOC = "share/doc";
 const SHARE_LICENSES = "share/licenses";
 const SHARE_DBUS_SERVICES = "share/dbus-1/services";
+const SHARE_LOCALE = `share/${LOCALE_DIRNAME}`;
 
 const PREFIX_FOR: Record<DeployTargetName, string> = {
     appimage: "/usr",
@@ -48,7 +50,11 @@ const licenseDirFor = (settings: DeploySettings): string => `${SHARE_LICENSES}/$
 const licenseDestination = (settings: DeploySettings): string => `${licenseDirFor(settings)}/LICENSE`;
 const noticesDestination = (settings: DeploySettings): string => `${licenseDirFor(settings)}/${NOTICES_FILENAME}`;
 const isIconAsset = (rel: string): boolean => rel === DIST_ICONS_DIR || rel.startsWith(`${DIST_ICONS_DIR}/`);
-const isBuildMetadata = (rel: string): boolean => rel === BUNDLED_PACKAGES_FILENAME;
+
+const isBuildMetadata = (rel: string): boolean =>
+    rel === BUILD_MANIFEST_FILENAME || rel === LEGACY_PACKAGES_MANIFEST_FILENAME;
+
+const isLocaleAsset = (rel: string): boolean => rel === LOCALE_DIRNAME || rel.startsWith(`${LOCALE_DIRNAME}/`);
 
 const nodeLicenseDestination = (settings: DeploySettings): string =>
     `${licenseDirFor(settings)}/${NODE_FILENAME}/${NODE_LICENSE_FILENAME}`;
@@ -61,10 +67,14 @@ const stageRuntimeFiles = (settings: DeploySettings, root: string): StagedFile[]
     }
 
     return listFilesRecursive(dist)
-        .filter((file) => !isIconAsset(file.rel) && !isBuildMetadata(file.rel))
+        .filter((file) => !isIconAsset(file.rel) && !isBuildMetadata(file.rel) && !isLocaleAsset(file.rel))
         .map((file) => copyInto(root, join(libDirFor(settings), file.rel), file.absPath));
 };
 
+const stageCatalogs = (settings: DeploySettings, root: string): StagedFile[] =>
+    listFilesRecursive(join(settings.paths.dist, LOCALE_DIRNAME))
+        .map((file) => copyInto(root, join(SHARE_LOCALE, file.rel), file.absPath));
+
 const stageNodeBinary = (settings: DeploySettings, root: string, node: NodeRuntime | null): StagedFile[] =>
     node === null ? [] : [copyInto(root, join(libDirFor(settings), NODE_FILENAME), node.path, EXECUTABLE_MODE)];
 
@@ -101,6 +111,7 @@ const stagePayload = ({ settings, node, metadata }: StageRequest): StagedFile[]
         writeInto(root, join("bin", settings.binaryName), renderLauncher(settings), EXECUTABLE_MODE),
         ...stageNodeBinary(settings, root, node),
         ...stageRuntimeFiles(settings, root),
+        ...stageCatalogs(settings, root),
         ...stageMetadata(settings, root, metadata),
         ...stageIcons(settings, root),
         ...stageSchemas(settings, root),
@@ -108,7 +119,18 @@ const stagePayload = ({ settings, node, metadata }: StageRequest): StagedFile[]
     ]);
 };
 
-const stageActivation = (settings: DeploySettings, root: string, target: DeployTargetName): StagedFile[] => {
+const withoutDbusActivation = (desktopEntry: string): string =>
+    desktopEntry
+        .split("\n")
+        .filter((line) => line !== "DBusActivatable=true")
+        .join("\n");
+
+const stageActivation = (
+    settings: DeploySettings,
+    root: string,
+    target: DeployTargetName,
+    metadata: StagedMetadata,
+): StagedFile[] => {
     if (!settings.isDbusActivatable) {
         return [];
     }
@@ -117,7 +139,7 @@ const stageActivation = (settings: DeploySettings, root: string, target: DeployT
         return [writeInto(
             root,
             join(SHARE_APPLICATIONS, `${settings.applicationId}.desktop`),
-            renderDesktopEntry({ ...settings, isDbusActivatable: false }),
+            withoutDbusActivation(metadata.desktopEntry),
         )];
     }
 
@@ -128,11 +150,16 @@ const stageActivation = (settings: DeploySettings, root: string, target: DeployT
     )];
 };
 
-const stageOverlay = (settings: DeploySettings, target: DeployTargetName, notices: NoticeSection[]): StagedFile[] => {
+const stageOverlay = (
+    settings: DeploySettings,
+    target: DeployTargetName,
+    notices: NoticeSection[],
+    metadata: StagedMetadata,
+): StagedFile[] => {
     const root = join(settings.paths.overlay, target);
     rmSync(root, { recursive: true, force: true, maxRetries: 5 });
     const licenseFile = settings.paths.licenseFile;
-    const activation = stageActivation(settings, root, target);
+    const activation = stageActivation(settings, root, target, metadata);
 
     if (target === "deb") {
         return [
@@ -151,11 +178,12 @@ const stageOverlay = (settings: DeploySettings, target: DeployTargetName, notice
 const stageOverlays = (
     settings: DeploySettings,
     notices: NoticeSection[],
+    metadata: StagedMetadata,
 ): Record<DeployTargetName, StagedFile[]> => ({
-    appimage: stageOverlay(settings, "appimage", notices),
-    deb: stageOverlay(settings, "deb", notices),
-    flatpak: stageOverlay(settings, "flatpak", notices),
-    rpm: stageOverlay(settings, "rpm", notices),
+    appimage: stageOverlay(settings, "appimage", notices, metadata),
+    deb: stageOverlay(settings, "deb", notices, metadata),
+    flatpak: stageOverlay(settings, "flatpak", notices, metadata),
+    rpm: stageOverlay(settings, "rpm", notices, metadata),
 });
 
 export {