Skip to content

07-忍者工具集内容说明.md

Latest commit

 

History

History
128 lines (93 loc) · 3.22 KB

07-忍者工具集内容说明.md

File metadata and controls

128 lines (93 loc) · 3.22 KB

🥷 忍者工具集

本文件夹包含项目开发、构建和测试所需的各种脚本和工具文件。

📁 文件列表

文件名 类型 功能 使用频率
build.sh Shell 应用打包 发布时
build-clean.sh Shell 清理构建缓存 构建问题时
izanaki.sh Shell 一键运行脚本（自动安装环境） 首次使用/环境问题时
kunai.sh Shell 依赖安装 首次/依赖更新时
ninpo.sh Shell 依赖卸载 卸载时
nigate.sh Shell NTFS 自动挂载 日常使用
kamui.sh Shell Linux 文件系统挂载 需要访问 Linux 分区时
kamui-lang.sh Shell kamui.sh 多语言支持 自动加载
shuriken.sh Shell 系统权限设置 权限问题时
restart-watch.sh Shell 重启 TypeScript Watch 开发时
okugi.sh Shell Git 历史清理 仓库体积过大时
sync-version.js JavaScript 版本号同步 发布前
filter-tsc-output.js JavaScript TypeScript 输出过滤 开发时（自动）
test-modules-cli.js JavaScript 模块测试（命令行） 测试时
test-modules-enhanced.html HTML 模块测试页面 测试时
makimono/ 目录 工具集文档（多语言） 参考时

🚀 快速开始

首次使用项目

方式一：一键运行（推荐新手）

# 自动检测并安装所有必要的工具（Node.js、pnpm、依赖等）
./ninja/izanaki.sh

方式二：手动安装

# 1. 安装依赖
pnpm install

# 2. 安装系统依赖（可选）
./ninja/kunai.sh

# 3. 开始开发
pnpm run dev

构建应用

# 基本构建
pnpm run build

# 清理后构建
pnpm run build:clean

# 仅构建 DMG
pnpm run build:dmg

使用 NTFS 读写功能

# 运行自动挂载脚本
./ninja/nigate.sh

# 设置语言
LANG=zh_CN ./ninja/nigate.sh  # 中文
LANG=en_US ./ninja/nigate.sh  # 英文
LANG=ja_JP ./ninja/nigate.sh  # 日文

挂载 Linux 文件系统

# 自动检测并挂载
./ninja/kamui.sh

# 指定设备
./ninja/kamui.sh /dev/disk4s1

# 使用 ntfs3 驱动（性能更好）
./ninja/kamui.sh /dev/disk4s1 -t ntfs3

# 列出可用设备
./ninja/kamui.sh --list

# 卸载设备
./ninja/kamui.sh --unmount

# 设置语言
LANG=zh_CN ./ninja/kamui.sh  # 中文
LANG=en_US ./ninja/kamui.sh  # 英文
LANG=ja_JP ./ninja/kamui.sh  # 日文

常用操作

# 更新版本号
pnpm run sync-version

# 一键安装环境（包含 Electron 修复功能）
./ninja/izanaki.sh

# 配置系统权限
./ninja/shuriken.sh

# 清理构建缓存
./ninja/build-clean.sh

# 卸载依赖
./ninja/ninpo.sh

📝 注意事项

  1. 路径引用： 所有脚本都假设从项目根目录运行
  2. 权限要求： 某些脚本（如 nigate.sh、kunai.sh）需要管理员权限
  3. 语言支持： 支持多语言的脚本可以通过 LANG 环境变量设置语言
  4. 一键脚本： izanaki.sh 会自动检测并安装 Node.js、pnpm、项目依赖等，适合完全没有环境的用户使用
  5. 文档目录： makimono/ 目录包含工具集的多语言文档（日文版等）

最后更新： 2026-01-20