hjj345/dsh-sm-version-display

中文文档 · English documentation

GitHub: hjj345/dsh-sm-version-display npm: @hjj345345/dsh-sm-version-display

Minimum supported DSH version: v0.1.0-rc.6 (inclusive). Current plugin version: v1.2.3.

Introduction

@hjj345345/dsh-sm-version-display is a client + host dual-half plugin for the DeepSeek Harness (DSH) Web interface. It displays the currently installed DSH version above the sidebar Settings button and checks npm and the official GitHub releases for newer DSH versions.

Since v1.1.0, the plugin also adds a first-level DSH Version Checker page in DSH Settings (order: 22, directly below the reference plugin). The page follows the reference plugin’s card-based design and includes the plugin switch, General settings, About, and Install Command sections. It supports Simplified Chinese, English, and Traditional Chinese. Results are cached for the DSH process and remain available when the settings dialog is reopened. When an update is found, the user can confirm a host-side exact-version update or open the complete manual steps.

The following names refer to different things:

• npm package: @hjj345345/dsh-sm-version-display
• DSH runtime plugin ID: dsh-sm-version-display
• GitHub repository: hjj345/dsh-sm-version-display

Plugin version v1.2.3 identifies this plugin. The version shown in the card is the DSH version read at runtime; they are not the same version.

Features

• Version card: displays a rounded version card on its own row above the sidebar Settings button.
• Runtime detection: the host half reads the installed @deepseek-ai/dsh version while rendering the page, so the card follows DSH upgrades after restart.
• Safe fallback: if the host version is temporarily unavailable, the card shows “Version unavailable” instead of guessing a fixed version.
• Update checks: checks npm and GitHub releases on page load, every 30 minutes, and when the window returns to the foreground; results are cached in the DSH process.
• GitHub rate-limit fallback: falls back to the official Releases Atom Feed when the GitHub API is rate-limited, without affecting npm checks.
• Release types: classifies GitHub versions as Alpha preview, Beta, Release Candidate, or Release.
• Semantic comparison: includes a lightweight comparator for Alpha, Beta, RC, stable, and multi-digit versions.
• Manual refresh: provides a refresh button with a loading state and a native-style DSH Toast after the check completes.
• DSH settings page: registers “DSH Version Checker” below the reference plugin sm-context-piano (order: 21), at order: 22, using DSH’s default gear icon.
• Reference-style cards: includes the plugin hero, enable switch, General settings, About, and Install Command cards.
• Three language choices: Simplified Chinese, English, and Traditional Chinese, with Simplified Chinese as the default and persisted in DSH Settings.
• Expandable check results: shows side-by-side npm and GitHub cards with versions, release types, dates, links, current installation method, and plugin manager beneath the check button.
• Two update paths: requires risk confirmation, then either runs the host-side update or opens complete commands and steps for manual execution.
• Update output: automatic updates show the command, live output, completion state, and restart reminder.
• Loopback-only update: only fixed exact-version commands run on the host; GitHub source-only releases fall back to manual build steps.
• Responsive layout: shows a round version icon in the collapsed sidebar rail and wraps text when space is limited.
• Theme aware: uses DSH design-system variables and follows light and dark themes.
• Hover tooltip: the card and collapsed-rail icon show the English plugin name dsh-sm-version-display and the current version.

Screenshots / 实际效果截图

Sidebar version card:

Collapsed sidebar hover tooltip:

Settings page overview:

Dual-source version check results:

Update confirmation dialog:

Update execution record, About section, and install command:

Example states:

vX.Y.Z (Latest)
vX.Y.Z (Update available: vA.B.C)

Installation and removal

Install from npm (recommended)

Run this on the machine where DSH is installed:

dsh plugin --profile web add @hjj345345/dsh-sm-version-display

Restart the DSH Web service or reopen the Web interface after installation:

dsh web

To remove the plugin:

dsh plugin --profile web remove @hjj345345/dsh-sm-version-display

Link a local development directory

For local development, use link: with the plugin directory. The path below is only an example; replace it with your actual path and never commit a personal machine path to the README, source, or npm package:

dsh plugin --profile web add link:C:/path/to/dsh-sm-version-display

