dsh-featherhunter-plugin-base 0.0.1 → 0.0.2-drill

package/dist/node/renderers.d.ts

@@ -0,0 +1,48 @@
+import type { Group, Manifest } from "../core/types";
+import type { BlockRenderOptions } from "./types";
+/** jsDelivr base of the published data package (exact-version images). */
+export declare const DEFAULT_CDN_BASE = "https://cdn.jsdelivr.net/npm/dsh-featherhunter-plugin-base";
+/** Whole-card image width used by the README contact table (spec rule 9). */
+export declare const CONTACT_CARD_WIDTH = 260;
+/** Fixed wording of the contact block, independent of the group data. */
+export declare const CONTACT_TEXT: {
+    readonly sub: "CONNECT";
+    readonly heading: {
+        readonly zh: "反馈与联系";
+        readonly en: "Feedback and Contact";
+    };
+    readonly welcome: {
+        readonly zh: "👏欢迎提交PR、ISSUE。星星之火可以燎原🔥有任何建议、意见、想法、吐槽、idea都可以进群交流。";
+        readonly en: "👏Welcome PRs and issues. A single spark can start a prairie fire 🔥. Any suggestion, opinion, idea or rant — come join the group and talk.";
+    };
+};
+/**
+ * Cache-busting date for a limited-time card (`YYYYMMDD`), or null for a
+ * permanent card.
+ *
+ * A card counts as limited-time when the manifest marks it with `validUntil`
+ * or the published file name carries a `YYYY-MM-DD` date. The date in the
+ * file name wins; otherwise the manifest `updatedAt` date is used, because
+ * GitHub's camo proxy caches images by URL and a new QR code must get a new
+ * URL.
+ */
+export declare function contactCardCacheDate(group: Group, manifest: Manifest): string | null;
+/**
+ * Absolute pristine CDN URL of one published card image.
+ *
+ * Shape: `<cdnBase>@<manifest.version>/data/img/<card>[?v=YYYYMMDD]`. The
+ * base must be an absolute https URL — README images are never relative or
+ * copied into the plugin repositories.
+ */
+export declare function contactCardUrl(group: Group, manifest: Manifest, options?: BlockRenderOptions): string;
+/**
+ * Render the README contact block content (no markers).
+ *
+ * Keeps the pre-migration structure: heading, centered wrapper, welcome line,
+ * one header row and one row of {@link CONTACT_CARD_WIDTH}-wide whole cards.
+ * Modal-only fields (`title`, `subtitle`, `note`, `qr`) never appear here.
+ *
+ * @param options data + language + image base; `variant` selects the standard
+ *   CONNECT h2 (default) or ilife's Markdown `##` heading.
+ */
+export declare function renderContactBlock(options?: BlockRenderOptions): string;

package/dist/node/types.d.ts

@@ -1,4 +1,9 @@
 import type { Lang, Manifest } from "../core/types";
+/**
+ * Heading form of a rendered block. Most repositories use an HTML <h2>
+ * heading; ilife (and the prompt MORE block) use a Markdown `##` heading.
+ */
+export type HeadingVariant = "html-heading" | "markdown-heading";
 /** Shared options for the README block renderers. */
 export interface BlockRenderOptions {
     /** Manifest to render from; defaults to the packaged baseline manifest. */
@@ -9,6 +14,8 @@ export interface BlockRenderOptions {
     lang?: Lang;
     /** CDN base URL override (tests / mirrors). */
     cdnBase?: string;
+    /** Heading form override; renderers default to their repository convention. */
+    variant?: HeadingVariant;
 }
 /** Marker names of the four managed README blocks. */
 export type BlockName = "contact" | "star-history" | "thanks" | "more";
@@ -20,11 +27,23 @@ export interface VerifyResult {
 export interface ReadmeSyncOptions {
     /** Repository roots to update. */
     roots: string[];
+    /** `init` may insert missing marker pairs; `sync` only rewrites marked text. */
+    command?: "init" | "sync";
     /** Report drift without writing. */
     check?: boolean;
-    /** Rewrite every managed block, even unchanged ones. */
+    /** Process every target root and keep going after per-file errors. */
     all?: boolean;
     dryRun?: boolean;
+    /** Manifest to render from; defaults to the packaged baseline manifest. */
+    manifest?: Manifest;
+    /** Published package version, used for precise CDN URLs. */
+    version?: string;
+    /** CDN base URL override (tests / mirrors). */
+    cdnBase?: string;
+    /** Target language override; detected from the README when omitted. */
+    lang?: Lang;
+    /** Heading form override; detected from the README when omitted. */
+    variant?: HeadingVariant;
 }
 export interface DoctorCheck {
     name: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-featherhunter-plugin-base",
-  "version": "0.0.1",
+  "version": "0.0.2-drill",
   "description": "FeatherHunter DSH plugin shared base: settings-panel contact modal / author plugins card widgets and README block renderers",
   "keywords": [
     "dsh",
@@ -51,6 +51,9 @@
     "build:data": "node scripts/run-ts.mjs build-data",
     "data:check": "node scripts/run-ts.mjs build-data --check",
     "contact:update": "node scripts/run-ts.mjs contact-update",
+    "readme:init": "node dist/node/cli.js readme:init",
+    "readme:sync": "node dist/node/cli.js readme:sync",
+    "readme:check": "node dist/node/cli.js readme:sync --check",
     "typecheck": "tsc -p tsconfig.json --noEmit",
     "test": "vitest run",
     "test:watch": "vitest",