@gtkx/cli 1.3.0 → 1.5.0

package/src/deploy/targets/appimage.ts

@@ -1,5 +1,5 @@
 import { existsSync, mkdirSync, rmSync, statSync } from "node:fs";
-import { join } from "node:path";
+import { basename, join } from "node:path";
 import type {
     DeployArtifact,
     DeployManifest,
@@ -10,18 +10,21 @@ import type {
 } from "../types.js";
 import { runCliTool } from "../../internal/run-cli-tool.js";
 import { copyInto, copyTree, EXECUTABLE_MODE, writeInto } from "../payload/copy-tree.js";
-import { getIconSize } from "../payload/icons.js";
+import { type ApplicationIconVariant, classifyApplicationIcon } from "../payload/icons.js";
 import { FILE_TOOL } from "../tools.js";
 import { resolveAppimageTooling } from "../vendored/appimagetool.js";
 
+type RankedIcon = {
+    file: StagedFile;
+    variant: ApplicationIconVariant;
+};
+
 const PREFIX = "/usr";
 const TARGET_DIR = "appimage";
 const APPRUN_FILENAME = "AppRun";
 const APPDIR_NAME = "AppDir";
 const USR_DIR = "usr";
-const ICON_EXTENSIONS = [".svg", ".png", ".xpm"];
 const EXTRACT_AND_RUN = "APPIMAGE_EXTRACT_AND_RUN";
-const SCALABLE_RANK = Number.MAX_SAFE_INTEGER;
 
 const appimageTarget: DeployTarget = {
     name: "appimage",
@@ -50,31 +53,45 @@ const renderManifests = (payload: DeployPayload): DeployManifest[] => [
     { path: appRunPathFor(payload.settings), contents: renderAppRun(payload.settings) },
 ];
 
-const iconRank = (file: StagedFile): number =>
-    file.rel.endsWith(".svg") ? SCALABLE_RANK : (getIconSize(file.rel) ?? 0);
+const rankedIcon = (applicationId: string, file: StagedFile): RankedIcon | null => {
+    const variant = classifyApplicationIcon(applicationId, file.rel);
+
+    return variant === null ? null : { file, variant };
+};
+
+const isLargerIcon = (candidate: RankedIcon, best: RankedIcon): boolean =>
+    candidate.variant.scalable === best.variant.scalable
+        ? candidate.variant.effectivePixels > best.variant.effectivePixels
+        : candidate.variant.scalable;
+
+const largerIcon = (best: RankedIcon | undefined, candidate: RankedIcon): RankedIcon =>
+    best === undefined || isLargerIcon(candidate, best) ? candidate : best;
 
-const largestIcon = (icons: StagedFile[]): StagedFile | undefined => {
-    let best: StagedFile | undefined;
+const largestIcon = (applicationId: string, files: StagedFile[]): StagedFile | undefined => {
+    let best: RankedIcon | undefined;
 
-    for (const file of icons) {
-        if (best === undefined || iconRank(file) > iconRank(best)) {
-            best = file;
+    for (const file of files) {
+        const candidate = rankedIcon(applicationId, file);
+
+        if (candidate === null) {
+            continue;
         }
+
+        best = largerIcon(best, candidate);
     }
 
-    return best;
+    return best?.file;
 };
 
 const rootIconFor = (payload: DeployPayload): { rel: string; abs: string } => {
     const { applicationId } = payload.settings;
-    const names = new Set(ICON_EXTENSIONS.map((extension) => `${applicationId}${extension}`));
-    const icon = largestIcon(payload.stage.filter((file) => names.has(file.rel.split("/").at(-1) ?? "")));
+    const icon = largestIcon(applicationId, payload.stage);
 
     if (icon === undefined) {
         throw new Error(`Cannot build an AppImage without a ${applicationId} icon in the staged icon tree`);
     }
 
-    return { rel: icon.rel.split("/").at(-1) ?? "", abs: icon.abs };
+    return { rel: basename(icon.rel), abs: icon.abs };
 };
 
 const buildAppDir = (payload: DeployPayload): string => {

package/src/deploy/targets/flatpak-manifest.ts

@@ -110,6 +110,12 @@ const runtimeKeys = (settings: DeploySettings): FlatpakManifest => {
     };
 };
 
+const runtimeLabelFor = (settings: DeploySettings): string => {
+    const flatpak = settings.deploy.flatpak ?? {};
+
+    return `${flatpak.runtime ?? DEFAULT_RUNTIME}//${flatpak.runtimeVersion ?? DEFAULT_RUNTIME_VERSION}`;
+};
+
 const renderFlatpakManifest = (payload: DeployPayload): FlatpakManifest => {
     const settings = payload.settings;
 
@@ -123,4 +129,4 @@ const renderFlatpakManifest = (payload: DeployPayload): FlatpakManifest => {
     };
 };
 
-export { branchFor, finishArgsFor, hasDisplaySocket, renderFlatpakManifest };
+export { branchFor, finishArgsFor, hasDisplaySocket, renderFlatpakManifest, runtimeLabelFor };

package/src/deploy/targets/flatpak-source.ts

@@ -1,12 +1,10 @@
-import { existsSync, realpathSync } from "node:fs";
+import { existsSync, readFileSync, realpathSync } from "node:fs";
 import { posix, relative, resolve } from "node:path";
 import type { DeployPayload, DeploySettings } from "../types.js";
+import { LOCALE_DIRNAME } from "../../i18n/catalogs.js";
 import { listFilesRecursive } from "../../internal/list-files.js";
 import { BUNDLE_FILENAME } from "../../vite-plugins/esm-extension.js";
 import { renderDbusService } from "../freedesktop/dbus-service.js";
-import { renderDesktopEntry } from "../freedesktop/desktop-entry.js";
-import { renderMetainfo } from "../freedesktop/metainfo.js";
-import { renderMimePackage } from "../freedesktop/mime-package.js";
 import { optional } from "../nfpm/optional.js";
 import { renderNotices } from "../notices/render.js";
 import { executableModeFor } from "../payload/copy-tree.js";
@@ -60,6 +58,7 @@ const installCommand = (source: string, destination: string, mode: string): stri
 
 const runtimeInstallCommands = (settings: DeploySettings, nodeExtensionPath: string): string[] => {
     const lib = `${DESTINATION}/lib/${settings.binaryName}`;
+    const locale = `${DESTINATION}/share/${LOCALE_DIRNAME}`;
 
     return [
         installCommand(`${nodeExtensionPath}/bin/node`, `${lib}/node`, "m755"),
@@ -69,6 +68,7 @@ const runtimeInstallCommands = (settings: DeploySettings, nodeExtensionPath: str
         "test ! -f dist/gschemas.compiled || " +
         installCommand("dist/gschemas.compiled", `${lib}/gschemas.compiled`, "m644"),
         `test ! -d dist/assets || cp -a dist/assets ${lib}/assets`,
+        `test ! -d dist/${LOCALE_DIRNAME} || { mkdir -p ${locale} && cp -a dist/${LOCALE_DIRNAME}/. ${locale}/; }`,
         installCommand(LAUNCHER_FILENAME, `${DESTINATION}/bin/${settings.binaryName}`, "m755"),
     ];
 };
@@ -87,10 +87,35 @@ const activationInstallCommands = (settings: DeploySettings): string[] =>
             )]
         : [];
 
-const mimeSources = (settings: DeploySettings): FlatpakModule[] => {
-    const contents = renderMimePackage(settings);
+const stagedContents = (payload: DeployPayload, destination: string): string => {
+    const file = payload.stage.find((candidate) => candidate.rel === destination);
 
-    return contents === null ? [] : [inlineSource(`${settings.applicationId}.xml`, contents)];
+    if (file === undefined) {
+        throw new Error(`Cannot render the source Flatpak: ${destination} was not staged`);
+    }
+
+    return readFileSync(file.abs, "utf8");
+};
+
+const stagedMetadataSources = (payload: DeployPayload): FlatpakModule[] => {
+    const settings = payload.settings;
+
+    return [
+        inlineSource(
+            `${settings.applicationId}.desktop`,
+            stagedContents(payload, posix.join("share", "applications", `${settings.applicationId}.desktop`)),
+        ),
+        inlineSource(
+            `${settings.applicationId}.metainfo.xml`,
+            stagedContents(payload, posix.join("share", "metainfo", `${settings.applicationId}.metainfo.xml`)),
+        ),
+        ...(settings.fileAssociations.length === 0
+            ? []
+            : [inlineSource(
+                    `${settings.applicationId}.xml`,
+                    stagedContents(payload, posix.join("share", "mime", "packages", `${settings.applicationId}.xml`)),
+                )]),
+    ];
 };
 
 const mimeInstallCommands = (settings: DeploySettings): string[] =>
@@ -120,12 +145,11 @@ const metadataInstallCommands = (settings: DeploySettings): string[] => [
 const schemaInstallCommands = (settings: DeploySettings): string[] =>
     settings.paths.schemaFiles.map((file) => {
         const name = posix.basename(file);
+        const source = projectRelative(settings, file);
+        const destination = `${DESTINATION}/share/glib-2.0/schemas/${shellArgument(name)}`;
+        assertInsideProject(settings, { destination, source, resolved: file });
 
-        return installCommand(
-            projectRelative(settings, file),
-            `${DESTINATION}/share/glib-2.0/schemas/${shellArgument(name)}`,
-            "m644",
-        );
+        return installCommand(source, destination, "m644");
     });
 
 const iconInstallCommand = (settings: DeploySettings, source: string, rel: string): string =>
@@ -136,17 +160,17 @@ const iconInstallCommand = (settings: DeploySettings, source: string, rel: strin
     );
 
 const iconInstallCommands = (settings: DeploySettings): string[] => {
-    const { iconsDir, iconFile } = settings.paths;
+    const source = settings.paths.applicationIcon;
 
-    if (iconFile !== null) {
-        return [iconInstallCommand(settings, iconFile, iconPathFor(settings, iconFile))];
+    if (source.kind === "file") {
+        return [iconInstallCommand(settings, source.path, iconPathFor(settings, source.path))];
     }
 
-    if (iconsDir === null) {
+    if (source.kind === "none") {
         return [];
     }
 
-    return listFilesRecursive(iconsDir).map((icon) => iconInstallCommand(settings, icon.absPath, icon.rel));
+    return listFilesRecursive(source.path).map((icon) => iconInstallCommand(settings, icon.absPath, icon.rel));
 };
 
 const assertInsideProject = (settings: DeploySettings, installed: InstalledFile): void => {
@@ -240,9 +264,7 @@ const flatpakSourceModule = (payload: DeployPayload): FlatpakModule => {
             resolveGitSource(settings),
             ...(pin === null ? [] : pnpmSources(pin, moduleDirFor(settings))),
             GENERATED_SOURCES,
-            inlineSource(`${settings.applicationId}.desktop`, renderDesktopEntry(settings)),
-            inlineSource(`${settings.applicationId}.metainfo.xml`, renderMetainfo(settings)),
-            ...mimeSources(settings),
+            ...stagedMetadataSources(payload),
             inlineSource(LAUNCHER_FILENAME, renderLauncher(settings)),
             inlineSource(NOTICES_FILENAME, renderNotices(settings, payload.notices)),
             ...activationSource(settings),

package/src/deploy/tools.ts

@@ -56,6 +56,36 @@ const FLATPAK_NODE_GENERATOR_PNPM: DeployTool = {
     isPresent: () => hasGeneratorPnpmSupport(),
 };
 
+const MSGFMT: DeployTool = {
+    command: "msgfmt",
+    purpose: "compiles the gettext catalogs and localized metadata",
+    isOptional: false,
+};
+
+const MSGGREP: DeployTool = {
+    command: "msggrep",
+    purpose: "retains generated metadata while refreshing the catalog template",
+    isOptional: false,
+};
+
+const MSGINIT: DeployTool = {
+    command: "msginit",
+    purpose: "initializes newly listed gettext catalogs",
+    isOptional: false,
+};
+
+const MSGMERGE: DeployTool = {
+    command: "msgmerge",
+    purpose: "synchronizes translations with the catalog template",
+    isOptional: false,
+};
+
+const XGETTEXT: DeployTool = {
+    command: "xgettext",
+    purpose: "extracts the gettext catalog template",
+    isOptional: false,
+};
+
 const STRIP: DeployTool = {
     command: "strip",
     purpose: "would shrink the bundled Node.js by removing its symbols",
@@ -149,8 +179,13 @@ export {
     FILE_TOOL,
     FLATPAK,
     FLATPAK_BUILDER,
+    MSGFMT,
+    MSGGREP,
+    MSGINIT,
+    MSGMERGE,
     probeTools,
     STRIP,
     TAR,
     warnMissingOptional,
+    XGETTEXT,
 };

package/src/deploy/types.ts

@@ -1,4 +1,5 @@
 import type { Config } from "@gtkx/config";
+import type { ResolvedApplicationIcon } from "../internal/icon-path.js";
 
 type DeployConfig = NonNullable<Config["deploy"]>;
 type DeployTargetName = NonNullable<DeployConfig["targets"]>[number];
@@ -21,7 +22,7 @@ type NodeRuntime = {
     path: string;
     licenseFile: string | null;
     version: string;
-    glibcFloor: string | null;
+    glibcMinimum: string | null;
     isStripped: boolean;
 };
 
@@ -106,9 +107,7 @@ type DeployPaths = {
     overlay: string;
     targets: string;
     output: string;
-    dataDir: string | null;
-    iconsDir: string | null;
-    iconFile: string | null;
+    applicationIcon: ResolvedApplicationIcon;
     licenseFile: string | null;
     schemaFiles: string[];
 };
@@ -145,6 +144,7 @@ type DeploySettings = {
     arch: DeployArch;
     paths: DeployPaths;
     libraries: string[];
+    minimumLibraryVersions: Record<string, string>;
     deploy: DeployConfig;
 };
 

package/src/dev/icon-dir.ts

@@ -1,18 +1,42 @@
-import { existsSync } from "node:fs";
-import { join } from "node:path";
+import { mkdirSync, symlinkSync } from "node:fs";
+import { dirname, join } from "node:path";
+import {
+    relativeIconPath,
+    resolveApplicationIcon,
+    type ResolvedApplicationIcon,
+} from "../internal/icon-path.js";
+import { createRetainedStagingDir } from "../internal/staging-dir.js";
 import { prependXdgDataDir } from "../internal/xdg-data-dirs.js";
 
-const prepareDevIconDir = (root: string, dataDir: string | null): string | null => {
-    if (dataDir === null) {
-        return null;
+const stageIconSource = (shareDir: string, applicationId: string, source: ResolvedApplicationIcon): void => {
+    if (source.kind === "theme") {
+        symlinkSync(source.path, join(shareDir, "icons"), "dir");
+
+        return;
+    }
+
+    if (source.kind === "none") {
+        return;
     }
 
-    const shareDir = join(root, dataDir);
+    const target = join(shareDir, "icons", relativeIconPath(applicationId, source.path));
+    mkdirSync(dirname(target), { recursive: true });
+    symlinkSync(source.path, target, "file");
+};
+
+const prepareDevIconDir = (
+    root: string,
+    applicationId: string,
+    configured: string | undefined,
+): string | null => {
+    const source = resolveApplicationIcon(root, applicationId, configured);
 
-    if (!existsSync(join(shareDir, "icons"))) {
+    if (source.kind === "none") {
         return null;
     }
 
+    const shareDir = createRetainedStagingDir("icons").retain();
+    stageIconSource(shareDir, applicationId, source);
     process.env.XDG_DATA_DIRS = prependXdgDataDir(shareDir, process.env.XDG_DATA_DIRS);
 
     return shareDir;

package/src/dev/locale-dir.ts

@@ -0,0 +1,22 @@
+import { compileCatalogs, resolveCatalogProject, synchronizeCatalogs } from "../i18n/catalogs.js";
+import { createRetainedStagingDir } from "../internal/staging-dir.js";
+
+const LOCALE_DIR_ENV = "GTKX_LOCALE_DIR";
+const localeDir = createRetainedStagingDir("locale");
+
+const prepareDevLocaleDir = (root: string, domain: string): string | null => {
+    const project = resolveCatalogProject(root, domain);
+
+    if (project === null) {
+        return null;
+    }
+
+    const outputDir = localeDir.retain();
+    synchronizeCatalogs(project);
+    compileCatalogs(project, outputDir);
+    process.env[LOCALE_DIR_ENV] = outputDir;
+
+    return outputDir;
+};
+
+export { prepareDevLocaleDir };

package/src/dev/runner-deps.ts

@@ -86,7 +86,11 @@ const defaultDevRunnerDeps = (): DevRunnerDeps => ({
     isRefreshBoundary,
     staleExportName,
     readFileRevision,
-    plugins: () => [...gtkxVitePlugins(DEV_MODE), ...gtkxFastRefresh(), gtkxReactDomPrebundle()],
+    plugins: (entryPath) => [
+        ...gtkxVitePlugins(DEV_MODE, entryPath),
+        ...gtkxFastRefresh(),
+        gtkxReactDomPrebundle(),
+    ],
     log: info,
     exit: (code: number): never => process.exit(code),
 });

package/src/dev/runner-main.ts

@@ -1,8 +1,9 @@
+import { loadConfig } from "@gtkx/config";
 import { error } from "@gtkx/utils";
 import { resolve } from "node:path";
-import { resolveDataDir } from "../internal/data-dir.js";
 import { DEV_ENTRY_ENV } from "./entry-env.js";
 import { prepareDevIconDir } from "./icon-dir.js";
+import { prepareDevLocaleDir } from "./locale-dir.js";
 import { createDevRunner } from "./runner.js";
 import { prepareDevSchemaDir } from "./schema-dir.js";
 
@@ -21,9 +22,10 @@ const main = async (): Promise<void> => {
         process.exit(1);
     }
 
-    const dataDir = resolveDataDir(cwd);
-    prepareDevSchemaDir(cwd, dataDir);
-    prepareDevIconDir(cwd, dataDir);
+    const { config, root } = await loadConfig(cwd, { mode: "development" });
+    prepareDevLocaleDir(root, config.applicationId);
+    prepareDevSchemaDir(root, config.future?.v2ResourceImports === true);
+    prepareDevIconDir(root, config.applicationId, config.applicationIcon);
     const entryPath = resolve(cwd, entryArg);
     const { defaultDevRunnerDeps } = await import("./runner-deps.js");
     const runner = createDevRunner(defaultDevRunnerDeps());

package/src/dev/runner.ts

@@ -1,6 +1,7 @@
 import type { ApplicationInstance } from "@gtkx/runtime/internal";
 import type { InlineConfig, Plugin } from "vite";
 import { error, warn } from "@gtkx/utils";
+import { isCatalogSource } from "../i18n/catalogs.js";
 import { loadModuleExclusively, withExclusiveLoad } from "../internal/module-loads.js";
 import { createChangeQueue, type WatchedChange } from "./change-queue.js";
 import { createFailureTracker, type FailureTracker } from "./failure-tracker.js";
@@ -32,7 +33,7 @@ type DevRunnerDeps = {
     isRefreshBoundary(module: Record<string, unknown>): boolean;
     staleExportName(previous: Record<string, unknown>, current: Record<string, unknown>): string | null;
     readFileRevision(path: string): Promise<string>;
-    plugins(): Plugin[];
+    plugins(entryPath: string): Plugin[];
     log(message: string): void;
     exit(code: number): never;
 };
@@ -374,6 +375,13 @@ const applyChange = async (session: DevSession, change: WatchedChange): Promise<
         return;
     }
 
+    if (isCatalogSource(session.server.config.root, change.path)) {
+        session.deps.log(`Translation catalog changed: ${change.path}`);
+        await requestRestart(session);
+
+        return;
+    }
+
     if (isServerConfigFile(session.server.config, change.path)) {
         await restartForServerConfig(session, change.path);
 
@@ -602,7 +610,7 @@ const createSession = (server: DevServer, deps: DevRunnerDeps): DevSession => {
 
 const createDevRunner = (deps: DevRunnerDeps): DevRunner => ({
     async run(entryPath: string): Promise<void> {
-        const server = await deps.createServer(createDevServerConfig(process.cwd(), deps.plugins()));
+        const server = await deps.createServer(createDevServerConfig(process.cwd(), deps.plugins(entryPath)));
         const session = createSession(server, deps);
         deps.installShutdownHandlers(onShutdownSignal(session));
 

package/src/dev/schema-dir.ts

@@ -1,6 +1,8 @@
+import { resolveDataDir } from "../internal/data-dir.js";
 import { prependSchemaDir, stageAndCompileProjectSchemas } from "../settings/schema.js";
 
-const prepareDevSchemaDir = (root: string, dataDir: string | null): string | null => {
+const prepareDevSchemaDir = (root: string, isV2ResourceImports: boolean): string | null => {
+    const dataDir = isV2ResourceImports ? null : resolveDataDir(root);
     const dir = stageAndCompileProjectSchemas(root, dataDir);
 
     if (dir === null) {

package/src/dev/vite-dev-server.ts

@@ -20,6 +20,7 @@ type DevServerConfig = {
     configFileDependencies: string[];
     envDir: string | false;
     mode: string;
+    root: string;
 };
 
 type DevServer = {