跳转到主要内容
Jiewen’blog
开发与定制

项目结构与开发命令

适用版本:TinyTale 小程序 3.0.0 / TinyTale 配置插件 2.1.2。

本章面向需要修改源码的开发者。普通站长完成前面的安装、配置和发布流程即可运行项目。

小程序工程

TinyTale Next 使用 Vue 3、TypeScript、uni-app、图鸟 UI、Pinia、UnoCSS 和 Alova。新增界面时,应按当前依赖版本选用组件与 API。

以下为主要目录与入口文件节选,省略号表示该目录还有其他内容。

  • TinyTale-Next小程序工程根目录
    • src小程序源码
      • pages主页面
        • index
          • index.vue重点主页面容器
            • components首页、分类、图库、瞬间、关于等主页面内容
              • …目录内容省略
          • subPackages文章、搜索、归档、账号、设置和发布等分包页面
            • …目录内容省略
            • components通用组件、登录面板、分享和富文本包装等
              • …目录内容省略
              • business评论等业务组件
                • …目录内容省略
                • api请求、上传、TinyTale、Halo 内容与管理接口
                  • …目录内容省略
                  • store配置、内容、用户会话及展示偏好
                    • …目录内容省略
                    • styles
                      • theme.scss重点页面主题变量与公共样式
                      • theme
                        • tokens.ts原生运行时使用的主题值
                      • packages本地工作区包
                        • mp-html-tinytale本地维护的富文本工作区包
                          • …目录内容省略
                        • manifest.config.ts重点uni-app 应用信息与微信 AppID 配置
                          • uno.config.tsUnoCSS 工具类、主题映射与快捷类
                            • .env.development重点开发环境站点与 AppID
                              • .env.production重点正式构建站点与 AppID
                                • pnpm-workspace.yaml工作区配置
                                  • pnpm-lock.yaml依赖锁文件

                                  环境文件、工作区配置与锁文件同样属于完整工程的一部分。生成的 dist 目录用于运行或上传,不作为长期修改源码的入口。

                                  常用命令

                                  在小程序工程根目录执行:

                                  pnpm install
                                  

                                  安装依赖后,按本次目标选择一项命令:

                                  微信开发预览

                                  pnpm dev:mp-weixin
                                  

                                  微信正式构建

                                  pnpm build:mp-weixin
                                  

                                  H5 开发预览

                                  pnpm dev:h5
                                  

                                  开发输出为 dist/dev/mp-weixin,正式输出为 dist/build/mp-weixin。H5 调试可以使用 pnpm dev:h5,构建使用 pnpm build:h5;微信登录、原生分享与其他平台能力仍需在微信环境验证。

                                  有代码变更时,根据影响范围使用现有检查:

                                  pnpm type-check
                                  pnpm lint
                                  pnpm test:auth
                                  pnpm test:comments
                                  

                                  认证与评论脚本覆盖各自的部分逻辑,不能替代完整业务回归和真机输入法测试。pnpm lint:fix 会修改文件,使用前先查看工作区差异。

                                  配置插件工程

                                  插件工程 plugin-TinyTale 包含 Java 服务端、Halo 资源描述及 Console 界面。关键入口包括 TinyTaleEndpoint.java、src/main/resources/extensions/settings.yaml、src/main/resources/plugin.yaml 和角色模板;Console 前端位于 ui。

                                  自行构建需要 Java 21,并满足项目 Gradle 及依赖仓库要求。在插件工程根目录执行:

                                  ./gradlew build
                                  

                                  当前可部署产物为 build/libs/TinyTale-config-2.1.2.jar。构建流程会校验 JAR 根目录中的插件描述文件。私有依赖仓库需要凭据时,按工程说明配置本地环境,不把凭据写入公开源码。

                                  进一步定制见页面、主题与富文本,认证与调用规则见接口说明。

                                  文档导航