archiver-ts 0.0.1

package/.draft/vibing.md

@@ -0,0 +1,7 @@
+优化：
+1、命令都写在index.ts里面太厚重了，建议分在不同文件，并创建文件夹保存它们；
+2、在service文件夹下最好写一个直接创建context的方法，避免service外面绕来绕去；
+
+---
+
+能否做成，arv list会展示list，然后可以按键盘上下高亮一个条目，然后左右键可以选择操作，是进入还是恢复档案，回车确认

package/.prettierrc

@@ -0,0 +1,5 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all",
+  "printWidth": 120
+}

package/.scripts/build.js

@@ -0,0 +1,7 @@
+import { execSync } from 'node:child_process';
+
+execSync('npx rimraf dist', { stdio: 'inherit' });
+execSync('rollup -c', { stdio: 'inherit' });
+if (process.argv.includes('--arv')) {
+  execSync('node ./dist/index.js', { stdio: 'inherit' });
+}

package/.scripts/e2e.js

@@ -0,0 +1,3 @@
+import { execSync } from 'node:child_process';
+
+execSync('vitest run tests/e2e', { stdio: 'inherit', env: { ...process.env, ARCHIVER_DIR_PARENT: process.cwd() } });

package/.scripts/lines.js

@@ -0,0 +1,53 @@
+import fs from 'node:fs';
+import path from 'node:path';
+
+const ROOT = path.resolve('.');
+
+const IGNORE_DIRS = new Set(['node_modules', 'dist', 'tests']);
+
+const EXTENSIONS = new Set(['.ts', '.tsx', '.css']);
+
+let totalLines = 0;
+let fileCount = 0;
+
+function countLines(filePath) {
+  const content = fs.readFileSync(filePath, 'utf8');
+  return content.split(/\r\n|\n|\r/).length;
+}
+
+function walk(dir) {
+  const entries = fs.readdirSync(dir, { withFileTypes: true });
+
+  for (const entry of entries) {
+    const fullPath = path.join(dir, entry.name);
+
+    if (entry.isDirectory()) {
+      if (IGNORE_DIRS.has(entry.name)) {
+        continue;
+      }
+      walk(fullPath);
+      continue;
+    }
+
+    if (!entry.isFile()) {
+      continue;
+    }
+
+    const ext = path.extname(entry.name);
+    if (!EXTENSIONS.has(ext)) {
+      continue;
+    }
+
+    const lines = countLines(fullPath);
+    totalLines += lines;
+    fileCount++;
+
+    console.log(`${lines.toString().padStart(7)}  ${path.relative(ROOT, fullPath)}`);
+  }
+}
+
+// "lines": "clear && find ./packages -type f \\( -name \"*.ts\" -o -name \"*.tsx\" -o -name \"*.js\" -o -name \"*.mjs\" -o -name \"*.cjs\" \\) | xargs wc -l",
+
+walk(ROOT);
+console.log(`Files: ${fileCount} for ${[...EXTENSIONS].join(', ')}`);
+console.log(`Total lines: ${totalLines}`);

package/.scripts/publish.js

@@ -0,0 +1,5 @@
+import { execSync } from 'node:child_process';
+
+execSync('npx rimraf dist', { stdio: 'inherit' });
+execSync('rollup -c', { stdio: 'inherit' });
+execSync('npm publish --access public', { stdio: 'inherit' });

package/.scripts/recover.js

