mirror of
https://github.com/tiddly-gittly/TidGi-Desktop.git
synced 2025-12-05 18:20:39 -08:00
fa9751e5ea
* refactor: only use message id * feat: stream update, but react don't react on it dny * feat: start stop * feat: basic resoponse handlers * feat: load handler config schema * chore: upgrade to "moduleResolution": "bundler" * fix: prompt concat * feat: rjfs with mui * fix: mui v7 upgrade * fix: field editor tabs * feat: Description field is i18n key, use i18nAlly extension to see it on VSCode. And use react-i18next to translate it on frontend. * refactor: extract some shared components * refactor: remove @mui/lab * feat: faster editor * feat: beautify editor * refactor: better style * fix: fullscreen style * fix: array sort * fix: editor not saved * fix: broken array * chore: upgrade mui deps * Update type.d.ts * feat: upgrade and install react dev tools * refactor: simplify the code * refactor: simplify the code * refactor: simplify ai generated garbage code * fix: translated label * feat: translate enum and conditional show field based on enum * feat: click to open source * fix: ai generated garbage code to solve id and index problem * refactor: simplify * refactor: shorten * test: add jest * chore: node-linker=hoisted as electron forge suggested * test: e2e * fix: test failed on ci * test: faster by disable some typecheck * fix: ci * fix: ci * refactor: remove unused * fix: use macos and take screenshot in ci * docs: (cherry picked from commitb1a9706264) * fix: ci crash due to no dugite binary, due to NODE_ENV=test not set * Update test.yml * fix: ci * Update release.yml * docs: test * refactor: move folders and lint * refactor: organize pages to reduce level * refactor: merge page service and workspace service to allow drag & drop of pages * Update ipc-syncadaptor.ts * Update browserViewMetaData.ts * fix: view.webContents.loadURL won't reload on new electron version * fix: try to disable annoying useless disabling pasting "feature" https://github.com/electron/electron/issues/40995 * fix: initial page * feat: allow sort add icon * test: use vitest instead * refactor: use emotion instead * fix: all ts error after migrate to vitest and emotion * fix: Component selectors can only be used in conjunction with @emotion/babel-plugin, the swc Emotion plugin, or another Emotion-aware compiler transform. fix by not using this usage * fix: too many open files * test: add basic main page test * refactor: split workspace type to make it more specific * test: support mock react lazy import component by re-export them * test: sidebar * refactor: move mock to global * test: testing library fix * test: new wiki form * docs: test with vitest * lint: fix * docs: pronounication & remove toc as gh build in * feat: tools and rag * feat: prompt for build-in tools * fix: i18n * fix: tool using * test: fix * refactor: Auto-create default wiki workspace if none exists (handled in backend) * fix: create wiki workspace so it is on first one * refactor: remove some useless feature * refactor: use plugin instead of handler * chore: make concatPrompt async iterator * feat: show progress on frontend * fix: errors * fix: ConfigError: Config (unnamed): Key "overrides": This appears to be in eslintrc format rather than flat config format. * Update package.json * feat: allow windows to hide titlebar * fix: logger error when ctrl+c on mac * lint * refactor: use plugin everywhere * refactor: move more logic to plugin * refactor: run tool in plugin, simplify abstraction * refactor: remove ai generated duplicate * refactor * refactor: less plugins * test: simplify wiki search test * test: remove any * fix: not streaming, tool order wrong * test: plugin system and streaming * refactor: remove useless auto reply plugin * fix: hide duration expired tool calling message, so long tool result only show to ai once * fix: $ props should lower cased * test: support run as electron so can use sqlite3 compiled bin for electron * docs: better electron as node run and doc * test: restore to use threads instead of fock. Seems this also works for inmemory database * test: fix frontend ui test * lint: ai content * test: fix coverage * test: Refactor test mocks to dedicated __mocks__ directory Moved common test mocks from setup-vitest.ts into separate files under src/__tests__/__mocks__ for better organization and maintainability. Updated documentation to reflect the new structure. Removed fileMock.js and updated setup-vitest.ts to import and use the new centralized mocks. * Update ErrorDuringStart.md * Update messageManagementPlugin.test.ts * test: Fix Electron test process cleanup and update test config Update test:unit script to use cross-env for ELECTRON_RUN_AS_NODE, ensuring child processes inherit the variable and preventing resource leaks. Remove manual process.env setting from vitest.config.ts and add documentation on handling related errors in Testing.md. Also, add 'hanging-process' reporter to Vitest config for improved diagnostics. * fix: warning in test * Create AgentInstanceWorkflow.md * fix: duration bug * fix: ai not response for tool result * test: Add agent workflow feature and step definitions Introduces a new Cucumber feature for agent workflow, including multi-round conversation and tool usage. Adds agent-specific step definitions for message input and chat history validation. Refactors application step definitions for improved selector handling and element interaction. Updates test scripts in package.json to include a preparation step for e2e tests. * Update application.ts * test: Add mock OpenAI server and tests Introduces a MockOpenAIServer for simulating OpenAI chat completions, including tool call and tool result responses. Adds corresponding tests and updates vitest config to include tests in the features directory. * test: simplify steps * test: Add separate test userData and wiki folders Introduces 'userData-test' and 'wiki-test' folders for test environments, updating appPaths, fileNames, and paths constants to distinguish between development and test modes. This helps prevent conflicts when running test and development instances simultaneously. * Update eslint.config.mjs @typescript-eslint/no-unnecessary-condition': 'off' * test: Add data-testid attributes for test automation Added data-testid attributes to form inputs and buttons in ExternalAPI components to improve test automation reliability. Updated feature files and step definitions to use these selectors, refined window switching logic, and improved timing for UI interactions. Also exposed isElectronDevelopment and added isMainWindowPage utility for window identification. * test: fix wront page type by ai written garbage code * Update application.ts * Update Testing.md * fix: no log during e2e test, and error creating wiki blocks other init steps * test: click agent workspace button, and refactor mock server * test: mock streamable openai api * rename * chore: try esbuild loader, renderer build too slow * chore: organize webpack * chore: ignore service code from hot reload * Update Testing.md * test: use full agentinstance in test * chore: webpack error * Update Testing.md * chore: remove useless spectron * test: EsbuildPlugin's `define` doesn't work, it won't set env properly. * test: e2e mock openai * lint: disable @typescript-eslint/require-await * test: Add quick access to create default agent tab Introduces a 'Create Default Agent' quick access button in the Agent New Tab page, with localization support. Adds utility to close all tabs and create a default agent tab for fallback scenarios, improves test selectors for tab and close actions, and refactors agent chat tab creation logic for consistency and testability. * feat: remove unuse favorite * feat: Add wiki operation and workspaces list plugins Introduces wikiOperationPlugin and workspacesListPlugin for agent instance prompt and response handling. Updates plugin registry, test coverage, and default agent configuration to support wiki workspace listing and wiki note operations (create, update, delete) via tool calls. Refactors wikiSearchPlugin to delegate workspace list injection to workspacesListPlugin. * Refactor plugin schema system for dynamic registration Introduces a dynamic plugin schema registry, allowing plugins to register their parameter schemas and metadata at runtime. Refactors prompt concat schema generation to use dynamically registered plugin schemas, removes static plugin schema definitions, and updates all plugin files to export their parameter schemas. Adds new modelContextProtocolPlugin and schemaRegistry modules, and updates plugin initialization to register schemas and metadata. This enables extensibility and type safety for plugin configuration and validation. * refactor: move PromptConfigForm to inside PromptPreviewDialog * test: frontent render tool usage info * test: split file * test: fix error * test: wiki operation * test: remove log and clean up test deps * Update i18next-electron-fs-backend.ts * fix: wikiOperationInServer not called due to no message * test: fix * test: Refactor agent feature setup and improve mock server URL handling Moved AI provider and model configuration to a shared setup scenario in agent.feature to avoid redundant steps in each test. Enhanced application.ts to use a fallback localhost URL for MOCK_SERVER_URL when the mock server is not available, improving test reliability. * Remove retry logic from basicPromptConcatHandler Eliminated retryCount and maxRetries from basicPromptConcatHandler, simplifying the control flow and removing the retry limit for LLM calls. Logging and yield logic were updated to reflect the removal of retries. * Update agent.feature * test: agent and default wiki * test: refactor wiki cleanup * Update agent.feature * Refactor AI settings setup and add preference feature Moved AI provider and model configuration steps from agent.feature to a new preference.feature file for better separation of concerns. Updated step definitions in agent.ts to improve robustness when reading and writing settings files, including type usage and directory checks. * test: try debug can't stop bug * Update Testing.md * fix: cancel agent not update cancel button * refactor: update Frontend use `void window.service.native.log` to log to file. * test: log from renderer test * feat: add default embedding model config and victor search service and search preference panel * test: default embedding form and * test: default agent * refator: unused tool listing methods * Refactor test database setup for integration tests Centralizes in-memory SQLite test database initialization and cleanup in shared utilities for all integration tests. Updates agentDefinition and messageManagementPlugin tests to use the shared test database, improving reliability and reducing code duplication. * fix: app path wrong in unit test * feat: externalAPIDebug * test: embedding service and let db use real in memory one * test: provide at least one tab for close tab test * fix: victor db not loaded in new connection * test: disable hot reload * Update DeveloperTools.tsx * feat: tool message & wiki tool schema * feat: pref to open db * chore: skip ExternalsPlugin on dev * fix: APIs doesn't accept 'tool' role, and it won't return anything when API calls * fix: docs and remove ai fake fix * refactor: get agent list don't need to have message * Update basicPromptConcatHandler.failure.test.ts * Update basicPromptConcatHandler.test.ts * fix: role wrong cause e2e failed * test: allow e2e create .db file to check * feat: create new agent * feat: getAgentDefinitionTemplatesFromWikis * fix: Prevent update non-active (hiding) wiki workspace, so it won't pop up to cover other active agent workspace * fix: Ensure the config change is fully persisted before proceeding * test: Don't bring up window when running e2e test, otherwise it will annoy the developer who is doing other things. * feat: Edit existing agent definition workflow * Update StyledArrayContainer.tsx * test: prevent mock server hang * Refactor UI step definitions into separate file Moved UI-related Cucumber step definitions from application.ts to a new ui.ts file for better separation of concerns and maintainability. application.ts now only contains application-specific logic. * lint: ai auto fix * Clean up feature files and improve test coverage Removed unnecessary blank lines and improved formatting in feature files for better readability. Updated tsconfig to use 'bundler' module resolution. Enhanced EditAgentDefinitionContent test to mock and verify console.error output. Added type annotation for IAgentDefinitionService in basicPromptConcatHandler.failure.test.ts for improved type safety. * test: simplify message text match * feat: transcription and image generation model config * fix: style props error * chore: remove unused file * chore: try to imporove dev start speed but no sig improvment Replaces 'pnpm start' with 'pnpm start:init' for initial setup and documents slow startup in development. Adds a debug Webpack script, disables polling in renderer file watching, and only enables CircularDependencyPlugin in production/CI for faster dev builds. WebpackBar now only shows when DEBUG includes 'electron-forge:*'. ForkTsCheckerWebpackPlugin is now configured for async checks with memory limits and test file exclusion. Updates documentation to reflect these changes. * docs: why not vite * refactor: basic vite usage, but wiki worker is not running and view is not showing * refactor: remove lazy inject so vite works and wiki worker works, wiki in browser view can loads * Replace electron-squirrel-startup with inline implementation Added a custom Squirrel event handler in src/helpers/squirrelStartup.ts to handle Windows install/update/uninstall events, replacing the electron-squirrel-startup package. This avoids ESM/CommonJS compatibility issues and simplifies event handling in src/main.ts. * refactor: vite build and test * fix: e2e still use dev wiki folder * fix: provide env * chore: "tiddlywiki": "5.3.7" * Apply suggestion from @Copilot Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Apply suggestion from @Copilot Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Apply suggestion from @Copilot Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Apply suggestion from @Copilot Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * fix: missing i18n * test: Module did not self-register: '/home/runner/work/TidGi-Desktop/TidGi-Desktop/node_modules/better-sqlite3/build/Release/better_sqlite3.node'. * feat: i18n * feat: zh-Hant i18n * Update test.yml * feat: zh-Hans in test * test: i18n * refactor: ts forge config * lint: fix * chore: update wiki * Update pnpm-lock.yaml * chore: update github action versions * Update wiki * fix: pnpm then node * fix: Multiple versions of pnpm specified * Update test.yml * fix: Failed to take screenshot: page.screenshot: Target page, context or browser has been closed * chore: CodeQL Action major versions v1 and v2 have been deprecated. * chore: parallel codeql * Update test.yml * fix: i18n test not passing * test: step screenshot in each folder * fix: can't unzip, may due to file path * test: increase timeout in CI * docs: more log about wiki creation, and add log to criticial path * Refactor: logging for structured and consistent output Replaces string-based logger messages with structured logging throughout the codebase, providing function names, error messages, and relevant context as objects. This improves log readability, enables better filtering and searching, and standardizes error and debug reporting across services. * chore: debug wiki copy * fix: wiki submodule not cloned * Revert "test: increase timeout in CI" This reverts commiteff8583a01. * test: reduce wait time, because most check already will wait for a while * test: batch some e2e steps to reduce screenshot count * Update index.ts * chore: remove webpack files, use vite plugins --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
154 lines
9.6 KiB
Markdown
154 lines
9.6 KiB
Markdown
<div align="center">
|
||
<h1> 太记 </h1>
|
||
<p>可定制性极强的个人知识管理系统，使用 Git 作为备份管理器和博客平台</p>
|
||
|
||
[](LICENSE)
|
||
[](https://github.com/tiddly-gittly/TidGi-Desktop/actions)
|
||
[](https://github.com/linonetwo)
|
||
|
||
</div>
|
||
|
||
| [最新版下载按钮](https://github.com/tiddly-gittly/TidGi-Desktop/releases/latest) |
|
||
| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
||
| [](https://github.com/tiddly-gittly/TidGi-Desktop/releases/latest) |
|
||
|
||
## 产品截图及试用
|
||
|
||
### 试用
|
||
|
||
- [在线网页版博客 Demo](https://tiddly-gittly.github.io/Tiddlywiki-NodeJS-Github-Template/)
|
||
- [太微官网](https://tiddlywiki.com/)
|
||
|
||
### 截图
|
||
|
||
|
||
|
||
<details>
|
||
|
||
| 加载 NodeJS 版维基 |
|
||
| :-----------------------------------------------------: |
|
||
|  |
|
||
|
||
| 新建本地维基 | 下载云端维基 |
|
||
| :---------------------------------------------------------: | :-------------------------------------------------------------: |
|
||
|  |  |
|
||
|
||
| 多语言翻译和设置界面 |
|
||
| :--------------------------------------------------------------------------------------------------------------------------------------------------: |
|
||
|  |
|
||
| 交互式代码执行 |
|
||
|  |
|
||
| 社区插件源 |
|
||
|  |
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Mac 使用者点击这里展开操作方法，我费劲办法也申请不到苹果开发者账号，所以你得手动信任这个应用 ◀</summary>
|
||
|
||
首先你得把应用拖入「应用程序」文件夹才能使用！不然会弹一个报错框。
|
||
|
||
点击「取消」 ↓
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
点击「打开」 ↓
|
||
|
||
|
||
|
||
点击「允许」 ↓
|
||
|
||
|
||
|
||
</details>
|
||
|
||
## 相关介绍
|
||
|
||
[用 TiddlyWiki 替代 Notion 和 EverNote 作为个人知识管理系统(Chinese)](https://zhuanlan.zhihu.com/p/140473235)
|
||
|
||
[墨屉-先进的间隔重复和渐进阅读解决方案](https://live.bilibili.com/23806126)
|
||
|
||
## 关于「太记-桌面版」
|
||
|
||
「太记」是一个跨平台的笔记软件、时间和任务管理工具、碎片化知识管理工具，此乃其桌面版。「太记」基于强大的 [NodeJS 版「太微（TiddlyWiki）」](https://github.com/Jermolene/TiddlyWiki5#installing-tiddlywiki-on-nodejs) 构建，并带上了大量来自[太微社区（TiddlyWiki community）](https://groups.google.com/forum/#!forum/tiddlywiki)的插件。
|
||
|
||
「太记」来自 TiddlyWiki 的译名「太微」，以及曾用名 TiddlyGit 首字母的谐音（后来我们又根据中文谐音把英文名改成了 TidGi）。当然你也可以直接叫它 [TGNote](https://github.com/tiddly-gittly/TGNote)，镰锤 ☭ 笔记。
|
||
|
||
为什么把 TiddlyWiki 翻译成「太微」？因为受到 @pimgeek 的启发：TiddlyWiki 可以干很多细致轻量的工作，但也从不限制用法，可以无限组合叠加。故以其首字母音译为「太微」，TiddlyWiki 可以称为「太微笔记」「太微万能抽屉」「太微卡片盒」……
|
||
|
||
> 太微垣，三垣之一，按《步天歌》，太微垣為三垣的上垣。
|
||
> 太微垣又名天庭，是政府的意思，也是貴族及大臣們居住的地方。
|
||
|
||
## 下载
|
||
|
||
<a href="https://repology.org/project/tidgi/versions">
|
||
<img src="https://repology.org/badge/vertical-allrepos/tidgi.svg" alt="Packaging status">
|
||
</a>
|
||
|
||
> Win 和 Mac 的普通用户直接下载 App
|
||
|
||
| [最新版下载按钮](https://github.com/tiddly-gittly/TidGi-Desktop/releases/latest) |
|
||
| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
||
| [](https://github.com/tiddly-gittly/TidGi-Desktop/releases/latest) |
|
||
|
||
> For arch user
|
||
|
||
```bash
|
||
yay tidgi
|
||
```
|
||
|
||
> Mac 命令行用户
|
||
|
||
```bash
|
||
brew install TidGi # Not tested
|
||
```
|
||
|
||
## 移动端应用
|
||
|
||
See [Tiddloid](https://github.com/donmor/Tiddloid) for Android App developed by donmor.
|
||
|
||
## 数据隐私保护
|
||
|
||
你可以选择你的 WIKI 工作区的存储服务提供商：
|
||
|
||
1. 「Github」是一个无限存储空间、可以用 GH-Pages 部署博客的平台。
|
||
1. 「本地」模式会创建一个本地仓库来备份你的 WIKI，你可以用 [GithubDesktop](https://github.com/desktop/desktop) 来手动同步内容到云端。
|
||
1. 「Gitlab」和「码云」还待支持，不过架子已经搭好了。
|
||
|
||
## 与竞品的差异
|
||
|
||
### 与 [TiddlyDesktop](https://github.com/Jermolene/TiddlyDesktop) 的差别？
|
||
|
||
1. 太微的 NodeJS 版本有无缝的自动保存体验，这是利用 SyncAdaptor 技术（而不是 Saver ）带来的的优势，太记对 NodeJS wiki 有更好的支持，而 TD 主要支持 HTML 版单文件 WIKI，各有优势。
|
||
1. 使用 NodeJS wiki 时，我们可以有分离的 tiddler 文件，这些文件可以手工修改，也可以由其他程序修改（例如装了 [VSCode-TW5-Syntax](https://github.com/joshuafontany/VSCode-TW5-Syntax) 的 VSCode)，而且方便细粒度备份回滚
|
||
1. 尽管 TiddlyDesktop 也可以加载由 nodejs 版太微生成的 wiki 文件夹，但太记还可以轻松地将该文件夹自动备份到 Github 上。
|
||
1. 通过使用 Electron 技术，我们可以在太微中使用 `fs` 、 `git` 和许多其他 nodejs 的扩展接口，这大大扩展了插件可使用的能力。这种可扩展性也是我选择太微作为我日常知识管理工具的原因，太记进一步强化了它。
|
||
|
||
## 为什么使用 Github 存储
|
||
|
||
因为 Github 是最好的免费民用级[存储即服务（BaaS）](https://www.alibabacloud.com/blog/backend-as-a-service-baas-for-efficient-software-development_519851)之一。
|
||
|
||
1. 它的存储基本上是免费的，允许我们存储无限的图像和 PDF 文件，这些文件可以有永久的 URI 供公众下载。
|
||
1. 它有 GraphQL API，允许我们以程序化的方式更新我们的 wiki。
|
||
1. 它有免费的[CI](https://github.com/features/actions)来自动部署我们的太微博客。
|
||
1. 它提供了无限数量的代码仓库，分为公共的和私有的，这使我们能够将私有内容存储到我们的太微中仅在本地查看，然后只把公开部分部署成博客。
|
||
|
||
## 参与开发
|
||
|
||
阅读[开发指引文档（英文）](../Development.md)
|
||
|
||
## 鸣谢
|
||
|
||
The desktop app shell is based on [https://github.com/atomery/singlebox](atomery/singlebox) and [atomery/webcatalog](https://github.com/atomery/webcatalog), they provide lots of utils around website-generated-app, much powerful than generating app from website simply using Chrome. Also the independent developer @quanglam2807 behind these great tools helps me a lot when I develop TidGi.
|
||
|
||
Current Icon is download from [iconsdb](https://www.iconsdb.com/custom-color/github-11-icon.html) under Creative Commons Attribution-NoDerivs 3.0 , if you are a designer, please feel free to contribute your ICON if you have a better idea.
|
||
|
||
### 点个星星 ⭐️ 吧
|
||
|
||
Please give a star if you like it!
|
||
|
||
[](https://starchart.cc/tiddly-gittly/TidGi-Desktop)
|