@gjsify/cli 0.4.10 → 0.4.12

package/lib/types/config-data.d.ts

@@ -233,4 +233,197 @@ export interface ConfigDataFlatpak {
     ciContainer?: string;
     /** Branches the generated workflow triggers on. Default `['main']`. */
     ciBranches?: string[];
+    /**
+     * App kind. `'app'` (default) → desktop-application MetaInfo, GUI
+     * finish-args, .desktop + icon required. `'cli'` → console-application
+     * MetaInfo with `<provides><binary>`, no .desktop, flathub.json sets
+     * `skip-icons-check`. Supersedes the older `--cli-only` flag on
+     * `gjsify flatpak init`.
+     */
+    kind?: 'app' | 'cli';
+    /**
+     * Developer attribution required by Flathub. `id` must be reverse-DNS.
+     * `email` (optional) becomes `<email>` inside `<developer>`.
+     * `nameTranslatable: false` (default) emits `translate="no"` on the
+     * `<name>` tag — recommended for personal/brand names that should not
+     * be translated. Set to `true` if the name is a descriptive phrase
+     * that translators should localise.
+     */
+    developer?: {
+        id: string;
+        name: string;
+        email?: string;
+        nameTranslatable?: boolean;
+    };
+    /**
+     * One-line summary, ≤80 chars, no trailing period (Flathub rule).
+     * Translatable — gettext's `msgfmt --xml --template` substitutes
+     * `<summary>` from `.po` files at build time. Set
+     * `summaryTranslatorHint` to emit a `<!-- TRANSLATORS: ... -->`
+     * comment before the tag.
+     */
+    summary?: string;
+    /** Translator hint emitted as `<!-- TRANSLATORS: ... -->` before `<summary>`. */
+    summaryTranslatorHint?: string;
+    /**
+     * Long description. Two forms:
+     * - **String** — split on blank lines into `<p>` blocks. Best for
+     *   simple descriptions without bullet lists.
+     * - **Block array** — explicit blocks (`{p:..., translatorHint?:...}`
+     *   for paragraphs or `{ul:[...], translatorHint?:...}` for bullet
+     *   lists). Each block can carry its own translator hint. Use this
+     *   form when you need bullet lists or per-string translator context.
+     */
+    description?: string | DescriptionBlock[];
+    /** Project homepage URL. Recommended; required for Flathub submission. */
+    homepageUrl?: string;
+    /** Bug tracker URL. */
+    bugtrackerUrl?: string;
+    /** VCS browser URL (e.g. GitHub repo). */
+    vcsBrowserUrl?: string;
+    /** Donation URL (e.g. OpenCollective / GitHub Sponsors). */
+    donationUrl?: string;
+    /**
+     * License SPDX identifiers. `project` is the project's source license
+     * (mandatory). `metadata` is the license under which the MetaInfo XML
+     * is distributed (default `'CC0-1.0'`).
+     */
+    license?: {
+        metadata?: string;
+        project: string;
+    };
+    /**
+     * Content-rating policy. Two forms:
+     * - **String** — just the spec keyword (default `'oars-1.1'`), emits
+     *   an empty `<content_rating type="..."/>` block.
+     * - **Object** — keyword + `attributes` map. Each attribute is an
+     *   OARS key (`violence-cartoon`, `social-info`, etc.) → severity
+     *   (`none`, `mild`, `moderate`, `intense`). Flathub recommends
+     *   declaring attributes explicitly even when they're `none` so the
+     *   rating audit is auditable.
+     */
+    contentRating?: string | {
+        type?: string;
+        attributes?: Record<string, 'none' | 'mild' | 'moderate' | 'intense'>;
+    };
+    /** Freedesktop Menu categories (e.g. `['Development', 'Utility']`). */
+    categories?: string[];
+    /** Search keywords for app stores. */
+    keywords?: string[];
+    /**
+     * Release history. Most recent first. Each entry produces a
+     * `<release version=… date=…>` block. `description` accepts the
+     * same string-or-block-array shape as the top-level `description`
+     * field — use the array form for release notes with bullet lists
+     * or per-string translator hints.
+     */
+    releases?: Array<{
+        version: string;
+        date: string;
+        description?: string | DescriptionBlock[];
+    }>;
+    /**
+     * Screenshots for app-stores. `url` is an absolute HTTPS URL to a PNG.
+     * `caption` is optional and translatable — set `captionTranslatorHint`
+     * for a `<!-- TRANSLATORS: ... -->` hint. `environment` is one of
+     * `'plasma'|'gnome'|'cli'` — Flathub uses it to group by desktop.
+     * First entry defaults to `type="default"`; override with `type`.
+     */
+    screenshots?: Array<{
+        url: string;
+        caption?: string;
+        captionTranslatorHint?: string;
+        environment?: 'plasma' | 'gnome' | 'cli';
+        type?: 'default' | 'source';
+    }>;
+    /** Light/dark accent colours (hex `#rrggbb`) — emit `<branding>` block. */
+    branding?: {
+        accentLight: string;
+        accentDark: string;
+    };
+    /**
+     * Path to a scalable SVG icon. Flathub requires SVG (`/app/share/icons/
+     * hicolor/scalable/apps/<app-id>.svg`). When set, init verifies the file
+     * exists; when unset on `--kind app`, init prints a Flathub hint.
+     */
+    icon?: string;
+    /**
+     * Remote-hosted icon URL — emitted as `<icon type="remote">`. Useful
+     * for the Flathub app-store thumbnail before the local SVG ships.
+     */
+    iconRemote?: string;
+    /**
+     * Translation platform URL (Weblate, Crowdin, Transifex, etc.).
+     * Emitted as `<url type="translate">`. Set this when your app accepts
+     * community translation contributions through a hosted platform.
+     */
+    translateUrl?: string;
+    /**
+     * AppStream kudos — Flathub recognises a fixed set of "well-behaved"
+     * markers. Common values: `ModernToolkit`, `HiDpiIcon`,
+     * `TouchscreenSupport`, `UserDocs`, `HighContrast`, `Notifications`,
+     * `SearchProvider`. Full list at
+     * https://www.freedesktop.org/software/appstream/docs/sect-Metadata-DesktopApps.html#tag-dapp-kudos
+     */
+    kudos?: string[];
+    /**
+     * Things this app provides to the system. `<binary>` is auto-included
+     * with the value of `command` when omitted (apps + CLIs both need
+     * this for AppStream to register the binary correctly).
+     */
+    provides?: {
+        binaries?: string[];
+        mimetypes?: string[];
+        dbus?: Array<{
+            type: 'user' | 'system';
+            id: string;
+        }>;
+    };
+    /**
+     * Hardware controls the app supports (best-effort declaration —
+     * AppStream `<supports>`). Common values:
+     * `keyboard`, `pointing`, `touch`, `gamepad`, `tablet`, `console`,
+     * `vision`.
+     */
+    supports?: {
+        controls?: Array<'keyboard' | 'pointing' | 'touch' | 'gamepad' | 'tablet' | 'console' | 'vision'>;
+        /** Internet connectivity requirement. */
+        internet?: 'always' | 'offline-only' | 'first-run';
+    };
+    /**
+     * Hard requirements — AppStream `<requires>`. App won't function
+     * without these. `displayLengthMin` is the minimum display length in
+     * pixels (logical units) — typical phone-portrait minimum is 360.
+     */
+    requires?: {
+        displayLengthMin?: number;
+        internet?: 'always' | 'offline-only' | 'first-run';
+        controls?: Array<'keyboard' | 'pointing' | 'touch' | 'gamepad' | 'tablet' | 'console'>;
+    };
+    /**
+     * Soft recommendations — AppStream `<recommends>`. App works better
+     * with these but functions without them. `displayLengthMin` typical
+     * tablet-min recommendation is 480.
+     */
+    recommends?: {
+        displayLengthMin?: number;
+        controls?: Array<'keyboard' | 'pointing' | 'touch' | 'gamepad' | 'tablet' | 'console'>;
+    };
 }
