deepharness 0.0.1 → 0.0.2

package/README.md

@@ -4,14 +4,73 @@
 
 ## 安装
 
+`deepharness` npm 包是一个轻量级 JS 包装器，它需要本地 `dh` 二进制文件才能工作。
+
+### 1. 先安装 `dh` 二进制文件（必须）
+
+选择以下任一方式：
+
+#### 方式 A：安装 DeepHarness Desktop
+
+从发布页下载并安装桌面应用，它会自动将 `dh` 放入 PATH：
+
+```bash
+https://github.com/deepharness/deepharness-ent-desktop
+```
+
+#### 方式 B：从源码编译（需要 Rust 工具链）
+
 ```bash
+git clone https://github.com/deepharness/deepharness-ent-desktop.git
+cd deepharness-ent-desktop
+cargo build --release -p deepharness-cli
+
+# 安装到用户级可执行目录
+mkdir -p ~/.local/bin
+cp target/release/dh ~/.local/bin/dh
+
+# 确保 ~/.local/bin 在 PATH 中
+export PATH="$HOME/.local/bin:$PATH"
+```
+
+### 2. 再安装 npm 包
+
+```bash
+# 全局安装（推荐安装到用户目录，避免权限问题）
 npm install -g deepharness
 ```
 
-**依赖要求：**
+> **权限问题？** 如果看到 `EACCES` 错误，说明 npm 默认全局目录需要 root 权限。推荐以下两种方案：
+
+#### 方案 1：更改 npm 全局目录到用户主目录
 
-- 已安装 DeepHarness Desktop 应用 或 `dh` 二进制在 PATH 中
-- 若从源码编译：需要 Rust 工具链 (`cargo install --path apps/cli`)
+```bash
+mkdir -p ~/.npm-global
+npm config set prefix '~/.npm-global'
+export PATH="$HOME/.npm-global/bin:$PATH"
+# 将上面这行 export 也加入 ~/.bashrc 或 ~/.zshrc
+
+npm install -g deepharness
+```
+
+#### 方案 2：使用 `npx`（无需全局安装）
+
+```bash
+npx deepharness --version
+```
+
+### 3. 验证安装
+
+```bash
+dh --version
+```
+
+如果包装器找不到二进制文件，可以通过环境变量显式指定：
+
+```bash
+export DH_BINARY_PATH=/path/to/dh
+dh --version
+```
 
 ## 使用
 

package/bin/dh.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 import { spawn, execSync } from 'child_process';
-import { existsSync } from 'fs';
+import { existsSync, realpathSync } from 'fs';
 import { dirname, join, resolve } from 'path';
 import { fileURLToPath } from 'url';
 import { homedir } from 'os';