Use local linking only for development. Switch back to the npm package for normal use.

Settings page and DSH updates

Open DSH Settings and select DSH Version Checker. Click Check DSH version to expand the npm and GitHub results directly below the button. Results remain cached for the DSH process; clicking Collapse result keeps them collapsed until DSH is restarted.

The command dialog always distinguishes npm and npx. If the host detects a pnpm global installation, it is shown first:

# npm global install
npm install --global @deepseek-ai/dsh@<version>

# npx temporary execution
npx --yes @deepseek-ai/dsh@<version> web

# pnpm global install
pnpm add --global @deepseek-ai/dsh@<version>

npx has no global installation to replace. If a GitHub Release has no matching npm package, follow the dialog’s clone, checkout, pnpm install, build, and launch steps manually. Restart the DSH Web service after any update.

Automatic updates show the source, target version, release type, and risks first; the command runs only after confirmation. Alpha, Beta, and RC releases may contain breaking changes. Back up .dsh configuration and profile data before switching channels, and use an exact older version such as @deepseek-ai/dsh@0.1.1-rc.2 to roll back.

How it works

DSH host process
  lib/index.js
    └─ listens to webserver/index-inject
       reads version from the installed @deepseek-ai/dsh/package.json
       injects globalThis["__DSH_VERSION__"], __DSH_INSTALL_INFO__, and a page token
              │
              ▼
DSH Web browser
  client/client.js
    ├─ registers the sidebar.footer.action card and settings.section page
    ├─ reads window.__DSH_VERSION__ and renders the version card
    ├─ GETs the local check route (host caches npm and GitHub releases)
    └─ POSTs to the loopback-only update route with fixed exact-version arguments
       compares the current version with both sources

Key files in the published package:

File	Purpose
lib/index.js	Host half; injects the current DSH version
client/client.js	Client half; card, update checks, Toast, and styles
cordis.patch.yml	Mounts the plugin into the DSH profile layer
LICENSE	MIT open-source license

Privacy and network behavior

• The host half reads only the version field and installation-path type from the locally installed DSH package manifest; absolute paths are not sent to the browser.
• The host half queries npm Registry and GitHub Releases and caches results in process memory; GitHub API rate limits fall back to the official Releases Atom Feed; update requests carry the page-level token injected by the host.
• The update route accepts only loopback requests with the matching token and does not accept arbitrary commands or arguments from the browser.
• The request does not include DSH credentials, conversation content, or user files; the plugin does not read chat content.
• If the registry request fails, the current version remains visible and a generic error is shown for manual checks.
• The repository and npm package exclude .env, .npmrc, tokens, keys, certificates, logs, dependency directories, and local DSH data.

Compatibility

Item	Requirement
DSH	>= v0.1.0-rc.6
Node.js	>= 20 (host runtime)
Platform	DSH Web
Plugin version	v1.2.3

The plugin uses official DSH extension points: dsh.client, sidebar.footer.action, settings.section, webserver/index-inject, ctx.slots.inject/register, and ctx.settingsScope. If DSH introduces a breaking change to these extension points, the plugin will need a corresponding update.

Development and local verification

This plugin uses the hand-written bundle format used by DSH client plugins: window.__ModuleLoader__.load({ id, factory }). It does not require an additional compiler or runtime dependency.

Run these commands from the project root:

npm run check
npm run build

npm run build performs host/client syntax checks, comparator self-tests, settings/update contract checks, package-integrity checks, and README checks.

Changelog

v1.2.3 - 2026-09-03

• Added bilingual README screenshots covering the sidebar version card, collapsed-sidebar hover tooltip, settings-page overview, npm/GitHub dual-source check results, update confirmation dialog, and update execution record, About section, and install command.
• Added images/Screenshot/ to the npm publish allowlist so the package includes all 6 screenshots referenced by the READMEs.
• Synchronized the release-contract checks with the screenshot publish directory and updated the current plugin version and release-date checks to keep documentation, package metadata, and published contents aligned.
• Updated the package, client About page, and bilingual documentation to plugin version v1.2.3 with release date 2026-09-03.

v1.2.2 - 2026-09-02

