@shellus/way 0.5.1 → 0.5.2

package/README.md

@@ -67,8 +67,14 @@
 
 ## 依赖
 
-- [restic](https://restic.net/) - 备份引擎
 - Node.js >= 18
+- Linux x64 平台内置 [restic](https://restic.net/) 0.16.4，其他平台需自行安装 restic
+
+`way` 查找 restic 的顺序：
+
+1. `WAY_RESTIC_BIN` 指定的二进制
+2. Linux x64 包内置的 restic
+3. 系统 `PATH` 中的 `restic`
 
 ## 安装
 
@@ -76,6 +82,12 @@
 npm install -g @shellus/way
 ```
 
+Linux x64 用户无需额外安装 restic。如需使用自定义 restic，可设置：
+
+```bash
+WAY_RESTIC_BIN=/usr/local/bin/restic way snapshots
+```
+
 ## 快速开始
 
 ### 1. 初始化配置

package/dist/cli.js

@@ -23,6 +23,38 @@ function loadConfig(wayDir, remoteName) {
 
 // src/core/restic.ts
 import { execa } from "execa";
+
+// src/core/restic-bin.ts
+import fs2 from "fs";
+import path2 from "path";
+import { fileURLToPath } from "url";
+function getBundledResticBin(packageRoot) {
+  return path2.join(packageRoot, "vendor/restic/linux-x64/restic");
+}
+function findPackageRoot(startDir = path2.dirname(fileURLToPath(import.meta.url))) {
+  let current = startDir;
+  while (true) {
+    if (fs2.existsSync(path2.join(current, "package.json"))) return current;
+    const parent = path2.dirname(current);
+    if (parent === current) return startDir;
+    current = parent;
+  }
+}
+function resolveResticBin(options = {}) {
+  const env = options.env ?? process.env;
+  const platform = options.platform ?? process.platform;
+  const arch = options.arch ?? process.arch;
+  const packageRoot = options.packageRoot ?? findPackageRoot();
+  const existsSync = options.existsSync ?? fs2.existsSync;
+  if (env.WAY_RESTIC_BIN) return env.WAY_RESTIC_BIN;
+  if (platform === "linux" && arch === "x64") {
+    const bundled = getBundledResticBin(packageRoot);
+    if (existsSync(bundled)) return bundled;
+  }
+  return "restic";
+}
+
+// src/core/restic.ts
 function buildResticEnv(repo) {
   const env = {};
   switch (repo.type) {
@@ -57,11 +89,11 @@ function buildS3Options(repo) {
 }
 async function execRestic(args, env, s3Options = []) {
   try {
-    await execa("restic", [...s3Options, ...args], { env: { ...process.env, ...env }, stdio: "inherit" });
+    await execa(resolveResticBin(), [...s3Options, ...args], { env: { ...process.env, ...env }, stdio: "inherit" });
   } catch (error) {
     if (error.code === "ENOENT") {
-      console.error("Error: restic not found. Please install restic first.");
-      console.error("Visit: https://restic.net/");
+      console.error("Error: restic not found. Linux x64 packages include restic; other platforms must install it first.");
+      console.error("Set WAY_RESTIC_BIN to use a custom restic binary, or visit: https://restic.net/");
       process.exit(1);
     }
     throw error;
@@ -76,6 +108,8 @@ async function run(options) {
   const s3Options = buildS3Options(config.repository);
   const globalExcludes = config.rules.global_excludes || [];
   const projects = options.projects && options.projects.length > 0 ? options.projects : Object.keys(config.rules.projects);
+  const dryRun = options.dryRun || options.extraArgs?.includes("--dry-run") || false;
+  const extraArgs = options.extraArgs?.filter((arg) => arg !== "--dry-run") || [];
   const succeeded = [];
   const failed = [];
   const startTime = Date.now();
@@ -89,7 +123,8 @@ async function run(options) {
     console.log(`=== Backing up: ${projectName} ===`);
     try {
       const args = buildBackupArgs(projectName, project, globalExcludes);
-      if (options.extraArgs) args.push(...options.extraArgs);
+      if (dryRun) args.push("--dry-run");
+      args.push(...extraArgs);
       await execRestic(args, env, s3Options);
       succeeded.push(projectName);
     } catch (error) {
@@ -101,7 +136,7 @@ async function run(options) {
   console.log("\n=== Summary ===");
   if (succeeded.length > 0) console.log("Succeeded:", succeeded.join(", "));
   if (failed.length > 0) console.log("Failed:", failed.join(", "));
-  if (config.rules.uptime_kuma?.push_url) {
+  if (!dryRun && config.rules.uptime_kuma?.push_url) {
     await notifyUptimeKuma({ succeeded, failed, duration }, config.rules.uptime_kuma.push_url);
   }
   return { succeeded, failed, duration };
@@ -149,8 +184,8 @@ async function gc(options) {
 
 // src/commands/systemd.ts
 import { execSync } from "child_process";
-import fs2 from "fs";
-import path2 from "path";
+import fs3 from "fs";
+import path3 from "path";
 async function systemd(options) {
   const wayDir = process.env.WAY_DIR || `${process.env.HOME}/.way`;
   const config = loadConfig(wayDir, options.remote);
@@ -178,9 +213,9 @@ WantedBy=multi-user.target
     return;
   }
   const systemdDir = "/etc/systemd/system";
-  const servicePath = path2.join(systemdDir, "way-backup.service");
+  const servicePath = path3.join(systemdDir, "way-backup.service");
   if (options.action === "install") {
-    fs2.writeFileSync(servicePath, serviceContent);
+    fs3.writeFileSync(servicePath, serviceContent);
     execSync("systemctl daemon-reload");
     execSync("systemctl enable way-backup.service");
     execSync("systemctl start way-backup.service");
@@ -196,7 +231,7 @@ WantedBy=multi-user.target
       execSync("systemctl disable way-backup.service", { stdio: "ignore" });
     } catch {
     }
-    if (fs2.existsSync(servicePath)) fs2.unlinkSync(servicePath);
+    if (fs3.existsSync(servicePath)) fs3.unlinkSync(servicePath);
     execSync("systemctl daemon-reload");
     console.log("Systemd service uninstalled");
   }
@@ -268,7 +303,7 @@ async function daemon(options) {
 
 // src/cli.ts
 var program = new Command();
-program.name("way").version("0.5.1").description("\u7B56\u7565\u5907\u4EFD\u5DE5\u5177 - \u57FA\u4E8E restic \u7684\u7B56\u7565\u5C01\u88C5").option("--remote <name>", "\u6307\u5B9A\u4ED3\u5E93", "default").addHelpText("after", `
+program.name("way").version("0.5.2").description("\u7B56\u7565\u5907\u4EFD\u5DE5\u5177 - \u57FA\u4E8E restic \u7684\u7B56\u7565\u5C01\u88C5").option("--remote <name>", "\u6307\u5B9A\u4ED3\u5E93", "default").addHelpText("after", `
 \u793A\u4F8B:
   $ way run                    \u6267\u884C\u6240\u6709\u9879\u76EE\u5907\u4EFD
   $ way run data               \u53EA\u5907\u4EFD data \u9879\u76EE
@@ -282,9 +317,9 @@ program.name("way").version("0.5.1").description("\u7B56\u7565\u5907\u4EFD\u5DE5
 `);
 program.command("run [projects...]").description("\u6267\u884C\u5907\u4EFD").option("--dry-run", "\u6A21\u62DF\u5907\u4EFD\uFF08\u4E0D\u5B9E\u9645\u5199\u5165\uFF09").allowUnknownOption().allowExcessArguments().action(async function(projects) {
   const remote = this.parent.opts().remote;
+  const dryRun = this.opts().dryRun;
   const extraArgs = this.args.filter((a) => a.startsWith("-") && !["--dry-run"].includes(a));
-  if (this.opts().dryRun) extraArgs.push("--dry-run");
-  await run({ remote, projects: projects.filter((p) => !p.startsWith("-")), extraArgs });
+  await run({ remote, projects: projects.filter((p) => !p.startsWith("-")), extraArgs, dryRun });
 });
 program.command("gc").description("\u6E05\u7406\u65E7\u5FEB\u7167").option("--dry-run", "\u6A21\u62DF\u6E05\u7406\uFF08\u4E0D\u5B9E\u9645\u5220\u9664\uFF09").action(async function(cmdOptions) {
   const remote = this.parent.opts().remote;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shellus/way",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "description": "将备份作为持续运营的项目，而非一次性任务。基于 restic 的策略封装。",
   "type": "module",
   "bin": {
@@ -15,6 +15,7 @@
   },
   "files": [
     "dist",
+    "vendor",
     "repositories.yaml.example",
     "rules.yaml.example",
     "migrate-to-v0.5.sh"
@@ -38,9 +39,6 @@
   "engines": {
     "node": ">=18.0.0"
   },
-  "peerDependencies": {
-    "restic": "*"
-  },
   "dependencies": {
     "commander": "^14.0.3",
     "execa": "^9.6.1",

package/vendor/restic/linux-x64/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2014, Alexander Neumann <alexander@bumpern.de>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/vendor/restic/linux-x64/VERSION

@@ -0,0 +1 @@
+restic 0.16.4 compiled with go1.22.2 on linux/amd64