@@ -8,8 +8,44 @@ import { homedir } from 'os';
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 
+const SYSTEM_INSTALL_URL = 'https://github.com/deepharness/deepharness-ent-desktop';
+
+/**
+ * Resolve the real path of the wrapper script, following symlinks created by
+ * `npm link` or package managers.
+ */
+function resolveWrapperPath() {
+  try {
+    return realpathSync(__filename);
+  } catch {
+    return __filename;
+  }
+}
+
+/**
+ * Check whether a candidate path resolves to this wrapper script itself.
+ * This prevents `which dh` from returning the npm-installed JS wrapper and
+ * causing an infinite subprocess loop.
+ */
+const WRAPPER_PATH = resolveWrapperPath();
+
+function isWrapperItself(candidate) {
+  try {
+    return realpathSync(candidate) === WRAPPER_PATH;
+  } catch {
+    return false;
+  }
+}
+
+/**
+ * Find the project root when the npm package is installed directly inside the
+ * source repository (development / `npm link`). Returns `null` when installed
+ * from the registry.
+ */
 function findProjectRoot() {
-  let current = __dirname;
+  const wrapperPath = resolveWrapperPath();
+  let current = dirname(wrapperPath);
+
   while (true) {
     if (existsSync(join(current, 'Cargo.toml')) && existsSync(join(current, 'package.json'))) {
       return current;
@@ -22,43 +58,83 @@ function findProjectRoot() {
   }
 }
 
-function findDhBinary() {
-  const searchPaths = [];
+/**
+ * Build a list of candidate paths where the `dh` native binary may live.
+ */
+function buildSearchPaths() {
+  const paths = [];
 
+  // 1. Explicit override from environment.
+  if (process.env.DH_BINARY_PATH) {
+    paths.push(resolve(process.env.DH_BINARY_PATH));
+  }
+
+  // 2. Project-local builds when developing from source.
   try {
     const projectRoot = findProjectRoot();
     if (projectRoot) {
-      searchPaths.push(join(projectRoot, 'target', 'release', 'dh'));
-      searchPaths.push(join(projectRoot, 'target', 'debug', 'dh'));
+      paths.push(join(projectRoot, 'target', 'release', 'dh'));
+      paths.push(join(projectRoot, 'target', 'debug', 'dh'));
     }
   } catch {}
 
-  searchPaths.push(
-    '/usr/local/bin/dh',
-    '/usr/bin/dh',
+  // 3. Common user-level install locations.
+  paths.push(
     join(homedir(), '.local', 'bin', 'dh'),
     join(homedir(), '.cargo', 'bin', 'dh'),
   );
 
-  for (const p of searchPaths) {
-    if (existsSync(p)) return p;
+  // 4. System-wide install locations.
+  paths.push('/usr/local/bin/dh', '/usr/bin/dh');
+
+  return paths;
+}
+
+/**
+ * Locate the `dh` binary, or return `null` if it cannot be found.
+ */
+function findDhBinary() {
+  for (const p of buildSearchPaths()) {
+    if (existsSync(p) && !isWrapperItself(p)) return p;
+  }
+
+  // Fallback: rely on the user's PATH. Skip the fallback when we are already
+  // inside a wrapper-spawned process to avoid infinite recursion if `which dh`
+  // points back at this wrapper.
+  if (process.env.DH_NPM_WRAPPER === '1') {
+    return null;
   }
 
   try {
     const which = execSync('which dh', { encoding: 'utf8', stdio: ['ignore', 'pipe', 'ignore'] }).trim();
-    if (which && existsSync(which)) return which;
+    if (which && existsSync(which) && !isWrapperItself(which)) return which;
   } catch {}
 
   return null;
 }
 
-let dhBin = findDhBinary();
-
-if (!dhBin) {
+function printInstallInstructions() {
   console.error('Error: `dh` binary not found.');
   console.error('');
-  console.error('Please install DeepHarness Desktop from: https://github.com/deepharness/deepharness-ent-desktop');
-  console.error('Or build from source: cargo install --path apps/cli');
+  console.error('The `deepharness` npm package is a thin wrapper around the native `dh` binary.');
+  console.error('Please install the binary using one of the following methods:');
+  console.error('');
+  console.error('  1. Install DeepHarness Desktop:');
+  console.error(`     ${SYSTEM_INSTALL_URL}`);
+  console.error('');
+  console.error('  2. Build and install from source (requires Rust):');
+  console.error('     cargo build --release -p deepharness-cli');
+  console.error('     mkdir -p ~/.local/bin');
+  console.error('     cp target/release/dh ~/.local/bin/dh');
+  console.error('');
+  console.error('  3. If the binary is already installed in a non-standard location:');
+  console.error('     export DH_BINARY_PATH=/path/to/dh');
+}
+
+const dhBin = findDhBinary();
+
+if (!dhBin) {
+  printInstallInstructions();
   process.exit(1);
 }
 
@@ -69,8 +145,8 @@ const proc = spawn(dhBin, args, {
   env: { ...process.env, DH_NPM_WRAPPER: '1' },
 });
 
-proc.on('exit', (code) => process.exit(code));
+proc.on('exit', (code) => process.exit(code ?? 1));
 proc.on('error', (err) => {
-  console.error('Failed to start dh:', err.message);
+  console.error(`Failed to start dh from ${dhBin}:`, err.message);
   process.exit(1);
 });

package/package.json

@@ -1,12 +1,19 @@
 {
   "name": "deepharness",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "type": "module",
   "description": "DeepHarness CLI - Connect to AI coding agents with Claude Code, OpenCode, and more",
   "bin": {
     "dh": "bin/dh.js"
   },
-  "scripts": {},
+  "scripts": {
+    "postinstall": "node scripts/postinstall.js"
+  },
+  "files": [
+    "bin/",
+    "scripts/",
+    "README.md"
+  ],
   "keywords": [
     "ai",
     "coding",

package/scripts/postinstall.js

@@ -0,0 +1,123 @@
+#!/usr/bin/env node
+/**
+ * Post-install hook for the `deepharness` npm package.
+ *
+ * The npm package is only a wrapper; it needs the native `dh` binary to be
+ * present on the system. This script verifies that the binary exists and,
+ * when the package is installed from the source repository, attempts to build
+ * it automatically so that `dh --version` works immediately after `npm link`.
+ */
+import { existsSync, realpathSync } from 'fs';
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
+import { homedir } from 'os';
+import { execSync } from 'child_process';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const SYSTEM_INSTALL_URL = 'https://github.com/deepharness/deepharness-ent-desktop';
+
+function resolveWrapperPath() {
+  try {
+    return realpathSync(__filename);
+  } catch {
+    return __filename;
+  }
+}
+
+const WRAPPER_PATH = resolveWrapperPath();
+
+function isWrapperItself(candidate) {
+  try {
+    return realpathSync(candidate) === WRAPPER_PATH;
+  } catch {
+    return false;
+  }
+}
+
+function findProjectRoot() {
+  const wrapperPath = resolveWrapperPath();
+  let current = dirname(wrapperPath);
+
+  while (true) {
+    if (existsSync(join(current, 'Cargo.toml')) && existsSync(join(current, 'package.json'))) {
+      return current;
+    }
+    const parent = dirname(current);
+    if (parent === current) {
+      return null;
+    }
+    current = parent;
+  }
+}
+
+function findExistingDhBinary() {
+  const candidates = [
+    join(homedir(), '.local', 'bin', 'dh'),
+    join(homedir(), '.cargo', 'bin', 'dh'),
+    '/usr/local/bin/dh',
+    '/usr/bin/dh',
+  ];
+
+  for (const p of candidates) {
+    if (existsSync(p) && !isWrapperItself(p)) return p;
+  }
+
+  try {
+    const which = execSync('which dh', { encoding: 'utf8', stdio: ['ignore', 'pipe', 'ignore'] }).trim();
+    if (which && existsSync(which) && !isWrapperItself(which)) return which;
+  } catch {}
+
+  return null;
+}
+
+function isBinaryUsable() {
+  return !!findExistingDhBinary();
+}
+
+function buildFromSource(projectRoot) {
+  console.log(`[deepharness] Building native dh binary from ${projectRoot}...`);
+  try {
+    execSync('cargo build --release -p deepharness-cli', {
+      cwd: projectRoot,
+      stdio: 'inherit',
+    });
+    return true;
+  } catch (err) {
+    console.error('[deepharness] Failed to build dh from source.');
+    return false;
+  }
+}
+
+function main() {
+  // If a usable binary already exists, nothing more to do.
+  if (isBinaryUsable()) {
+    const location = findExistingDhBinary();
+    console.log(`[deepharness] Found dh binary at ${location}`);
+    return;
+  }
+
+  const projectRoot = findProjectRoot();
+
+  if (projectRoot) {
+    console.log('[deepharness] dh binary not found; attempting to build from source...');
+    const built = buildFromSource(projectRoot);
+    if (built) {
+      const releaseBinary = join(projectRoot, 'target', 'release', 'dh');
+      if (existsSync(releaseBinary)) {
+        console.log(`[deepharness] Built dh binary at ${releaseBinary}`);
+        console.log('[deepharness] Add it to your PATH to use the `dh` command globally:');
+        console.log(`  export PATH="${join(projectRoot, 'target', 'release')}:$PATH"`);
+      }
+      return;
+    }
+  }
+
+  console.warn('[deepharness] The native `dh` binary is not installed.');
+  console.warn('[deepharness] The `dh` command will not work until it is available.');
+  console.warn(`[deepharness] Install DeepHarness Desktop from: ${SYSTEM_INSTALL_URL}`);
+  console.warn('[deepharness] Or build from source: cargo build --release -p deepharness-cli');
+}
+
+main();