• Fixed compatibility with newer DSH settings services by removing the direct settingsNamespace helper import and registering plugin settings with the namespace string, supporting newer @deepseek-ai/dsh-settings releases.
• Extended peer dependency ranges to support @deepseek-ai/dsh-settings 0.1.2-alpha.2 and 0.1.2-alpha.4, plus @deepseek-ai/schemastery 3.18.2, while retaining existing compatible versions.
• Updated the release-contract checks to verify the new string-based namespace registration so the DSH settings compatibility fix cannot regress silently.
• Synchronized the package, client About page, and bilingual documentation to plugin version v1.2.2 with release date 2026-09-02.

v1.2.1 - 2026-09-02

• Fixed GitHub version-check rate-limit handling: failed GitHub API requests now fall back to the Releases Atom Feed, with API and feed results normalized to the same version, type, tag, publication date, release link, and npm-availability fields.
• Improved GitHub check status reporting: API, fallback feed, rate-limited, and temporarily unavailable states are distinguished; the sidebar version card, tooltip, result cards, and update toast now keep npm/GitHub sources and statuses visible.
• Improved Release links: whether data comes from the GitHub API or Atom Feed, links are normalized to the official Release page and expose a localized “Click to open” action.
• Completed the three-language copy for the stable latest channel, update sources, check channels, feed status, rate-limit messages, and direct Release links in Simplified Chinese, English, and Traditional Chinese; the language selector consistently remains 语言/Language.
• Extended the release-contract checks for GitHub feed fallback, rate-limit errors, check channels, feed copy, direct Release links, and all localized keys so the new path remains covered.
• Updated the package, client About page, and bilingual documentation to plugin version v1.2.1 with release date 2026-09-02.

v1.2.0 - 2026-09-01

• Reworked dual-source version checks to query the npm Registry and official GitHub Releases, showing the current and latest versions, release type, publication date, release tag, link, and npm availability.
• Improved version parsing and comparison for Alpha, Beta, RC, stable, and multi-digit versions, with distinct latest, update available, current newer, and check failed states.
• Improved check timing and caching: checks run on page load, refresh every 30 minutes, and refresh after the window returns to the foreground when the interval allows; results are cached in the DSH process to avoid duplicate requests.
• Updated the settings result UI with expandable side-by-side npm and GitHub cards, current installation method and plugin manager details, plus clear Simplified Chinese, English, and Traditional Chinese labels for the stable latest channel.
• Added a safer update flow that shows the source, target version, release type, and risks before confirmation; only confirmed fixed-version commands are executed.
• Hardened host-side updates by requiring a loopback address, valid origin, and page-level token, validating stale targets, preventing duplicate jobs, and reporting command output, completion state, failure reasons, and restart reminders.
• Covered multiple update methods: npm and pnpm support host-side one-click updates, npx provides a temporary execution command, and GitHub releases without a matching npm package fall back to clone, checkout, install, build, and launch steps.
• Synchronized the package, About page, and bilingual documentation to plugin version v1.2.0 with release date 2026-09-01, and added the corresponding build and localization contract checks.

v1.1.1 - 2026-08-29

• Added the black-and-white outlined plugin logo to both READMEs and the top of the settings page.
• Kept the reference project's 54px desktop settings-page presentation and embedded the PNG so npm installations remain self-contained.

v1.1.0 - 2026-08-29

• Added the DSH Version Checker settings section below the reference plugin, with the default gear icon.
• Added the reference-style plugin settings cards and three-language setting.
• Added expandable version results, npm/npx/pnpm distinction, and a loopback-only one-click update route.
• Unified all user-visible plugin version labels to v1.1.0.

v1.0.1 - 2026-08-29

• Fixed the DSH bundle import name for the scoped npm package while preserving the runtime plugin ID.

v1.0.0 - 2026-08-28

• Initial release of the DSH Web version display plugin.
• Added runtime DSH version detection, npm registry update checks, manual refresh, and Toast feedback.
• Added responsive sidebar layout, light/dark theme support, and bilingual UI.
• Added semantic version comparison, request timeout handling, and a safe fallback when the version is unavailable.

Author

Author: Jack·Huang Email: jack698698@gmail.com

License

This project is released under the MIT License. Copyright © 2026 Jack·Huang.