@@ -0,0 +1,154 @@
+import fs from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
+import { execSync } from 'node:child_process';
+
+function shellQuote(value) {
+  return `'${String(value).replaceAll("'", "'\\''")}'`;
+}
+
+function hasFlag(name) {
+  return process.argv.includes(name);
+}
+
+function readOption(name) {
+  const index = process.argv.indexOf(name);
+  if (index === -1) {
+    return undefined;
+  }
+  return process.argv[index + 1];
+}
+
+function statusIsArchived(rawStatus) {
+  return rawStatus === 'A' || rawStatus === 'Archived';
+}
+
+function normalizeEntry(raw) {
+  const id = Number(raw.id);
+  const vaultId = Number(raw.vid ?? raw.vaultId);
+  const item = String(raw.i ?? raw.item ?? '');
+  const directory = String(raw.d ?? raw.directory ?? '');
+  const status = String(raw.st ?? raw.status ?? '');
+  if (!Number.isInteger(id) || id <= 0) {
+    return undefined;
+  }
+  if (!Number.isInteger(vaultId) || vaultId < 0) {
+    return undefined;
+  }
+  if (!item || !directory) {
+    return undefined;
+  }
+  return { id, vaultId, item, directory, status };
+}
+
+function readJsonl(filePath) {
+  const content = fs.readFileSync(filePath, 'utf8');
+  if (!content.trim()) {
+    return [];
+  }
+
+  return content
+    .split(/\r?\n/)
+    .map((line) => line.trim())
+    .filter((line) => line.length > 0)
+    .map((line, index) => {
+      try {
+        return JSON.parse(line);
+      } catch (error) {
+        throw new Error(`Invalid JSON at ${filePath}:${index + 1}: ${error.message}`);
+      }
+    });
+}
+
+function readListTable(rootPath) {
+  const jsonlPath = path.join(rootPath, 'core', 'list.jsonl');
+  if (fs.existsSync(jsonlPath)) {
+    return readJsonl(jsonlPath);
+  }
+
+  const jsonPath = path.join(rootPath, 'core', 'list.json');
+  if (!fs.existsSync(jsonPath)) {
+    throw new Error(`Neither list.jsonl nor list.json exists under ${path.join(rootPath, 'core')}.`);
+  }
+
+  const parsed = JSON.parse(fs.readFileSync(jsonPath, 'utf8'));
+  return Array.isArray(parsed) ? parsed : [parsed];
+}
+
+function main() {
+  const apply = hasFlag('--apply');
+  const force = hasFlag('--force');
+
+  const rootPath = path.join(os.homedir(), '.archiver-rust');
+
+  const rows = readListTable(rootPath);
+  const entries = rows
+    .map((row) => normalizeEntry(row))
+    .filter((entry) => entry !== undefined)
+    .filter((entry) => statusIsArchived(entry.status))
+    .sort((a, b) => a.id - b.id);
+
+  if (entries.length === 0) {
+    console.log(`[INFO] No archived entries found in ${rootPath}.`);
+    return;
+  }
+
+  let listed = 0;
+  let restored = 0;
+  let skippedMissing = 0;
+  let skippedTargetExists = 0;
+  let failed = 0;
+
+  console.log(`[INFO] root=${rootPath}`);
+  console.log(`[INFO] mode=${apply ? 'apply' : 'dry-run'}${force ? ' (force enabled)' : ''}`);
+
+  for (const entry of entries) {
+    const sourcePath = path.join(rootPath, 'vaults', String(entry.vaultId), String(entry.id));
+    const targetPath = path.join(entry.directory, entry.item);
+
+    if (!fs.existsSync(sourcePath)) {
+      skippedMissing += 1;
+      console.log(`[SKIP][${entry.id}] source missing: ${sourcePath}`);
+      continue;
+    }
+
+    if (fs.existsSync(targetPath) && !force) {
+      skippedTargetExists += 1;
+      console.log(`[SKIP][${entry.id}] target exists: ${targetPath}`);
+      continue;
+    }
+
+    const mkdirCommand = `mkdir -p ${shellQuote(path.dirname(targetPath))}`;
+    const moveCommand = `mv ${shellQuote(sourcePath)} ${shellQuote(targetPath)}`;
+
+    listed += 1;
+    console.log(`[PLAN][${entry.id}] ${moveCommand}`);
+
+    if (!apply) {
+      continue;
+    }
+
+    try {
+      execSync(mkdirCommand, { stdio: 'inherit' });
+      if (force && fs.existsSync(targetPath)) {
+        const removeCommand = `rm -rf ${shellQuote(targetPath)}`;
+        execSync(removeCommand, { stdio: 'inherit' });
+      }
+      execSync(moveCommand, { stdio: 'inherit' });
+      restored += 1;
+    } catch (error) {
+      failed += 1;
+      console.error(`[FAIL][${entry.id}] ${error.message}`);
+    }
+  }
+
+  console.log(
+    `[INFO] listed=${listed}, restored=${restored}, skipped_missing=${skippedMissing}, skipped_target_exists=${skippedTargetExists}, failed=${failed}`,
+  );
+
+  if (apply && failed > 0) {
+    process.exitCode = 1;
+  }
+}
+
+main();

package/README.dev.md