+/**
+ * A single block inside a MetaInfo `<description>`. Either a paragraph
+ * (`{p}`) or a bullet list (`{ul}`). Each block can carry an optional
+ * `translatorHint` that becomes a `<!-- TRANSLATORS: ... -->` comment
+ * before the block in the emitted `.metainfo.xml.in` template — gives
+ * translators context when the string lands in their `.po` file.
+ */
+export type DescriptionBlock = {
+    p: string;
+    translatorHint?: string;
+} | {
+    ul: Array<string | {
+        item: string;
+        translatorHint?: string;
+    }>;
+    translatorHint?: string;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@gjsify/cli",
-    "version": "0.4.10",
+    "version": "0.4.12",
     "description": "CLI for Gjsify",
     "type": "module",
     "main": "lib/index.js",
@@ -23,7 +23,7 @@
         "clear": "rm -rf lib dist tsconfig.tsbuildinfo || exit 0",
         "check": "tsc --noEmit",
         "start": "node lib/index.js",
-        "build": "tsc && mkdir -p lib/templates && cp -L src/templates/install.mjs.tmpl lib/templates/install.mjs.tmpl && gjsify run chmod",
+        "build": "tsc && mkdir -p lib/templates/flatpak && cp -L src/templates/install.mjs.tmpl lib/templates/install.mjs.tmpl && cp src/templates/flatpak/*.tmpl lib/templates/flatpak/ && gjsify run chmod",
         "build:gjs-bundle": "node lib/index.js build src/index.ts --app gjs --outfile dist/cli.gjs.mjs --shebang",
         "chmod": "chmod +x ./lib/index.js",
         "build:test:node": "node lib/index.js build src/test.mts --app node --outfile dist/test.node.mjs",
@@ -37,18 +37,18 @@
         "cli"
     ],
     "dependencies": {
-        "@gjsify/buffer": "^0.4.10",
-        "@gjsify/create-app": "^0.4.10",
-        "@gjsify/node-globals": "^0.4.10",
-        "@gjsify/node-polyfills": "^0.4.10",
-        "@gjsify/npm-registry": "^0.4.10",
-        "@gjsify/resolve-npm": "^0.4.10",
-        "@gjsify/rolldown-plugin-gjsify": "^0.4.10",
-        "@gjsify/rolldown-plugin-pnp": "^0.4.10",
-        "@gjsify/semver": "^0.4.10",
-        "@gjsify/tar": "^0.4.10",
-        "@gjsify/web-polyfills": "^0.4.10",
-        "@gjsify/workspace": "^0.4.10",
+        "@gjsify/buffer": "^0.4.12",
+        "@gjsify/create-app": "^0.4.12",
+        "@gjsify/node-globals": "^0.4.12",
+        "@gjsify/node-polyfills": "^0.4.12",
+        "@gjsify/npm-registry": "^0.4.12",
+        "@gjsify/resolve-npm": "^0.4.12",
+        "@gjsify/rolldown-plugin-gjsify": "^0.4.12",
+        "@gjsify/rolldown-plugin-pnp": "^0.4.12",
+        "@gjsify/semver": "^0.4.12",
+        "@gjsify/tar": "^0.4.12",
+        "@gjsify/web-polyfills": "^0.4.12",
+        "@gjsify/workspace": "^0.4.12",
         "cosmiconfig": "^9.0.1",
         "get-tsconfig": "^4.14.0",
         "pkg-types": "^2.3.1",
@@ -56,12 +56,12 @@
         "yargs": "^18.0.0"
     },
     "devDependencies": {
-        "@gjsify/unit": "^0.4.10",
+        "@gjsify/unit": "^0.4.12",
         "@types/yargs": "^17.0.35",
         "typescript": "^6.0.3"
     },
     "peerDependencies": {
-        "@gjsify/rolldown-native": "^0.4.10"
+        "@gjsify/rolldown-native": "^0.4.12"
     },
     "peerDependenciesMeta": {
         "@gjsify/rolldown-native": {