dsh-sidebar-row-menu 1.3.2 → 1.3.3

package/README.en.md

@@ -1,6 +1,6 @@
 # dsh-sidebar-row-menu
 
-<img src="assets/icon-180.png" width="96" align="right" alt="Plugin icon" />
+<img src="https://raw.githubusercontent.com/TLEWA/dsh-sidebar-row-menu/main/assets/icon-180.png" width="96" align="right" alt="Plugin icon" />
 
 [![CI](https://github.com/TLEWA/dsh-sidebar-row-menu/actions/workflows/ci.yml/badge.svg)](https://github.com/TLEWA/dsh-sidebar-row-menu/actions/workflows/ci.yml)
 [![Release](https://github.com/TLEWA/dsh-sidebar-row-menu/actions/workflows/release.yml/badge.svg)](https://github.com/TLEWA/dsh-sidebar-row-menu/releases)
@@ -73,7 +73,33 @@ Requirements:
 - Windows PowerShell 5.1+;
 - Row components from the `0.2.1-rc.5` generation (see [Compatibility](#compatibility)).
 
-### Install from GitHub (recommended)
+### Install from npm (recommended)
+
+The package is published to the npm registry, and DSH's plugin installer can
+resolve it directly by name:
+
+1. Open **Plugins** in the sidebar → **Install plugin**;
+2. Enter the package name and confirm:
+
+   ```
+   dsh-sidebar-row-menu
+   ```
+
+3. Hard-refresh (`Ctrl+Shift+R`); restart the desktop app if the host half is not active.
+
+Pin a version by appending it to the name:
+
+```
+dsh-sidebar-row-menu@1.3.3
+```
+
+Equivalent command line:
+
+```powershell
+dsh plugin --profile desktop add dsh-sidebar-row-menu@1.3.3
+```
+
+### Install from GitHub
 
 DSH Desktop installs Git dependencies through pnpm. The `lib/` directory in this
 repository is already runnable, so **no local build is required**.
@@ -90,13 +116,13 @@ repository is already runnable, so **no local build is required**.
 That URL tracks the latest commit on `main`. Pin a tag for a stable version:
 
 ```
-https://github.com/TLEWA/dsh-sidebar-row-menu#v1.3.2
+https://github.com/TLEWA/dsh-sidebar-row-menu#v1.3.3
 ```
 
 Or install the tarball built by Actions directly, without Git:
 
 ```
-https://github.com/TLEWA/dsh-sidebar-row-menu/releases/download/v1.3.2/dsh-sidebar-row-menu-1.3.2.tgz
+https://github.com/TLEWA/dsh-sidebar-row-menu/releases/download/v1.3.3/dsh-sidebar-row-menu-1.3.3.tgz
 ```
 
 Equivalent command line:
@@ -175,10 +201,10 @@ repository itself is untouched.
 > as relative to the profile, and cross-drive paths produce broken links. The
 > script exists to avoid exactly that.
 
-### Switching from the script install to the GitHub install
+### Switching from the script install to a pnpm install (npm / GitHub)
 
-If you installed the development copy with `scripts/install.ps1` and then paste
-the GitHub URL into the Plugins page, pnpm may fail with:
+If you installed the development copy with `scripts/install.ps1` and then enter
+the npm package name or the GitHub URL into the Plugins page, pnpm may fail with:
 
 ```
 [ERR_PNPM_EPERM] [importPackage ...\node_modules\dsh-sidebar-row-menu]
@@ -203,7 +229,7 @@ cmd /c rmdir "$env:USERPROFILE\.dsh\profiles\desktop\node_modules\dsh-sidebar-ro
 ```
 
 A fresh profile never hits this; it only affects the "script install, then
-GitHub install" transition.
+pnpm install (npm or GitHub)" transition.
 
 ## Development
 

package/README.md

@@ -1,6 +1,6 @@
 # dsh-sidebar-row-menu
 
-<img src="assets/icon-180.png" width="96" align="right" alt="插件图标" />
+<img src="https://raw.githubusercontent.com/TLEWA/dsh-sidebar-row-menu/main/assets/icon-180.png" width="96" align="right" alt="插件图标" />
 
 [![CI](https://github.com/TLEWA/dsh-sidebar-row-menu/actions/workflows/ci.yml/badge.svg)](https://github.com/TLEWA/dsh-sidebar-row-menu/actions/workflows/ci.yml)
 [![Release](https://github.com/TLEWA/dsh-sidebar-row-menu/actions/workflows/release.yml/badge.svg)](https://github.com/TLEWA/dsh-sidebar-row-menu/releases)
@@ -66,7 +66,32 @@
 - Windows PowerShell 5.1+；
 - 与 DSH 客户端内置包 `0.2.1-rc.5` 同代的行组件（见[兼容性](#兼容性)）。
 
-### 从 GitHub 直接安装（推荐）
+### 从 npm 安装（推荐）
+
+包已发布到 npm registry，DSH 的插件安装器可以直接按包名解析：
+
+1. 打开侧边栏 **插件** 页 → **安装插件**；
+2. 输入包名并确认：
+
+   ```
+   dsh-sidebar-row-menu
+   ```
+
+3. 安装完成后硬刷新（`Ctrl+Shift+R`）；宿主半边未生效时重启桌面端。
+
+要固定版本，在包名后加版本号：
+
+```
+dsh-sidebar-row-menu@1.3.3
+```
+
+命令行等价写法：
+
+```powershell
+dsh plugin --profile desktop add dsh-sidebar-row-menu@1.3.3
+```
+
+### 从 GitHub 安装
 
 DSH 桌面端通过 pnpm 安装 Git 依赖；本仓库的 `lib/` 已是可直接运行的产物，安装时
 **不需要本地构建**。
@@ -83,13 +108,13 @@ DSH 桌面端通过 pnpm 安装 Git 依赖；本仓库的 `lib/` 已是可直接
 该地址跟随 `main` 的最新提交。要固定版本，在地址后加标签：
 
 ```
-https://github.com/TLEWA/dsh-sidebar-row-menu#v1.3.2
+https://github.com/TLEWA/dsh-sidebar-row-menu#v1.3.3
 ```
 
 也可以直接安装 Actions 打出的压缩包（不经过 Git）：
 
 ```
-https://github.com/TLEWA/dsh-sidebar-row-menu/releases/download/v1.3.2/dsh-sidebar-row-menu-1.3.2.tgz
+https://github.com/TLEWA/dsh-sidebar-row-menu/releases/download/v1.3.3/dsh-sidebar-row-menu-1.3.3.tgz
 ```
 
 命令行等价写法：
@@ -158,9 +183,9 @@ powershell -NoProfile -File .\scripts\install.ps1 -Uninstall
 > 不要用 `dsh plugin add link:<绝对路径>`：pnpm 在 Windows 上把 `link:` 当成相对
 > profile 的路径，跨盘时会生成坏链接；脚本正是为了绕开这一点。
 
-### 从脚本安装切换到 GitHub 安装
+### 从脚本安装切换到 pnpm 安装（npm / GitHub）
 
-如果你先用 `scripts/install.ps1` 装过开发版，再在插件页输入 GitHub 地址，pnpm 可能报：
+如果你先用 `scripts/install.ps1` 装过开发版，再在插件页输入 npm 包名或 GitHub 地址，pnpm 可能报：
 
 ```
 [ERR_PNPM_EPERM] [importPackage ...\node_modules\dsh-sidebar-row-menu]
@@ -181,7 +206,7 @@ powershell -NoProfile -File .\scripts\install.ps1 -Uninstall
 cmd /c rmdir "$env:USERPROFILE\.dsh\profiles\desktop\node_modules\dsh-sidebar-row-menu"
 ```
 
-全新 profile 不会遇到这个问题；它只影响“先脚本安装、后 GitHub 安装”的切换场景。
+全新 profile 不会遇到这个问题；它只影响“先脚本安装、后 pnpm（npm 或 GitHub）安装”的切换场景。
 
 ## 开发
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-sidebar-row-menu",
-  "version": "1.3.2",
+  "version": "1.3.3",
   "type": "module",
   "description": "DSH sidebar right-click menus: a self-composed menu for workspace rows, and the native slot menu opened at the pointer for session rows.",
   "keywords": [
@@ -31,6 +31,7 @@
     "lib",
     "assets",
     "scripts/install.ps1",
+    "scripts/marketplace-preflight.mjs",
     "cordis.patch.yml",
     "README.md",
     "README.en.md",

package/scripts/marketplace-preflight.mjs

@@ -0,0 +1,169 @@
+import { existsSync, readFileSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const root = join(dirname(fileURLToPath(import.meta.url)), '..');
+const offline = process.argv.includes('--offline');
+const entryPath = join(root, 'marketplace', 'TLEWA__dsh-sidebar-row-menu.yml');
+const iconPath = join(root, 'assets', 'icon-180.png');
+const repoSlug = 'TLEWA/dsh-sidebar-row-menu';
+
+let failures = 0;
+let warnings = 0;
+
+const pass = (message, detail = '') => console.log(`PASS  ${message}${detail ? ` — ${detail}` : ''}`);
+const warn = (message, detail = '') => {
+  warnings += 1;
+  console.log(`WARN  ${message}${detail ? ` — ${detail}` : ''}`);
+};
+const fail = (message, detail = '') => {
+  failures += 1;
+  console.log(`FAIL  ${message}${detail ? ` — ${detail}` : ''}`);
+};
+
+// The submission entry is local-only (git-ignored), so a fresh clone has no
+// marketplace/ directory. Treat that as "nothing to check", not as a failure.
+if (!existsSync(entryPath)) {
+  warn('marketplace entry', 'marketplace/ is local-only and absent in this checkout');
+  console.log('\nREADY — 0 failure(s), 1 warning(s)');
+  process.exit(0);
+}
+
+function readPngSize(file) {
+  const buffer = readFileSync(file);
+  const signature = buffer.subarray(0, 8).toString('hex');
+  if (signature !== '89504e470d0a1a0a') return null;
+  return { width: buffer.readUInt32BE(16), height: buffer.readUInt32BE(20) };
+}
+
+// --- package manifest -------------------------------------------------------
+
+const pkg = JSON.parse(readFileSync(join(root, 'package.json'), 'utf8'));
+pkg.name === 'dsh-sidebar-row-menu'
+  ? pass('package name', pkg.name)
+  : fail('package name', `expected dsh-sidebar-row-menu, got ${pkg.name}`);
+
+if (pkg.dsh?.bundle?.patch) {
+  pass('dsh.bundle.patch', pkg.dsh.bundle.patch);
+  const patchPath = join(root, pkg.dsh.bundle.patch);
+  if (!existsSync(patchPath)) {
+    fail('bundle patch exists', pkg.dsh.bundle.patch);
+  } else {
+    const patch = readFileSync(patchPath, 'utf8');
+    if (/insert:/.test(patch) && patch.includes(pkg.name)) {
+      pass('bundle patch content', 'insert + package name');
+    } else {
+      fail('bundle patch content', 'expected an insert entry naming the package');
+    }
+  }
+} else {
+  fail('dsh.bundle.patch', 'missing — dsh.client alone is not installable');
+}
+
+pkg.license === 'MIT' ? pass('license', 'MIT') : fail('license', `got ${pkg.license}`);
+String(pkg.repository?.url ?? '').includes(repoSlug)
+  ? pass('repository', pkg.repository.url)
+  : fail('repository', 'does not point at the GitHub repo');
+
+// --- storefront icon --------------------------------------------------------
+
+if (!existsSync(iconPath)) {
+  fail('assets/icon-180.png', 'missing');
+} else {
+  const size = readPngSize(iconPath);
+  if (!size) {
+    fail('icon format', 'not a PNG');
+  } else if (size.width !== 180 || size.height !== 180) {
+    fail('icon dimensions', `${size.width}x${size.height}, expected 180x180`);
+  } else {
+    pass('icon', '180x180 PNG');
+  }
+}
+
+// --- submission entry -------------------------------------------------------
+
+if (!existsSync(entryPath)) {
+  fail('marketplace entry', 'missing');
+} else {
+  const entry = readFileSync(entryPath, 'utf8');
+  const field = (name) => (entry.match(new RegExp(`^${name}:\\s*(.+)$`, 'm')) ?? [])[1]?.trim() ?? '';
+  const checks = [
+    ['url', `https://github.com/${repoSlug}`],
+    ['name', repoSlug],
+    ['category', 'ui'],
+    ['icon', `https://raw.githubusercontent.com/${repoSlug}/main/assets/icon-180.png`],
+  ];
+  for (const [key, expected] of checks) {
+    const actual = field(key);
+    actual === expected
+      ? pass(`entry.${key}`, actual)
+      : fail(`entry.${key}`, `expected ${expected}, got ${actual || '(missing)'}`);
+  }
+  /^\s+en:\s*\S/m.test(entry) ? pass('entry.description.en') : fail('entry.description.en', 'missing');
+  /^\s+zh:\s*\S/m.test(entry) ? pass('entry.description.zh') : warn('entry.description.zh', 'missing (optional)');
+  if (!/^tarball:\s*https:\/\/github\.com\/.+\/releases\/(download|latest\/download)\/.+\.tgz$/m.test(entry)) {
+    fail('entry.tarball', 'missing or not a GitHub release .tgz URL');
+  } else {
+    pass('entry.tarball');
+  }
+}
+
+// --- repository live checks -------------------------------------------------
+
+if (offline) {
+  warn('GitHub checks', 'skipped (--offline)');
+} else {
+  try {
+    const response = await fetch(`https://api.github.com/repos/${repoSlug}`, {
+      headers: { accept: 'application/vnd.github+json', 'user-agent': 'dsh-sidebar-row-menu-preflight' },
+      signal: AbortSignal.timeout(15000),
+    });
+    if (!response.ok) throw new Error(`GitHub API ${response.status}`);
+    const repo = await response.json();
+
+    const created = Date.parse(repo.created_at);
+    const ageMs = Date.now() - created;
+    const eligible = new Date(created + 86400000);
+    if (ageMs >= 86400000) {
+      pass('repo age', `${(ageMs / 86400000).toFixed(1)} days`);
+    } else {
+      warn(
+        'repo age',
+        `${(ageMs / 3600000).toFixed(1)} hours — eligible at ${eligible.toISOString()} (${eligible.toLocaleString('zh-CN', { timeZone: 'Asia/Shanghai' })})`,
+      );
+    }
+
+    Array.isArray(repo.topics) && repo.topics.includes('dsh-plugin')
+      ? pass('topic', 'dsh-plugin')
+      : fail('topic', 'dsh-plugin is missing — required by awesome-dsh-plugin');
+
+    repo.description ? pass('repo description', repo.description) : fail('repo description', 'empty');
+
+    if (existsSync(entryPath)) {
+      const entry = readFileSync(entryPath, 'utf8');
+      const tarball = (entry.match(/^tarball:\s*(\S+)$/m) ?? [])[1];
+      if (tarball) {
+        const head = await fetch(tarball, {
+          method: 'HEAD',
+          redirect: 'follow',
+          signal: AbortSignal.timeout(20000),
+        });
+        head.ok
+          ? pass('tarball URL', `${head.status} ${tarball}`)
+          : fail('tarball URL', `${head.status} ${tarball}`);
+      }
+    }
+
+    const iconUrl = `https://raw.githubusercontent.com/${repoSlug}/main/assets/icon-180.png`;
+    const iconHead = await fetch(iconUrl, { method: 'HEAD', signal: AbortSignal.timeout(15000) });
+    iconHead.ok ? pass('icon URL', `${iconHead.status}`) : fail('icon URL', `${iconHead.status}`);
+  } catch (error) {
+    fail('GitHub checks', error instanceof Error ? error.message : String(error));
+  }
+}
+
+console.log(`\n${failures === 0 ? 'READY' : 'NOT READY'} — ${failures} failure(s), ${warnings} warning(s)`);
+if (failures > 0) {
+  console.log('Fix the FAIL lines before opening the awesome-dsh-plugin pull request.');
+  process.exitCode = 1;
+}