@@ -0,0 +1,124 @@
+# archiver-ts (Developer Guide)
+
+This file is for contributors and maintainers.
+
+If you are an end user, read `readme.md`.
+
+## Tech stack
+
+- Node.js >= 20
+- TypeScript (ESM)
+- Commander for CLI
+- Vitest for tests
+- Rollup for build output
+
+## Quick start (dev)
+
+```bash
+npm install
+npm run check
+npm test
+```
+
+Run CLI from source:
+
+```bash
+npm run dev -- --help
+```
+
+Build:
+
+```bash
+npm run build
+```
+
+Run built CLI:
+
+```bash
+node dist/index.js --help
+```
+
+## Repo scripts
+
+- `npm run dev`: run CLI from `src/index.ts` via `tsx`
+- `npm run check`: TypeScript type-check (`tsc --noEmit`)
+- `npm test`: unit/e2e tests via Vitest
+- `npm run e2e`: helper wrapper for e2e entry script
+- `npm run build`: clean `dist` then build bundle with Rollup
+- `npm run arv`: build and run built CLI
+- `npm run pub`: publish helper script
+
+## Runtime and data root
+
+Root resolution is implemented in `src/consts/path-tree.ts`:
+
+- `NODE_ENV=production`: `ARCHIVER_PATH` or `~/.archiver`
+- otherwise: `<cwd>/.archiver`
+
+Current data layout:
+
+```text
+.archiver/
+  config.jsonc
+  auto-incr.jsonc
+  list.jsonl
+  vaults.jsonl
+  log.jsonl
+  vaults/
+    <vaultId>/
+      <archiveId>/
+        <originalName>
+```
+
+## Architecture map
+
+- `src/index.ts`: process entry, shell wrapper bootstrap, command parse
+- `src/commands/*`: CLI command definitions and command-level flows
+- `src/services/*`: business logic (archive, vault, config, log, update, check)
+- `src/core/context.ts`: persistence and path helpers
+- `src/core/initialize.ts`: shell wrapper auto-install
+- `src/consts/*`: app constants/defaults/path tree
+- `src/utils/*`: table rendering, parsing, fs/json/date helpers, prompt helpers
+- `tests/*`: unit/integration/e2e tests
+
+## Command wiring notes
+
+- Program wiring lives in `src/commands/index.ts`
+- Main command groups:
+  - archive actions: `put`, `restore`, `move`, `cd`
+  - vault actions: `vault use/create/remove/recover/rename/list`
+  - views and maintenance: `list`, `log`, `config`, `update`, `check`
+
+## Important behavior notes
+
+- Archive/restore/move use filesystem rename operations.
+- Default vault is `@` (id `0`) and is protected.
+- `list` plain mode prints names only; default vault entries omit vault prefix.
+- Audit logs are appended into a single file: `log.jsonl`.
+- Auto update check interval is 24h (`src/consts/update.ts`).
+- Shell wrapper install is best-effort and should not block command execution.
+
+## Recovery helper
+
+Legacy helper script:
+
+```bash
+node .scripts/recover.js [--apply] [--force] [--root <path>]
+```
+
+This script is for recovery from legacy rust data layout and is not part of normal CLI flows.
+
+## Testing
+
+Run all tests:
+
+```bash
+npm test
+```
+
+Useful test focus:
+
+- e2e CLI flow: `tests/e2e/cli.e2e.test.ts`
+- archive/vault workflow: `tests/services/archive-workflow.test.ts`
+- shell wrapper init: `tests/core/initialize.test.ts`
+

package/README.md

@@ -0,0 +1,82 @@
+# archiver
+
+`archiver` (binary: `arv`) archives files/folders into a managed vault directory and lets you restore them later.
+
+It uses filesystem move/rename semantics (no compression), keeps metadata in `.archiver`, and records audit logs.
+
+## Quick start
+
+Install dependencies and build:
+
+```bash
+npm install -g archiver-ts
+```
+
+## Common commands
+
+Archive / restore:
+
+```bash
+arv put <items...> [-v|--vault <vault>] [-m|--message <msg>] [-r|--remark <remark>]
+arv restore <ids...>
+arv move <ids...> --to <vault>
+arv cd <archive-id | vault/archive-id> [--print]
+```
+
+Vault management:
+
+```bash
+arv vault use <name-or-id>
+arv vault create <name> [-r|--remark <remark>] [-a|--activate]
+arv vault remove <name-or-id>
+arv vault recover <name-or-id>
+arv vault rename <old> <new>
+arv vault list [-a|--all]
+```
+
+Query and maintenance:
+
+```bash
+arv list [--restored] [--all] [--vault <vault>] [--no-interactive]
+arv log [YYYYMM | YYYYMM-YYYYMM | all]
+arv log --id <log-id>
+arv config list [-c|--comment]
+arv config alias <alias=path> [-r|--remove]
+arv config update-check <on|off>
+arv config vault-item-sep <separator>
+arv update [--repo <owner/repo>] [--install]
+arv check
+```
+
+## List output behavior
+
+`arv list` plain mode prints names only (one per line):
+
+- default vault (`@`, id `0`): show item name only
+- non-default vault: show `<vaultName>(<vaultId>)<sep><item>`
+- `<sep>` comes from `config vault-item-sep` (default `::`)
+
+Example:
+
+```text
+todo.txt
+work(1)::report.pdf
+```
+
+## Shell wrapper note
+
+On interactive terminal startup, `arv` may auto-install a shell wrapper function so `cd` can move your shell to archive slot paths.
+
+Disable this behavior if needed:
+
+```bash
+ARV_DISABLE_SHELL_INIT=1 arv <command>
+```
+
+## Useful aliases
+
+- `list`: `l`, `ls`
+- `log`: `lg`
+- `config`: `c`, `cfg`
+- `update`: `u`, `upd`
+- `check`: `chk`