@gjsify/cli 0.49.0 → 0.51.0

package/lib/utils/ship/plan.js

@@ -3,7 +3,7 @@
 // as `utils/copy-targets.ts`, and for the same reason: a stager that discovers
 // its own inputs can only be tested by building a real project.
 import { renderDebianChangelog } from './changelog.js';
-import { gzipDeterministic } from './gzip.js';
+import { gzipDeterministic, POLICY_MAX_COMPRESSION } from './gzip.js';
 import { renderMimePackage } from './mime.js';
 import { SHARE } from './share-dirs.js';
 import { basename, extname, posix } from 'node:path';
@@ -174,12 +174,19 @@ export async function planOverlay(settings, format, inputs) {
     // gzip performed on the packing host would put a second compressor's output in
     // an artifact whose every other byte came from the first. `gzipDeterministic`
     // zeroes the header stamp for the usual reason (utils/ship/gzip.ts).
+    //
+    // It is also the one gzip member in the artifact whose bytes cannot vary with
+    // the packing host, for the same reason: the two hosts' zlibs disagree (that
+    // file's header measurement), and this member is compressed once, here.
     if (format.changelogDest !== undefined) {
         const changelog = renderDebianChangelog(settings, inputs.changelogText, inputs.mtime);
         files.push({
             path: format.changelogDest(settings.binaryName),
             mode: 0o644,
-            source: { kind: 'bytes', data: await gzipDeterministic(new TextEncoder().encode(changelog)) },
+            source: {
+                kind: 'bytes',
+                data: await gzipDeterministic(new TextEncoder().encode(changelog), POLICY_MAX_COMPRESSION),
+            },
         });
     }
     return files;
@@ -233,19 +240,27 @@ function renderDebianCopyright(settings, licenseText) {
  * Icons land in the hicolor theme, named after the app id — that name is what
  * the desktop entry's `Icon=` and the MetaInfo `<id>` both point at, so a file
  * keeping its source basename installs an icon nothing ever looks up.
+ *
+ * A SYMBOLIC icon keeps the `-symbolic` half of that name, and for the same
+ * reason rather than as an exception: the name GTK resolves a symbolic icon by
+ * is `<app id>-symbolic`, so renaming the file to the bare id installs an icon
+ * nothing ever looks up — one sentence, applied to both lookups.
  */
 function planIcons(settings) {
     const out = [];
     const seen = new Map();
     for (const icon of settings.iconFiles) {
         const ext = extname(icon);
-        const dir = iconSizeDir(icon);
-        const path = `${SHARE.icons}/${dir}/apps/${settings.appId}${ext}`;
+        const dir = iconThemeDir(icon);
+        const name = isSymbolicIcon(icon) ? `${settings.appId}-symbolic` : settings.appId;
+        const path = `${SHARE.icons}/${dir}/apps/${name}${ext}`;
         const previous = seen.get(path);
         if (previous !== undefined) {
             throw new Error(`gjsify ship: ${icon} and ${previous} both install as ${path}. ` +
-                'Icon size is read from the path (`.../128x128/...`) or the filename (`icon-128.png`); ' +
-                'give them distinguishable sizes or point `gjsify.ship.icon` at a single file.');
+                'An icon is keyed on its context and its size: `symbolic` is read from a `symbolic/` ' +
+                'path component or a `-symbolic` filename, the size from the path (`.../128x128/...`) ' +
+                'or the filename (`icon-128.png`). Give them distinguishable sizes, or point ' +
+                '`gjsify.ship.icon` at a single file.');
         }
         seen.set(path, icon);
         out.push({ path, mode: 0o644, source: { kind: 'file', path: icon } });
@@ -253,11 +268,47 @@ function planIcons(settings) {
     return out;
 }
 /**
- * The hicolor subdirectory for an icon: `scalable` for SVG, otherwise the
- * pixel size read from a `<n>x<n>` path component or a trailing number in the
- * filename.
+ * Whether an icon belongs in the theme's SYMBOLIC context rather than at a size.
+ *
+ * `symbolic` is a directory of its own in a hicolor theme and NOT a size value.
+ * Measured in `refs/adwaita-icon-theme/index.theme`, which lists `symbolic/apps`
+ * in `Directories=` beside `scalable/apps` and `16x16/apps` and gives it its own
+ * section — `Context=Applications`, `Size=16`, `MinSize=8`, `MaxSize=512`,
+ * `Type=Scalable` — against the scalable row's `Size=128`. The freedesktop icon
+ * theme specification has no notion of `symbolic` at all: a theme expresses it by
+ * giving the directory a section, which is exactly why reading the EXTENSION
+ * cannot see it, and why this question has to be asked before the size one.
+ *
+ * TWO SIGNALS, the same pair `iconThemeDir` already reads for a size: the
+ * directory an author put the file in, and the name they gave it. GTK resolves a
+ * symbolic icon by the `-symbolic` name suffix, so an author who wrote the name
+ * has said as much as one who wrote the path.
+ *
+ * SVG ONLY, because the symbolic directory is declared `Type=Scalable`: the
+ * raster form GTK's own `gtk-encode-symbolic-svg` produces
+ * (`<name>-symbolic.symbolic.png`) is installed at a SIZE instead. So a PNG keeps
+ * answering the size question, and one that cannot answer it stays refused rather
+ * than quietly becoming a scalable icon that does not scale.
+ */
+export function isSymbolicIcon(iconPath) {
+    if (extname(iconPath).toLowerCase() !== '.svg')
+        return false;
+    if (/(?:^|[\\/])symbolic[\\/]/.test(iconPath))
+        return true;
+    return basename(iconPath, extname(iconPath)).endsWith('-symbolic');
+}
+/**
+ * The hicolor subdirectory for an icon: the `symbolic` CONTEXT, else `scalable`
+ * for an SVG, else the pixel size read from a `<n>x<n>` path component or a
+ * trailing number in the filename.
+ *
+ * Named for the theme DIRECTORY rather than a size from the moment the first of
+ * those answers stopped being one: `iconSizeDir` returning `symbolic` would be a
+ * name every caller has to read past.
  */
-export function iconSizeDir(iconPath) {
+export function iconThemeDir(iconPath) {
+    if (isSymbolicIcon(iconPath))
+        return 'symbolic';
     if (extname(iconPath).toLowerCase() === '.svg')
         return 'scalable';
     const square = /(?:^|[\\/])(\d{1,4})x\1(?:[\\/]|$)/.exec(iconPath);

package/lib/utils/ship/settings.d.ts

@@ -144,6 +144,20 @@ export interface ResolvedSettings {
     metadata: AppMetadata;
     warnings: string[];
 }
+/**
+ * `gjsify.ship.kind`, falling back to `gjsify.flatpak`'s and then to `'app'`.
+ *
+ * LIFTED OUT because a second caller appeared BEFORE this file runs: `ship`
+ * refuses a `kind: 'cli'` project asking for a format whose container needs a
+ * desktop entry, and it does that ahead of the project's build, where
+ * `resolveShipSettings` has not run and its `discovered` input does not exist
+ * yet. The fallback chain is `{ ...flatpak, ...definedOnly(ship) }`'s for exactly
+ * this key, and a second spelling of it is the kind that stays right until
+ * somebody changes the first one — here with the artifact-shaped consequence that
+ * a project would be refused before the build for a `kind` the stage then
+ * resolves differently.
+ */
+export declare function resolveShipKind(ship: ConfigDataShip, flatpak: ConfigDataFlatpak): 'app' | 'cli';
 export declare function resolveShipSettings(input: SettingsInput): ResolvedSettings;
 /** The entry one ship target installs, which key named it, and what it must NOT carry. */
 export interface ResolvedShipBundle {

package/lib/utils/ship/settings.js

@@ -111,6 +111,22 @@ const CATEGORY_SECTIONS = [
     ['System', { section: 'admin', group: 'Applications/System' }],
     ['Utility', { section: 'utils', group: 'Applications/System' }],
 ];
+/**
+ * `gjsify.ship.kind`, falling back to `gjsify.flatpak`'s and then to `'app'`.
+ *
+ * LIFTED OUT because a second caller appeared BEFORE this file runs: `ship`
+ * refuses a `kind: 'cli'` project asking for a format whose container needs a
+ * desktop entry, and it does that ahead of the project's build, where
+ * `resolveShipSettings` has not run and its `discovered` input does not exist
+ * yet. The fallback chain is `{ ...flatpak, ...definedOnly(ship) }`'s for exactly
+ * this key, and a second spelling of it is the kind that stays right until
+ * somebody changes the first one — here with the artifact-shaped consequence that
+ * a project would be refused before the build for a `kind` the stage then
+ * resolves differently.
+ */
+export function resolveShipKind(ship, flatpak) {
+    return ship.kind ?? flatpak.kind ?? 'app';
+}
 export function resolveShipSettings(input) {
     const warnings = [];
     const { pkg, ship, flatpak, discovered } = input;
@@ -132,7 +148,9 @@ export function resolveShipSettings(input) {
     const binaryName = ship.binaryName ?? deriveBinaryName(pkg.name);
     const appId = ship.appId ?? flatpak.appId ?? reverseDnsOrThrow(pkg.name, binaryName);
     const name = metadata.name ?? titleCase(binaryName);
-    const kind = metadata.kind ?? 'app';
+    // Through the shared resolver, so the PRE-BUILD gate and this function cannot
+    // answer "is this a GUI application" differently — see {@link resolveShipKind}.
+    const kind = resolveShipKind(ship, flatpak);
     // NOT resolved here: `resolveShipApp` already did, before the format list was
     // decided from it. A second defaulting rule in this function would be the
     // second path those two answers could come apart on.

package/lib/utils/ship/types.d.ts

@@ -61,7 +61,7 @@ export interface ShipArtifact {
  * TEXTUALLY and fails if a comment gives it a second match, which is why this one
  * describes the union without quoting its head.
  */
-export type FormatId = 'deb' | 'rpm' | 'flatpak' | 'macos-app' | 'macos-app-zip' | 'macos-app-dmg' | 'windows-dir' | 'windows-dir-zip' | 'msi';
+export type FormatId = 'deb' | 'rpm' | 'flatpak' | 'appimage' | 'macos-app' | 'macos-app-zip' | 'macos-app-dmg' | 'windows-dir' | 'windows-dir-zip' | 'msi';
 /**
  * The formats whose ARTIFACT carries a distro dependency list.
  *
@@ -264,6 +264,22 @@ export interface FormatDescriptor {
      * makes this a property of the CONTAINER rather than "macOS is special".
      */
     artifactKind: 'file' | 'directory';
+    /**
+     * This container cannot hold a `kind: 'cli'` project at all.
+     *
+     * A ROW'S FACT, so the refusal fires BEFORE the project's build like
+     * `assertCanPack`'s two do, and for the identical reason: `gjsify.ship.kind`
+     * is configuration, so the answer is knowable up front and discovering it
+     * after `runProjectBuild` costs the whole build for a refusal nothing learned
+     * from building. `appimage` is the only row that sets it — appimagetool
+     * refuses an AppDir with no `.desktop` at its root, and a CLI project stages
+     * none by design. A `.deb`, an `.rpm` and a Flatpak all ship a CLI perfectly.
+     *
+     * NOT the same question as the ICON half of `assertAppImageIsPackable`, which
+     * stays on the pack path: an icon is DISCOVERED, and discovery legitimately
+     * reads files the build produces.
+     */
+    requiresDesktopEntry?: true;
 }
 /** One shared-mime-info type definition (`gjsify.ship.mimeTypes`). */
 export interface ShipMimeType {

package/lib/utils/simple-command.d.ts

@@ -1,3 +1,18 @@
+export interface TokenizeOptions {
+    /**
+     * Accept an unquoted `*`/`?` as an ordinary token character.
+     *
+     * Off by default, and the default is about EXECUTION: a caller that RUNS
+     * the tokens must not pass `*.tsbuildinfo` through unexpanded, because the
+     * shell it replaces would have expanded it first. A caller that only READS
+     * the targets — `utils/package-inputs.ts`, asking which paths a package
+     * declares it produces — wants the pattern itself, and `gjsify clear`
+     * expands the same two characters in its own last segment anyway
+     * (`utils/clear-targets.ts`). Nothing else moves: every operator,
+     * substitution, brace and tilde still returns `null`.
+     */
+    allowGlobs?: boolean;
+}
 /**
  * Tokenize `cmd`, or return `null` if the string contains anything the shell
  * would treat specially — operators (`&& | ; < > &`), substitutions (`$(...)` /
@@ -7,10 +22,10 @@
  * single literal token, exactly as the shell would hand it to `gjsify` (which
  * does its own glob expansion).
  */
-export declare function tokenizeSimpleCommand(cmd: string): string[] | null;
+export declare function tokenizeSimpleCommand(cmd: string, options?: TokenizeOptions): string[] | null;
 /**
  * The argv of a script that is a single `gjsify <subcommand> …` command — i.e.
  * the tokens after `gjsify` — or `null` when it is anything else. `null` is the
  * signal to hand the literal to a shell.
  */
-export declare function gjsifyCommandArgv(literal: string): string[] | null;
+export declare function gjsifyCommandArgv(literal: string, options?: TokenizeOptions): string[] | null;

package/lib/utils/simple-command.js

@@ -6,6 +6,10 @@
 // deliberately conservative in ONE direction — a `null` costs the caller its
 // fast path, a wrong token list would run a different command than the script
 // says.
+/** Characters that make a string something only a shell may execute. */
+const SHELL_SPECIAL = '|&;<>`$()\\\n\r*?{}[]~#!';
+/** The same set minus `*` and `?` — see {@link TokenizeOptions.allowGlobs}. */
+const SHELL_SPECIAL_ALLOWING_GLOBS = SHELL_SPECIAL.replace('*', '').replace('?', '');
 /**
  * Tokenize `cmd`, or return `null` if the string contains anything the shell
  * would treat specially — operators (`&& | ; < > &`), substitutions (`$(...)` /
@@ -15,7 +19,8 @@
  * single literal token, exactly as the shell would hand it to `gjsify` (which
  * does its own glob expansion).
  */
-export function tokenizeSimpleCommand(cmd) {
+export function tokenizeSimpleCommand(cmd, options = {}) {
+    const special = options.allowGlobs === true ? SHELL_SPECIAL_ALLOWING_GLOBS : SHELL_SPECIAL;
     const tokens = [];
     let cur = '';
     let has = false;
@@ -53,7 +58,7 @@ export function tokenizeSimpleCommand(cmd) {
             }
             continue;
         }
-        if ('|&;<>`$()\\\n\r*?{}[]~#!'.includes(c))
+        if (special.includes(c))
             return null;
         cur += c;
         has = true;
@@ -69,8 +74,8 @@ export function tokenizeSimpleCommand(cmd) {
  * the tokens after `gjsify` — or `null` when it is anything else. `null` is the
  * signal to hand the literal to a shell.
  */
-export function gjsifyCommandArgv(literal) {
-    const tokens = tokenizeSimpleCommand(literal);
+export function gjsifyCommandArgv(literal, options = {}) {
+    const tokens = tokenizeSimpleCommand(literal, options);
     if (!tokens || tokens.length < 2 || tokens[0] !== 'gjsify')
         return null;
     return tokens.slice(1);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@gjsify/cli",
-    "version": "0.49.0",
+    "version": "0.51.0",
     "description": "CLI for Gjsify",
     "type": "module",
     "main": "lib/index.js",
@@ -142,21 +142,21 @@
         "cli"
     ],
     "dependencies": {
-        "@gjsify/buffer": "^0.49.0",
-        "@gjsify/create-app": "^0.49.0",
-        "@gjsify/node-globals": "^0.49.0",
-        "@gjsify/node-polyfills": "^0.49.0",
-        "@gjsify/npm-registry": "^0.49.0",
-        "@gjsify/resolve-npm": "^0.49.0",
-        "@gjsify/rolldown-plugin-gjsify": "^0.49.0",
-        "@gjsify/vite-plugin-blueprint": "^0.49.0",
-        "@gjsify/rolldown-plugin-pnp": "^0.49.0",
-        "@gjsify/semver": "^0.49.0",
-        "@gjsify/tar": "^0.49.0",
-        "@gjsify/tsc": "^0.49.0",
-        "@gjsify/utils": "^0.49.0",
-        "@gjsify/web-polyfills": "^0.49.0",
-        "@gjsify/workspace": "^0.49.0",
+        "@gjsify/buffer": "^0.51.0",
+        "@gjsify/create-app": "^0.51.0",
+        "@gjsify/node-globals": "^0.51.0",
+        "@gjsify/node-polyfills": "^0.51.0",
+        "@gjsify/npm-registry": "^0.51.0",
+        "@gjsify/resolve-npm": "^0.51.0",
+        "@gjsify/rolldown-plugin-gjsify": "^0.51.0",
+        "@gjsify/vite-plugin-blueprint": "^0.51.0",
+        "@gjsify/rolldown-plugin-pnp": "^0.51.0",
+        "@gjsify/semver": "^0.51.0",
+        "@gjsify/tar": "^0.51.0",
+        "@gjsify/tsc": "^0.51.0",
+        "@gjsify/utils": "^0.51.0",
+        "@gjsify/web-polyfills": "^0.51.0",
+        "@gjsify/workspace": "^0.51.0",
         "acorn": "^8.17.0",
         "cosmiconfig": "^9.0.2",
         "get-tsconfig": "^4.14.0",
@@ -165,13 +165,13 @@
         "yargs": "^18.0.0"
     },
     "devDependencies": {
-        "@gjsify/unit": "^0.49.0",
+        "@gjsify/unit": "^0.51.0",
         "@types/yargs": "^17.0.35",
         "typescript": "^6.0.3"
     },
     "peerDependencies": {
-        "@gjsify/oxfmt-native": "^0.49.0",
-        "@gjsify/rolldown-native": "^0.49.0"
+        "@gjsify/oxfmt-native": "^0.51.0",
+        "@gjsify/rolldown-native": "^0.51.0"
     },
     "peerDependenciesMeta": {
         "@gjsify/oxfmt-native": {