mirror of https://github.com/CherryHQ/cherry-studio.git synced 2026-01-09 23:10:20 +08:00

History

George·Dong 2a31fa2ad5 refactor: switch yarn to pnpm (#12260 ) * refactor: switch workflows from yarn to pnpm Replace Yarn usage with pnpm in CI workflows to standardize package management and leverage pnpm's store/cache behavior. - Use pnpm/action-setup to install pnpm (v) instead of enabling corepack and preparing Yarn. - Retrieve pnpm store path and update cache actions to cache the pnpm store and use pnpm-lock.yaml for cache keys and restores. - Replace yarn commands with pnpm equivalents across workflows: install, i18n:sync/translate, format, build:* and tsx invocation. - Avoid committing lockfile changes by resetting pnpm-lock.yaml instead of yarn.lock when checking for changes. - Update install flags: use pnpm install --frozen-lockfile / --install semantics where appropriate. These changes unify dependency tooling, improve caching correctness, and ensure CI uses pnpm-specific lockfile and cache paths. * build: switch pre-commit hook to pnpm lint-staged Update .husky/pre-commit to run pnpm lint-staged instead of yarn. This aligns the pre-commit hook with the project's package manager and ensures lint-staged runs using pnpm's environment and caching. * chore(ci): remove pinned pnpm version from GH Action steps Remove the explicit `with: version: 9` lines from multiple GitHub Actions workflows (auto-i18n.yml, nightly-build.yml, pr-ci.yml, update-app-upgrade-config.yml, sync-to-gitcode.yml, release.yml). The workflows still call `pnpm/action-setup@v4` but no longer hardcode a pnpm version. This simplifies maintenance and allows the action to resolve an appropriate pnpm version (or use its default) without needing updates whenever the pinned version becomes outdated. It reduces churn when bumping pnpm across CI configs and prevents accidental pin drift between workflow files. * build: Update pnpm to 10.27.0 and add onlyBuiltDependencies config * Update @cherrystudio/openai to 6.15.0 and consolidate overrides * Add @langchain/core to overrides * Add override for openai-compatible 1.0.27 * build: optimize pnpm config and add missing dependencies - Comment out shamefully-hoist in .npmrc for better pnpm compatibility - Add React-related packages to optimizeDeps in electron.vite.config.ts - Add missing peer dependencies and packages that were previously hoisted 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * build: refine pnpm configuration and dependency management - Simplify .npmrc to only essential electron mirror config - Move platform-specific dependencies to devDependencies - Pin sharp version to 0.34.3 for consistency - Update sharp-libvips versions to 1.2.4 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * reduce app size * format * build: remove unnecessary disableOxcRecommendation option from react plugin configuration * docs: Replace yarn commands with pnpm in documentation and scripts * Revert "build: optimize pnpm config and add missing dependencies" This reverts commit `acffad31f8`. * build: import dependencies from yarn.lock * build: Add some phantom dependencies and reorganize dependencies * build: Keep consistent by removing types of semver It's not in the previous package.json * build: Add some phantom dependencies Keep same version with yarn.lock * build: Add form-data dependency version 4.0.4 * Add chalk dependency * build: downgrade some dependencies Reference: .yarn-state-copy.yml. These phantom dependencies should use top-level package of that version in node_modules * build: Add phantom dependencies * build: pin tiptap dependencies to exact versions Ensure consistent dependency resolution by removing caret ranges and pinning all @tiptap packages to exact version 3.2.0 * chore: pin embedjs dependencies to exact versions * build: pin @modelcontextprotocol/sdk to exact version 1.23.0 Remove caret from version specifier to prevent automatic upgrades and ensure consistent dependencies * chore: update @types/node dependency to 22.17.2 Update package.json and pnpm-lock.yaml to use @types/node version 22.17.2 instead of 22.19.3 to maintain consistency across dependencies * build: move some dependencies to dev deps and pin dependency versions to exact numbers Remove caret (^) from version ranges to ensure consistent dependency resolution across environments * chore: move dependencies from prod to dev and update lockfile Move @ant-design/icons, chalk, form-data, and open from dependencies to devDependencies Update pnpm-lock.yaml to reflect dependency changes * build: update package dependencies - Add new dependencies: md5, @libsql/win32-x64-msvc, @strongtz/win32-arm64-msvc, bonjour-service, emoji-picker-element-data, gray-matter, js-yaml - Remove redundant dependencies from devDependencies * build: add cors, katex and pako dependencies add new dependencies to support cross-origin requests, mathematical notation rendering and data compression * move some js deps to dev deps * test: update snapshot tests for Spinner and InputEmbeddingDimension * chore: exclude .zed directory from biome formatting * Update @ai-sdk/openai-compatible patch hash * chore: update @kangfenmao/keyv-storage to version 0.1.3 in package.json and pnpm-lock.yaml --------- Co-authored-by: icarus <eurfelux@gmail.com> Co-authored-by: beyondkmp <beyondkmp@gmail.com> Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com> Co-authored-by: kangfenmao <kangfenmao@qq.com>		2026-01-05 22:16:34 +08:00
..
assets/images	docs: update `docs` directory structure	2025-11-26 13:17:01 +08:00
en	refactor: switch yarn to pnpm (#12260 )	2026-01-05 22:16:34 +08:00
zh	refactor: switch yarn to pnpm (#12260 )	2026-01-05 22:16:34 +08:00
README.md	docs: update `docs` directory structure	2025-11-26 13:17:01 +08:00

README.md

Cherry Studio Documentation / 文档

This directory contains the project documentation in multiple languages.

本目录包含多语言项目文档。

Languages / 语言

中文文档 - Chinese Documentation
English Documentation - See sections below

English Documentation

Guides

Document	Description
Development Setup	Development environment setup
Branching Strategy	Git branching workflow
i18n Guide	Internationalization guide
Logging Guide	How to use the logger service
Test Plan	Test plan and release channels

References

Document	Description
App Upgrade Config	Application upgrade configuration
CodeBlockView Component	Code block view component
Image Preview Components	Image preview components

中文文档

指南 (Guides)

文档	说明
开发环境设置	开发环境配置
贡献指南	如何贡献代码
分支策略	Git 分支工作流
测试计划	测试计划和发布通道
国际化指南	国际化开发指南
日志使用指南	如何使用日志服务
中间件开发	如何编写中间件
记忆功能	记忆功能使用指南
赞助信息	赞助相关信息

参考 (References)

文档	说明
消息系统	消息系统架构和 API
数据库结构	数据库表结构
服务	服务层文档 (KnowledgeService)
代码执行	代码执行功能
应用升级配置	应用升级配置
CodeBlockView 组件	代码块视图组件
图像预览组件	图像预览组件

Missing Translations / 缺少翻译

The following documents are only available in Chinese and need English translations:

以下文档仅有中文版本，需要英文翻译：

guides/contributing.md
guides/memory.md
guides/middleware.md
guides/sponsor.md
references/message-system.md
references/database.md
references/services.md
references/code-execution.md