30 |
31 | ![]()
32 |
33 | {{ contributor }}
34 |
35 | 9 | 以下排名不分先后（参与或主动提 PR 申请加入） 10 |
11 |$1') 7 | .replace(/\*\*(.*)\*\*/gim, '$1') 8 | .replace(/\*(.*)\*/gim, '$1') 9 | .replace(/!\[(.*?)\]\((.*?)\)/gim, "
$1')
12 | .replace(/\n$/gim, '
70 | };
71 | }
72 | return res;
73 | };
74 | test();
75 | ```
76 |
--------------------------------------------------------------------------------
/docs/YaoDSL/v8go/小心字节处理.md:
--------------------------------------------------------------------------------
1 | # 小心字节处理
2 |
3 | ## 字节处理
4 |
5 | 在 yao 中使用 js 处理字节数组时需要小心.
6 |
7 | 这个脚本不正常，如果在 js 脚本中读取了字节数组,并把字节数组作为 json 对象的属性返回时，将得不到你想要的结果，比如这里读取的图片内容，在 API 中输出时会显示一系列的数组，而不是字节码。
8 |
9 | ```js
10 | function Download() {
11 | let fs = new FS('system');
12 |
13 | const buf = fs.ReadFileBuffer('/upload/1/20231115/微信图片.png');
14 | //
15 | return {
16 | content: buf,
17 | type: 'image/png'
18 | };
19 | }
20 | ```
21 |
22 | 这个脚本正常，可以直接返回字节数组，没有包含在对象中。
23 |
24 | ```js
25 | function Download() {
26 | let fs = new FS('system');
27 |
28 | const buf = fs.ReadFileBuffer(
29 | '/upload/1/20231115/微信图片_20220601141654.png'
30 | );
31 | return buf;
32 | }
33 | ```
34 |
35 | 问题在原因在于，在 yao 中把 js 对象转换成 go 对象时，使用的是 js 的 json.marshal 与 go 的 jsoniter.Unmarshal。这个转换过程中，js 的字节 uint32 数组会转换成 float64 的数组。最后导致数据结构发生变化。
36 |
37 | `/gou/runtime/v8/bridge/bridge.go`
38 |
39 | ```go
40 | func goValueParse(value *v8go.Value, v interface{}) (interface{}, error) {
41 |
42 | data, err := value.MarshalJSON()
43 | if err != nil {
44 | return nil, err
45 | }
46 |
47 | ptr := &v
48 | // 字节数组类型发生变化。
49 | err = jsoniter.Unmarshal(data, ptr)
50 | if err != nil {
51 | fmt.Printf("---\n%s\n---\n", data)
52 | return nil, err
53 | }
54 |
55 | return *ptr, nil
56 | }
57 | ```
58 |
59 | ## 替代方案
60 |
61 | 使用 flow，来操作文件的下载读取。
62 |
63 | ```json
64 | {
65 | "label": "下载文件",
66 | "version": "1.0.0",
67 | "description": "下载文件",
68 | "nodes": [
69 | {
70 | "name": "filename",
71 | "process": "scripts.system.file.getFileName",
72 | "args": ["{{$in.0}}"]
73 | },
74 | {
75 | "name": "下载文件",
76 | "process": "fs.system.Download",
77 | "args": ["{{$res.filename}}"]
78 | }
79 | ],
80 | "output": "{{$res.下载文件}}"
81 | }
82 | ```
83 |
84 | ## 总结
85 |
86 | 避免在 js 脚本中与 golang 之间进行大量的字节转换操作，比如读取转换文件。针对于类似的场景处理方案最好是使用 golang 的程序进行处理，避免使用脚本进行转换。同时 bytes 在转换过程也会消耗大量的内存，转换过程中也是按字节进行赋值处理。
87 |
--------------------------------------------------------------------------------
/docs/YaoDSL/处理器/Array转树形结构.md:
--------------------------------------------------------------------------------
1 | # Array 转树形结构
2 |
3 | 处理器`xiang.helper.ArrayTree`或是`utils.arr.Tree`，传入有父子节点关系的对象数组，返回转换后树形结构数据。转换后的子节点的数据保存在`children`属性中，可嵌套。
4 |
5 | 典型的应用是转换保存在数据库中的菜单数据成 JSON 对象。
6 |
7 | - 参数 1： 记录集合
8 | - 参数 2： 数据转换配置项，配置项定义：
9 |
10 | ```go
11 | // ArrayTreeOption Array转树形结构参数表
12 | type ArrayTreeOption struct {
13 | Key string `json:"id"` // 主键名称, 默认为 id
14 | Empty interface{} `json:"empty"` // Top节点 parent 数值, 默认为 0
15 | Parent string `json:"parent"` // 父节点字段名称, 默认为 parent
16 | Children string `json:"children"` // 子节点字段名称, 默认为 children
17 | }
18 |
19 | ```
20 |
21 | 一般会设置`empty=null`与`parent`，表示如果这个`parent`对应的字段如果是空值说明是树顶点。
22 |
23 | 示例
24 |
25 | ```js
26 | res = Process('xiang.helper.ArrayTree', cate, {
27 | parent: 'parent_id',
28 | empty: null
29 | });
30 | ```
31 |
32 | 删除空对象
33 |
34 | ```js
35 | function removeEmpty(obj) {
36 | for (var prop in obj) {
37 | if (obj[prop] === null || obj[prop] === undefined) {
38 | delete obj[prop];
39 | } else if (typeof obj[prop] === 'object') {
40 | removeEmpty(obj[prop]);
41 | if (Array.isArray(obj[prop]) && obj[prop].length === 0) {
42 | delete obj[prop];
43 | } else if (Object.keys(obj[prop]).length === 0) {
44 | delete obj[prop];
45 | }
46 | }
47 | }
48 | return obj;
49 | }
50 | ```
51 |
--------------------------------------------------------------------------------
/docs/YaoDSL/处理器/Log.md:
--------------------------------------------------------------------------------
1 | # log 打印调试信息
2 |
3 | Log 打印调试信息，方便定位问题。
4 |
5 | ## 示例
6 |
7 | log 打印位置 `logs/application.log` 打印日志:
8 |
9 | ```javascript
10 | log.Error('%v', foo);
11 | log.Info('foo');
12 | ```
13 |
14 | 输出以下信息:
15 |
16 | ```
17 | time="2022-08-25T10:00:28Z" level=error msg=foo
18 | time="2022-08-25T10:00:28Z" level=info msg=foo
19 |
20 | ```
21 |
--------------------------------------------------------------------------------
/docs/YaoDSL/处理器/index.md:
--------------------------------------------------------------------------------
1 | # 处理器
2 |
3 |
4 |
5 | - [处理器列表](处理器列表.md)
6 | - [会话数据](会话数据.md)
7 | - [加密解密](加密解密.md)
8 | - [日期处理](日期处理.md)
9 | - [使用处理器](使用处理器.md)
10 | - [数据图表](数据图表.md)
11 | - [数据处理](数据处理.md)
12 | - [数据导入](数据导入.md)
13 | - [数据表格](数据表格.md)
14 | - [网络请求](网络请求.md)
15 | - [文件处理](文件处理.md)
16 | - [应用引擎](应用引擎.md)
17 | - [Array转树形结构](Array转树形结构.md)
18 | - [Log](Log.md)
19 |
20 |
--------------------------------------------------------------------------------
/docs/YaoDSL/处理器/会话数据.md:
--------------------------------------------------------------------------------
1 | # 会话数据
2 |
3 | 用户会话数据处理器
4 |
5 | | 处理器 | 说明 | 文档 |
6 | | ---------------- | ---------------- | ---- |
7 | | session.Start | 启用会话 | |
8 | | session.ID | 读取会话 ID | |
9 | | session.Get | 读取会话变量 | |
10 | | session.Set | 设置会话变量 | |
11 | | session.MultiSet | 批量设置会话变量 | |
12 | | session.Dump | 返回所有会话数据 | |
13 |
14 | 设置 Session 的值，新建`flows/session.flow.json`,args 的三个参数分别对应：session 的 key，session 的值，过期时间
15 |
16 | ```json
17 | {
18 | "label": "session",
19 | "version": "1.0.0",
20 | "description": "session",
21 | "nodes": [
22 | {
23 | "name": "SID",
24 | "process": "session.start"
25 | },
26 | {
27 | "name": "设置会话数据",
28 | "process": "session.set",
29 | "args": ["user", "123456", 28800]
30 | }
31 | ],
32 | "output": "success"
33 | }
34 | ```
35 |
36 | 设置好 session 后，可以使用`Process("session.Get", "user")`来获取对应的值
37 |
--------------------------------------------------------------------------------
/docs/YaoDSL/处理器/加密解密.md:
--------------------------------------------------------------------------------
1 | # 加密解密
2 |
3 | 加密解密处理器，参考文档 对照表
4 |
5 | | 处理器 | 说明 | 使用方法 |
6 | | ---------------------- | ----------------------------------------------------------------- | --------------------------------------------------------- |
7 | | yao.crypto.hmac | 使用 SHA1 加密，自带 base64 加密 | Process("yao.crypto.hmac", "SHA1", value, key, "base64"); |
8 | | encoding.base64.Encode | 使用 base64 加密 | Process("encoding.base64.Encode", str); |
9 | | encoding.base64.Decode | 使用 base64 解密 | Process("encoding.base64.Decode", str); |
10 | | yao.crypto.hash | 使用各种加密方法 ，第一个参数可填写：MD4，MD5 ，SHA1 ，SHA256 ... | Process("yao.crypto.hash", "SHA1", str); |
11 | | |
12 |
--------------------------------------------------------------------------------
/docs/YaoDSL/处理器/数据图表.md:
--------------------------------------------------------------------------------
1 | # 数据图表
2 |
3 | 数据看板、分析图表、数据大屏相关处理器。
4 |
5 | | 处理器 | 说明 | 参数说明 |
6 | | ------------------- | ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- |
7 | | yao.chart.setting | 读取图表配置信息，用于前端界面渲染。通过图表的 Action.Setting 配置执行相应处理器。 | - |
8 | | yao.chart.xgen | 生成图表的前端配置数据。支持传入自定义数据和权限排除项，用于生成最终的图表展示配置。 | data: object 自定义数据
excludes: array 权限排除项 |
9 | | yao.chart.component | 执行图表组件相关的查询操作。用于处理图表中特定组件的数据获取需求。 | xpath: string 组件路径
method: string 方法名
query?: object 查询参数 |
10 | | yao.chart.data | 获取图表数据。通过图表的 Action.Data 配置执行相应处理器，返回图表所需的数据结果。 | - |
11 |
12 | ## 使用示例
13 |
14 | ### 在图表 DSL 中配置处理器
15 |
16 | ```json
17 | {
18 | "action": {
19 | "data": {
20 | "process": "scripts.stat.daily",
21 | "default": ["$G.TODAY"]
22 | },
23 | "setting": {
24 | "process": "scripts.chart.setting"
25 | }
26 | }
27 | }
28 | ```
29 |
30 | ### 在数据流中使用
31 |
32 | ```json
33 | {
34 | "nodes": [
35 | {
36 | "name": "图表数据",
37 | "process": "yao.chart.Data",
38 | "args": ["sales-chart"]
39 | }
40 | ]
41 | }
42 | ```
43 |
--------------------------------------------------------------------------------
/docs/YaoDSL/处理器/数据表格.md:
--------------------------------------------------------------------------------
1 | # 数据表格
2 |
3 | 数据表格相关处理器。
4 |
5 | 数据表格用来处理列表页面的表格布局
6 |
7 | `tables`表格中内置了许多处理器为我们提供完整的表格数据/布局处理，命名空间为 table.<表格名称>；
8 |
9 | | 处理器 | 说明 | 文档 ` |
10 | | --------------------- | ---------------------------------------- | ------ |
11 | | yao.table.Search | 按条件查询, 分页。 | |
12 | | yao.table.Find | 按主键查询单条数据。 | |
13 | | yao.table.Select | 返回数据集合，匹配选择器组件数据结构。 | |
14 | | yao.table.Save | 保存单条记录，指定主键更新，不指定创建。 | |
15 | | yao.table.Delete | 按主键删除单条记录。 | |
16 | | yao.table.Insert | 批量新增记录。 | |
17 | | yao.table.UpdateWhere | 批量更新符合条件的记录。 | |
18 | | yao.table.DeleteWhere | 批量删除符合条件的记录。 | |
19 | | yao.table.QuickSave | 保存多条记录，指定主键更新，不指定创建。 | |
20 | | yao.table.UpdateIn | 批量更新指定一组主键的的数据记录。 | |
21 | | yao.table.DeleteIn | 批量删除指定一组主键的的数据记录。 | |
22 | | yao.table.Setting | 读取数据表格配置信息, 用于前端界面渲染 | |
23 |
--------------------------------------------------------------------------------
/docs/YaoDSL/处理器/日期处理.md:
--------------------------------------------------------------------------------
1 | # 日期处理
2 |
--------------------------------------------------------------------------------
/docs/algolia.json:
--------------------------------------------------------------------------------
1 | {
2 | "index_name": "yao-docs",
3 | "start_urls": ["https://wwsheng009.github.io/yao-docs"],
4 | "rateLimit": 8,
5 | "maxDepth": 10,
6 | "selectors": {
7 | "lvl0": {
8 | "selector": "",
9 | "defaultValue": "Documentation"
10 | },
11 | "lvl1": ".content h1",
12 | "lvl2": ".content h2",
13 | "lvl3": ".content h3",
14 | "lvl4": ".content h4",
15 | "lvl5": ".content h5",
16 | "lang": {
17 | "selector": "/html/@lang",
18 | "type": "xpath",
19 | "defaultValue": ["zh-CN"]
20 | },
21 | "content": ".content p, .content li"
22 | },
23 | "selectors_exclude": [
24 | "aside",
25 | ".page-footer",
26 | ".next-and-prev-link",
27 | ".table-of-contents"
28 | ],
29 | "custom_settings": {
30 | "attributesForFaceting": ["lang"]
31 | },
32 | "js_render": true
33 | }
34 |
--------------------------------------------------------------------------------
/docs/contributing.md:
--------------------------------------------------------------------------------
1 | # 欢迎参与贡献，提 PR
2 |
3 | ## 贡献指南
4 |
5 | 可在 [github](https://github.com/wwsheng009/yao-docs) 页 fork 一份仓库代码，然后基于 fork 后的提 PR 过来。
6 |
7 | 推荐使用 pnpm 安装：
8 |
9 | ```bash
10 | pnpm install
11 | ```
12 |
13 | 本地环境开发：
14 |
15 | ```bash
16 | pnpm dev
17 | ```
18 |
19 | ## 文章贡献
20 |
21 | 对于文章贡献，分两种情况：
22 |
23 | - 如果你是原创作者，请在 `author` 字段填写自己的 GitHub 账号名，会自动在文章末尾进行声明。
24 |
25 | - 如果你是修正某篇文章，请在 `contributors` 字段增加自己的 GitHub 账号名，也会有贡献者头像，并不会修改原作者信息。
26 |
27 | ```md
28 | ---
29 | author: Vincent Wang
30 | contributors: [HearLing]
31 | ---
32 | ```
33 |
34 | ## 代码格式
35 |
36 | 对于代码格式，本仓库使用 `prettier` 与 `git-hooks`，在你提交代码的时候会进行格式化以及修复一些问题。
37 |
38 | 也可以手动执行一下：
39 |
40 | ```bash
41 | pnpm prettier:fix
42 | ```
43 |
44 | 提交之前需要`build`检查有没有错误。
45 |
46 | ```bash
47 | pnpm run build && pnpm run serve
48 | ```
49 |
50 | 重建所有的`index.md`文件
51 |
52 | ```bash
53 | pnpm run build:index
54 | ```
55 |
56 | ## 贡献者列表
57 |
58 | 推荐大家自行填写相关信息，只需要在 `docs/index.md` 文件内添加自己的相关信息即可，无需修改 `contributors.json` 文件，该文件会自动生成。
59 |
60 | ## 文字排版
61 |
62 | 笔记内容按照 [中文文案排版指北](https://mazhuang.org/wiki/chinese-copywriting-guidelines/)进行排版，即尽量保证中英文之间的空格，也可以使用 VSCode 相关格式化工具。
63 |
64 | `md`的文档格使用`pritter`配合`vscode`的插件[`esbenp.prettier-vscode`](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
65 |
66 | ## 感谢参与
67 |
68 | 非常感谢你对于 [ChoDocs](https://github.com/chodocs/chodocs) 的参与贡献，我们会在首页 [chodocs.cn](https://chodocs.cn/) 展示各位贡献者的头像！
69 |
--------------------------------------------------------------------------------
/docs/contributors.json:
--------------------------------------------------------------------------------
1 | ["wwsheng009", "AbbetWang"]
2 |
--------------------------------------------------------------------------------
/docs/contributors.ts:
--------------------------------------------------------------------------------
1 | import contributors from './contributors.json';
2 |
3 | export interface Contributor {
4 | name: string;
5 | avatar: string;
6 | }
7 |
8 | export interface CoreTeam {
9 | avatar: string;
10 | name: string;
11 | github: string;
12 | twitter?: string;
13 | sponsors?: boolean;
14 | description: string;
15 | packages?: string[];
16 | functions?: string[];
17 | }
18 |
19 | const contributorsAvatars: Record = {};
20 |
21 | const getAvatarUrl = (name: string) => `https://github.com/${name}.png`;
22 |
23 | const contributorList = (contributors as string[]).reduce((acc, name) => {
24 | contributorsAvatars[name] = getAvatarUrl(name);
25 | acc.push({ name, avatar: contributorsAvatars[name] });
26 | return acc;
27 | }, [] as Contributor[]);
28 |
29 | export { contributorList as contributors };
30 |
--------------------------------------------------------------------------------
/docs/index.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: home
3 |
4 | title: Yao
5 | titleTemplate: 学习笔记
6 |
7 | hero:
8 | name: 分享
9 | text: 努力学习，天天向上
10 | tagline: 学习，总结，分享，成长
11 | actions:
12 | - theme: brand
13 | text: 开始学习
14 | link: /%E5%85%A5%E9%97%A8%E6%8C%87%E5%8D%97/readme.md
15 | - theme: alt
16 | text: 源代码
17 | link: https://github.com/wwsheng009/yao-docs
18 |
19 | features:
20 | - icon: 📝
21 | title: 入门指南
22 | details: 新手如何快速上手使用Yao.
23 | link: /入门指南/
24 | linkText: '入门指南'
25 | - icon: ❤️
26 | title: 常用的项目模板
27 | details: 包含简单的，复杂的项目模板.
28 | link: /%E5%85%A5%E9%97%A8%E6%8C%87%E5%8D%97/readme.md
29 | linkText: '项目模板'
30 | - icon: 🔥
31 | title: Yao引擎源代码分析
32 | details: 使用drawio绘制了Yao引擎的结构与原理.
33 | link: /流程图/
34 | linkText: 流程图
35 | - icon: 🚀
36 | title: 好用的插件
37 | details: 使用Studio插件/Vscode插件提升开发效率.
38 | link: /Studio/
39 | linkText: 编辑器
40 | ---
41 |
42 | 
45 |
46 |
47 | ## 📄 License
48 |
49 | LICENSE
50 | © 2023-PRESENT [Vincent Wang](https://github.com/wwsheng009)
51 |
--------------------------------------------------------------------------------
/docs/入门指南/上手系列/1 Yao下载与安装.md:
--------------------------------------------------------------------------------
1 | # yao 下载与安装
2 |
3 | 如何安装 Yao
4 |
5 | 这里说的 Yao 是指 Yao 引擎的执行程序。安装 Yao 只需要下载一个执行程序就可以了。
6 |
7 | ## yao 版本
8 |
9 | 需要注意的时，yao 的应用需要使用特定版本的 yao 的执行程序。
10 |
11 | 在升级 yao 执行程序之前，可以给执行程序加个后缀，比如加上版本编号。可以直接另命名 yao 应用程序，不用担心程序依赖问题。
12 |
13 | ```sh
14 | # yao程序版本管理
15 | mv /usr/local/bin/yao /usr/local/bin/yao-0.10.2
16 |
17 | # 使用特定版本的yao启动你的应用
18 | yao-0.10.2 start
19 | ```
20 |
21 | ## 下载 Yao 程序
22 |
23 | ### 官方发行版本
24 |
25 | 官方在重大功能更新后会发布新的版本。
26 |
27 | 访问地址：https://yaoapps.com/release
28 |
29 | 在发布页面可以看到各个版本的下载地址与相关的说明。
30 |
31 | 找到合适的版本后，点击下载按钮后，会自动一个没有后缀的二进制文件。只需要把这个文件放到目录`/usr/local/bin/`即可。
32 |
33 | 比如下载安装 0.10.3 版本程序：
34 |
35 | ```sh
36 |
37 | wget https://release-bj.yaoapps.com/archives/yao-0.10.3-linux-amd64
38 |
39 | # 移动程序到bin目录
40 | mv yao-0.10.3-linux-amd64 /usr/local/bin/yao
41 |
42 | # 加上程序执行权限
43 | chmod +x /usr/local/bin/yao
44 |
45 | # 版本检查
46 | yao version --all
47 | ```
48 |
49 | ### 开发版本
50 |
51 | 开发版本的会有最新的特性与功能。从 github 的 actions 中可以找到最新的开发版本。
52 |
53 | https://github.com/YaoApp/yao/actions
54 |
55 | 按照自己的操作系统类别找到对应的制品程序。
56 |
57 | - MacOS intel/m1/m2
58 | - Linux amd64/arm64
59 |
60 | 0.10.3 版本 Linux
61 |
62 | https://github.com/YaoApp/yao/actions/workflows/build-linux-dev.yml
63 |
64 | 这里无法使用命令下载，需要在浏览器中下载。
65 |
66 | 下载后是一个 zip 压缩包，里面包含了 arm64 与 amd64 版本的程序。
67 |
68 | ```sh
69 | # 移动程序到bin目录
70 | mv yao-0.10.3-linux-amd64 /usr/local/bin/yao
71 |
72 | # 加上程序执行权限
73 | chmod +x /usr/local/bin/yao
74 |
75 | # 版本检查
76 | yao version --all
77 | ```
78 |
79 | ## 总结
80 |
81 | Yao 执行程序就一个二进制的文件，可以直接移动或是删除。
82 |
83 | Yao 各个版本的差异比较大，需要仔细辨别。
84 |
--------------------------------------------------------------------------------
/docs/入门指南/上手系列/4 生成数据库表.md:
--------------------------------------------------------------------------------
1 | # 根据模型生成数据库表
2 |
3 | 比如你在 hello_world 目录下创建一个新的模型`book`。
4 |
5 | `models/book.mod.yao`
6 |
7 | ```jsonc
8 | {
9 | "name": "Book",
10 | "table": {
11 | "name": "book" //这个模型在数据库中关联的表名是`book`。
12 | },
13 | "columns": [
14 | {
15 | "name": "id",
16 | "label": "ID",
17 | "type": "ID"
18 | },
19 | {
20 | "name": "title",
21 | "label": "Title",
22 | "type": "string",
23 | "length": 256,
24 | "index": true,
25 | "nullable": true
26 | },
27 | {
28 | "name": "author",
29 | "label": "Author",
30 | "type": "string",
31 | "length": 256,
32 | "index": true,
33 | "nullable": true
34 | },
35 | {
36 | "name": "publisher",
37 | "label": "Publisher",
38 | "type": "string",
39 | "length": 256,
40 | "index": true,
41 | "nullable": true
42 | }
43 | ]
44 | }
45 | ```
46 |
47 | 模型保存后，需要执行一个 yao 命令，把模型转换成数据库中的表。打开控制台,执行以下的命令。
48 |
49 | ```sh
50 | # mysql
51 | yao migrate -n book
52 |
53 | # sqlite，需要加上--reset，
54 | yao migrate -n book --reset
55 | ```
56 |
57 | 提示：reset 的作用是删除整个数据库表后再重新创建，不要在生产环境执行，会导致数据丢失。
58 |
59 | 成功后控制台会输出以下的内容。
60 |
61 | ```sh
62 | 更新表结构 model: book (book) SUCCESS
63 | ```
64 |
65 | 上面命令的作用是把 Yao 模型定义转换成数据库表结构。如果模型对应的数据库表已经存在就更新，如果不存在创建新表。
66 |
67 | > 后面如果对模型文档有变更，也需要手动执行命令才会把模型更新到数据库。
68 |
69 | ## 总结
70 |
71 | Yao 命令也是 Yao 开发中的重要组成部分。
72 |
--------------------------------------------------------------------------------
/docs/入门指南/上手系列/5 配置表格.md:
--------------------------------------------------------------------------------
1 | # 配置模型对应的表格
2 |
3 | 创建模型文件并生成数据库表后。还需要配置表格配置文件，才能在 yao 管理后台界面上显示表内容。
4 |
5 | 表格配置目录`tables`。参考示配置文件创建一个新的配置文件`book.tab.yao`。
6 |
7 | ```sh
8 | └── tables
9 | ├── admin
10 | │ └── user.tab.yao
11 | └── demo
12 | └── pet.tab.yao
13 | ```
14 |
15 | 配置文件：`book.tab.yao`。
16 |
17 | ```jsonc
18 | {
19 | "name": "书籍",
20 | "action": {
21 | "bind": { "model": "book" }
22 | }
23 | }
24 | ```
25 |
26 | 创建并保存配置文件后，在浏览器里就能通过 url 地址：http://127.0.0.1:5099/admin/x/Table/book
27 | 访问到模型对应的表内容。
28 |
29 | 这时界面上可以查看列表，但是还不能添加数据。
30 |
31 | ## 总结
32 |
33 | 表格用于显示数据列表，你可以定义多个表格对应一个模型。
34 |
--------------------------------------------------------------------------------
/docs/入门指南/上手系列/6 配置表单.md:
--------------------------------------------------------------------------------
1 | # 配置模型对应的表单
2 |
3 | 当我们配置好数据表格后，在 Yao 管理后台能看到数据列表，但是还不能编辑数据。接下来需要配置模型对应的表单。
4 |
5 | 表单配置文件保存目录`forms`。参考示配置文件创建一个新的文件`book.form.yao`。
6 |
7 | ```sh
8 | ├── forms
9 | │ ├── admin
10 | │ │ └── user.form.yao
11 | │ └── demo
12 | │ └── pet.form.yao
13 | ```
14 |
15 | 配置文件：`book.form.yao`。
16 |
17 | ```jsonc
18 | {
19 | "name": "书籍",
20 | "action": {
21 | "bind": { "model": "book", "option": {} }
22 | }
23 | }
24 | ```
25 |
26 | 创建并保存文件后，需要更新模型对应的表格配置文件`book.tab.yao`,增加配置项`action.bind.option`。
27 |
28 | ```jsonc
29 | {
30 | "name": "书籍",
31 | "action": {
32 | "bind": {
33 | "model": "book",
34 | "option": { "form": "book" }
35 | }
36 | }
37 | }
38 | ```
39 |
40 | 在浏览器里刷新 url 地址http://127.0.0.1:5099/admin/x/Table/book
41 |
42 | 在页面的右上角会多出来一个"创建"按钮。
43 |
44 | - 点击按钮会弹出新的表单。
45 | - 在表单里填入数据并点击保存按钮。
46 | - 点击关闭按钮关闭表单输入界面。
47 |
48 | 在数据列表的右边，每条记录都会显示 3 个按钮，"查看","修改"，"删除"。
49 |
50 | ## 总结
51 |
52 | 到这里，一个基础的模型与相关的 CURD 界面已配置完成。模型与 CURD 操作只需要四步。
53 |
54 | - 定义模型文件
55 | - 生成数据库表
56 | - 配置表格
57 | - 配置表单
58 |
59 | 熟练后几分钟能就配置一个模型 CURD 界面。
60 |
--------------------------------------------------------------------------------
/docs/入门指南/上手系列/7 配置外部API.md:
--------------------------------------------------------------------------------
1 | # 配置外部 API
2 |
3 | ## API 配置
4 |
5 | 接下来，我们配置一个外部 api 来访问刚创建的 book 模型。
6 |
7 | > api 配置需要保存在目录`apis`下。
8 |
9 | 创建配置文件：`apis/book.http.yao`
10 |
11 | ```jsonc
12 | {
13 | "name": "BOOK 外部接口 ",
14 | "version": "1.0.0",
15 | "description": "BOOK 外部接口",
16 | "guard": "-",
17 | "group": "v1",
18 | "paths": [
19 | {
20 | "path": "book",
21 | "method": "GET",
22 | "guard": "-",
23 | "process": "models.book.get", //内置的模型处理器
24 | "in": [":params"],
25 | "out": { "status": 200, "type": "application/json" }
26 | }
27 | ]
28 | }
29 | ```
30 |
31 | 以上配置会向 yao 引擎注册一个外部访问的 api 接口。
32 |
33 | api 的路径的规则是`http(s)://host:port/api/group/path`,包含以下几部分：
34 |
35 | - 主机与接口。
36 | - 固定前缀`/api`。
37 | - api 中配置的 group,这里配置的是 v1,group 可以包含斜杠/，区分大小写。
38 | - api 中配置的 path,paths 节点中每一条记录都是一个访问端点，区分大小写。
39 |
40 | 最终生成的的 api 访问地址是http://127.0.0.1:5099/api/v1/book。
41 |
42 | 测试 api 接口，使用命令行工具或是浏览器浏览地址。
43 |
44 | ```sh
45 | curl http://127.0.0.1:5099/api/v1/book
46 |
47 | [{"author":"1212","id":1,"publisher":"1212","title":"1212"},{"author":"12","id":3,"publisher":"12","title":"12"}]
48 | ```
49 |
50 | ## 总结
51 |
52 | 在 API 定义中使用现成的处理器，快速开发 API 接口。
53 |
--------------------------------------------------------------------------------
/docs/入门指南/上手系列/8 处理器.md:
--------------------------------------------------------------------------------
1 | # 处理器
2 |
3 | 处理器(Process)是 Yao 框架中非常重要的一个概念，贯穿了整个 yao 的应用开发过程。
4 |
5 | 可以把处理器理解为编程语言中的函数，接收输入参数，输出结果值。可以使用 js 脚本编写处理器，也可以使用 golang 编写插件处理器。
6 |
7 | ## 处理器列表
8 |
9 | 在 yao 中使用处理器需要注意的是需要查询处理器的参数类型与数量，这个可以查询官方或是阅读源代码。
10 |
11 | ## 总结
12 |
13 | 处理器就是函数。
14 |
15 | Yao 引擎内置了大量的处理器，使用这些处理器能快速、方便的操作处理数据。
16 |
--------------------------------------------------------------------------------
/docs/入门指南/上手系列/9 数据增删改查.md:
--------------------------------------------------------------------------------
1 | # 数据增删改查
2 |
3 | 在 yao 中对数据的增删除改查十分方便。
4 |
5 | 当在 yao 中增加模型定义后，并执行命令`yao migrate`后。即是在完成步骤 3，步骤 4 后，yao 会自动的生成针对模型的处理器。
6 |
7 | 在 api 的配置文件中使用了内置的模型处理器`models.book.get`来读取模型数据。它的命名规则是`models.模型名称.模型方法`：
8 |
9 | - `models`，固定的处理前缀，代表这个处理器与模型相关。
10 | - 模型名称是模型的标识 ID,比如这里的书籍模型的标识是 book。
11 | - 模型方法，Yao 针对模型的读取，更新，创建都已经内置了对应的操作方法。
12 |
13 | 比如之前创建了 book 的模型，那么可以直接调用以下的处理器：
14 |
15 | - models.book.create，创建
16 | - models.book.delete，软删除
17 | - models.book.deletewhere，按条件软删除
18 | - models.book.destroy，真删除
19 | - models.book.destroywhere，按条件真删除
20 | - models.book.eachsave，批量保存
21 | - models.book.eachsaveafterdelete 在删除后再批量保存
22 | - models.book.find，按 id 查找
23 | - models.book.get，按条件查找列表
24 | - models.book.insert，插入记录
25 | - models.book.paginate，按条件查找并返回分页
26 | - models.book.save，保存单条信息
27 | - models.book.selectoption，返回表对应的 lable/value 列表
28 | - models.book.update，更新记录
29 | - models.book.updatewhere，按条件更新
30 |
31 | - models.book.load，加载模型定义到内存中，更新内存中的模型定义
32 | - models.book.migrate，更新模型到数据库表
33 |
34 | 以上的处理器可以在任何可以使用处理器的地方调用，比如 api 定义，js 脚本，flow 定义等。
35 |
36 | ## 总结
37 |
38 | 创建模型后可以直接调用模型相关的处理器进行数据的增删改查处理。
39 |
--------------------------------------------------------------------------------
/docs/入门指南/上手系列/index.md:
--------------------------------------------------------------------------------
1 | # 上手系列
2 |
3 |
4 |
5 | - [1 Yao下载与安装](1%20Yao下载与安装.md)
6 | - [2 创建第一个Yao应用](2%20创建第一个Yao应用.md)
7 | - [3 增加模型定义](3%20增加模型定义.md)
8 | - [4 生成数据库表](4%20生成数据库表.md)
9 | - [5 配置表格](5%20配置表格.md)
10 | - [6 配置表单](6%20配置表单.md)
11 | - [7 配置外部API](7%20配置外部API.md)
12 | - [8 处理器](8%20处理器.md)
13 | - [9 数据增删改查](9%20数据增删改查.md)
14 |
15 |
--------------------------------------------------------------------------------
/docs/入门指南/基础/assets/admin-menu-done.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/wwsheng009/yao-docs/80fbfb722d9ccc0a5db41918f88f8be9a91ea663/docs/入门指南/基础/assets/admin-menu-done.jpg
--------------------------------------------------------------------------------
/docs/入门指南/基础/assets/admin-menu.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/wwsheng009/yao-docs/80fbfb722d9ccc0a5db41918f88f8be9a91ea663/docs/入门指南/基础/assets/admin-menu.jpg
--------------------------------------------------------------------------------
/docs/入门指南/基础/assets/admin-stat-done.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/wwsheng009/yao-docs/80fbfb722d9ccc0a5db41918f88f8be9a91ea663/docs/入门指南/基础/assets/admin-stat-done.jpg
--------------------------------------------------------------------------------
/docs/入门指南/基础/assets/yao-setup-tree.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/wwsheng009/yao-docs/80fbfb722d9ccc0a5db41918f88f8be9a91ea663/docs/入门指南/基础/assets/yao-setup-tree.jpg
--------------------------------------------------------------------------------
/docs/入门指南/基础/index.md:
--------------------------------------------------------------------------------
1 | # 基础
2 |
3 |
4 |
5 | - [安装配置](安装配置.md)
6 | - [编写API接口](编写API接口.md)
7 | - [编写图表](编写图表.md)
8 | - [编写界面](编写界面.md)
9 | - [创建数据模型](创建数据模型.md)
10 | - [逻辑编排](逻辑编排.md)
11 | - [使用Widgets](使用Widgets.md)
12 | - [使用处理器](使用处理器.md)
13 | - [文件上传](文件上传.md)
14 | - [应用目录结构](应用目录结构.md)
15 | - [应用语言包](应用语言包.md)
16 | - [YAO命令](YAO命令.md)
17 | - [YAO编程基础](YAO编程基础.md)
18 |
19 |
--------------------------------------------------------------------------------
/docs/入门指南/基础/安装配置.md:
--------------------------------------------------------------------------------
1 | # 安装配置
2 |
3 | 服务启动时，如果未检测到应用配置信息,将启动应用安装服务，根据提示完成安装配置。
4 |
5 | ## 第一步: 创建应用目录
6 |
7 | 创建一个空的应用目录, 进入应用目录，运行 `yao start` 命令
8 |
9 | ```bash
10 | mkdir -p /data/app
11 | cd /data/app
12 | yao start
13 | ```
14 |
15 | ## 第二步: 安装配置
16 |
17 | 根据命令行提示，使用浏览器打开安装页面 `http://:/`, 根据页面提示完成安装配置。
18 |
19 | 如果网络结构较为复杂，命令行提示的 IP 地址无法访问，可根据实际网络结构，更换为相应 IP 地址。
20 |
21 | 安装程序会自动创建演示代码, 安装完毕后，应用目录代码结构：
22 |
23 | 
24 |
25 | ## 登录管理后台
26 |
27 | 配置完成后，自动转向管理员登录页面。
28 |
29 | 管理后台默认用户名: `xiang@iqka.com`， 密码: `A123456p+`
30 |
--------------------------------------------------------------------------------
/docs/入门指南/进阶系列/index.md:
--------------------------------------------------------------------------------
1 | # 进阶系列
2 |
3 |
4 |
5 | - [后台执行](后台执行.md)
6 | - [使用会话保存信息](使用会话保存信息.md)
7 | - [yao源代码安装](yao源代码安装.md)
8 |
9 |
--------------------------------------------------------------------------------
/docs/入门指南/进阶系列/yao源代码安装.md:
--------------------------------------------------------------------------------
1 | # 源代码安装与调试
2 |
3 | xgen 与 yao 前后端分离，可以单独进行单独的运行与调试
4 |
5 | ## 编译前端
6 |
7 | yao 前端 xgen 是一个独立的 react 项目。
8 |
9 | 安装前提，需要 nodejs 16+。
10 |
11 | ```sh
12 | git clone https://github.com/YaoApp/xgen
13 |
14 | cd xgen
15 | # 安装依赖
16 | pnpm install --no-frozen-lockfile
17 | # 开发
18 | pnpm run dev
19 | # 编译
20 | pnpm run build
21 | ```
22 |
23 | 另外 xgen 的调试需要配置 host 文件`/etc/hosts`。
24 |
25 | ```sh
26 | 127.0.0.1 _dev.com
27 | ```
28 |
29 | ## 编译后端
30 |
31 | 需要把以下的子项目都下载到同一个目录，yao 是主项目，其它的项目是依赖项。
32 |
33 | ```sh
34 | mkdir /your-project/root
35 | git clone https://github.com/yaoapp/yao
36 | git clone https://github.com/yaoapp/gou
37 | git clone https://github.com/yaoapp/xun
38 | git clone https://github.com/yaoapp/kun
39 | git clone https://github.com/yaoapp/v8go
40 |
41 | cd yao
42 |
43 | # 下载模块依赖
44 | go mod tidy
45 |
46 | # 调试,需要设置环境变量
47 | go run .
48 | go run . run xiang.sys.ping
49 | go run . start
50 |
51 | # 不集成 XGen 界面引擎
52 | make debug
53 |
54 | # macos制品
55 | make release
56 |
57 | # linux 制品 把前端项目也打包到yao执行程序里
58 | make linux-release
59 | ```
60 |
--------------------------------------------------------------------------------
/docs/入门指南/进阶系列/使用会话保存信息.md:
--------------------------------------------------------------------------------
1 | # 使用会话保存信息
2 |
3 | 创建一个 http api 配置，在配置文件中一定要设置`"guard": "bearer-jwt"`。
4 |
5 | ```json
6 | {
7 | "name": "excel data",
8 | "version": "1.0.0",
9 | "description": "excel data",
10 | "group": "",
11 | "guard": "bearer-jwt",
12 | "paths": [
13 | {
14 | "path": "/crud-menu.json",
15 | "method": "get",
16 | "process": "scripts.amis.menu.main",
17 | "in": [],
18 | "out": {
19 | "status": 200,
20 | "type": "application/json"
21 | }
22 | }
23 | }
24 | ```
25 |
26 | js 脚本中调用处理器`session.set`设置会话信息。
27 |
28 | ```js
29 | function main() {
30 | //在会话中写入信息
31 | Process('session.set', 'my_name', 'yao admin');
32 | }
33 | ```
34 |
35 | 调用处理器`session.get`读取会话信息。
36 |
37 | ```js
38 | function main() {
39 | //打印所有的会话信息
40 | const ses = Process('session.dump');
41 | console.log('session:', ses);
42 | //打印用户的会话信息
43 | const user = Process('session.get', 'user');
44 | console.log('user:', user);
45 | //读取自定义设置会话信息
46 | const myName = Process('session.get', 'my_name');
47 | console.log('myName:', myName);
48 | }
49 | ```
50 |
--------------------------------------------------------------------------------
/docs/入门指南/进阶系列/后台执行.md:
--------------------------------------------------------------------------------
1 | # 后台执行`Yao`应用
2 |
3 | `Linux`OS 操作
4 |
5 | ```sh
6 | cd /your-app/
7 |
8 | #后台作业运行
9 | nohup yao start &
10 |
11 | #save last pid
12 | echo (jobs -l | awk '{print $2}') > yao_pid.txt
13 | ```
14 |
15 | 查看作业与进程
16 |
17 | ```sh
18 | #list jobs
19 | jobs -l
20 |
21 | #list process
22 | ps aux | grep 'yao'
23 | ```
24 |
25 | 把后台进程提到前台
26 |
27 | ```sh
28 | fg %1
29 | ```
30 |
31 | 结束进程
32 |
33 | ```sh
34 | #kill by pid
35 | kill -9 (cat yao_pid.txt)
36 |
37 | #kill all
38 | kill -9 $(ps aux | grep 'yao' | awk '{print $2}')
39 | ```
40 |
--------------------------------------------------------------------------------
/docs/流程图/Yao 架构概览.md:
--------------------------------------------------------------------------------
1 | # YAO 架构概览
2 |
3 | - 数据库更新数据流程
4 | - 数据库读取过程
5 | - gRPC 插件执行逻辑
6 | - table hooks
7 | - api 请求过程
8 | - flow process
9 | - flow process2
10 | - 条件执行
11 | - charts
12 | - 参数查询
13 |
14 | [流程图在线查看](https://viewer.diagrams.net/?tags=%7B%7D&highlight=0000ff&edit=_blank&layers=1&nav=1&title=yao_app.drawio#Uhttps%3A%2F%2Fraw.githubusercontent.com%2Fwwsheng009%2Fyao-docs%2Fmain%2Fdocs%2F%25E6%25B5%2581%25E7%25A8%258B%25E5%259B%25BE%2Fdrawio%2Fyao_app.drawio)
15 |
--------------------------------------------------------------------------------
/docs/流程图/api请求过程.md:
--------------------------------------------------------------------------------
1 | # api 请求过程
2 |
3 | [流程图在线查看](https://viewer.diagrams.net/?tags=%7B%7D&highlight=0000ff&edit=_blank&layers=1&nav=1&title=yao_app.drawio#Uhttps%3A%2F%2Fraw.githubusercontent.com%2Fwwsheng009%2Fyao-docs%2Fmain%2Fdocs%2F%25E6%25B5%2581%25E7%25A8%258B%25E5%259B%25BE%2Fdrawio%2Fyao_app.drawio)
4 |
5 | 
6 |
7 | ## 处理流程说明
8 |
9 | Yao 的 API 请求处理流程包含以下几个主要步骤：
10 |
11 | 1. **API 入口**
12 |
13 | - 接收来自客户端的 HTTP 请求
14 | - 初始化请求上下文
15 |
16 | 2. **处理器**
17 |
18 | - 根据请求路径进行路由分发
19 | - 将请求分发到相应的处理模块（table、model 等）
20 |
21 | 3. **Table 处理**
22 |
23 | - 如果请求涉及表格操作，进入 table 处理流程
24 | - 触发 Before Hook 进行前置处理
25 | - 执行表格相关操作
26 | - 触发 After Hook 进行后置处理
27 |
28 | 4. **Model 处理**
29 |
30 | - 如果请求涉及数据模型，进入 model 处理流程
31 | - 执行数据模型相关操作
32 |
33 | 5. **参数处理**
34 |
35 | - 解析请求参数
36 | - 处理 URL 查询参数（query-param）
37 | - 转换参数格式
38 |
39 | 6. **请求执行**
40 |
41 | - 根据解析的参数执行具体业务逻辑
42 | - 调用相应的处理函数
43 |
44 | 7. **结果返回**
45 | - 处理执行结果
46 | - 格式化响应数据
47 | - 返回给客户端
48 |
49 | ## 关键组件说明
50 |
51 | - **gin 路由**: 负责 HTTP 请求的路由分发
52 | - **parsein**: 请求参数解析器
53 | - **URLToQueryParam**: 将 URL 参数转换为查询参数
54 | - **Xun 查询**: 执行数据库查询操作
55 | - **应用处理器**: 处理具体的业务逻辑
56 |
57 | ## 处理流程特点
58 |
59 | 1. 完整的前置和后置钩子支持，可以在处理前后执行自定义逻辑
60 | 2. 灵活的参数处理机制，支持多种参数格式
61 | 3. 统一的错误处理和响应格式
62 | 4. 模块化的设计，便于扩展和维护
63 |
--------------------------------------------------------------------------------
/docs/流程图/drawio/yao_connector.drawio:
--------------------------------------------------------------------------------
1 | 7Vjfk5owEP5reGxHiCK++qN3D+f0wc60PqawAp1gnLAI3F/fIIuB4fTam7uiM33R7LebkHzf7ka02CIpHhQ/RGsZgLCcUVBYbGk5jj1hY/1VIWWNzEasBkIVBxRkgE38DASOCM3iANJOIEopMD50QV/u9+BjB+NKybwbtpOi+9QDD6EHbHwu+uj3OMCoRj1navBHiMOoebLtzmpPwptgOkka8UDmLYitLLZQUmI9SooFiIq8hpd63pcL3vPGFOzxTyasv86f06dvO2+N+OgosfSmq0+0ypGLjA5MREpFu8ayoULJbB9AtZptsXkexQibA/crb67F11iEiSB3f3fNo0AhFC2IdvsAMgFUpQ4hr8uIOUod5pKdGyHsht2oJUITx0n78Ly0oUcPiKG/YGvS4wQCnS1kSoWRDOWei5VB54a1kbZMzJOUB+LqFyCWlPo8Q9llEooYf7TG22qpzxOylgWtfDJKMi6yn8pM+XDliA7VGFch4JU4Kuvq/Fe1VCA4xsduNb27ME23GEYZo8a25XlZGS2IKluTKnPb9plpJ6uZ52fqeK69j5fXvil5nV6XSuqLZuAO5XjdDmWPh+5Q7r10KFMHnSowRXGhDt6e+uwuU5/1Uj/VdzPcXOoPfzl7Q6T+29Ox+TH7WjpObyodZ//7yyu/iO5M0HGvvwSw45lAy3H1B5v/1C8CbliNbvfNYPh7d9qjcTkfnCZv/O9o0qZ5lT35Wn8IsNVv as float64
10 | func (v Any) CFloat64() float64 {
11 |
12 | if v.value == nil {
13 | return 0
14 | }
15 |
16 | value, ok := v.value.(float64)
17 | if ok {
18 | return value
19 | }
20 |
21 | if v.IsString() && v.String() == "" {
22 | return 0
23 | }
24 |
25 | value, err := strconv.ParseFloat(fmt.Sprintf("%v", v.value), 64)
26 | if err != nil {
27 | panic(err.Error()) //panic
28 | }
29 | return value
30 | }
31 |
32 | ```
33 |
34 | 修正：
35 |
36 | - `https://github.com/wwsheng009/kun/commit/631074294b798b2039f207884162c019ddac5daa`
37 |
38 | - `https://github.com/wwsheng009/gou/commit/745392660f9689f32044b9974fb34febca452db4`
39 |
--------------------------------------------------------------------------------
/docs/源代码/Gou/index.md:
--------------------------------------------------------------------------------
1 | # Gou
2 |
3 |
4 |
5 | - [加密处理器调用错误](加密处理器调用错误.md)
6 | - [两个HasMany问题](两个HasMany问题.md)
7 | - [数据库Schema默认值转换异常](数据库Schema默认值转换异常.md)
8 | - [jsapi中的undefined转换](jsapi中的undefined转换.md)
9 | - [Null值转换成Int类型值时panic](Null值转换成Int类型值时panic.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/源代码/Gou/jsapi中的undefined转换.md:
--------------------------------------------------------------------------------
1 | # jsapi 中的 undefined 转换问题
2 |
3 | 在 jsapi 中,在使用 console.log 打印数据时,如果数据中包含 undefined 值,不会直接打印出 undefined，而是转换成了 0x0。
4 |
5 | ```js
6 | function test() {
7 | let model = {};
8 | // 经过go转换的undefined会变成0。
9 | // 不要使用==null的判断，而且是使用===null and === undefined
10 | console.log('model is undefined', model.xxxx === undefined);
11 | console.log('model is null', model.xxxx === null);
12 | console.log('model is 0', model.xxxx === 0);
13 | console.log('model.xxxx', model.xxx); //总是输出0
14 | return;
15 | }
16 | ```
17 |
18 | 也是说，在 js 中的 undefined 在 golang 中被转换成了 0。
19 |
20 | 如果在 js 使用`==null`或是`!=null`会无法正确判断 undefined 值。
21 |
22 | ```go
23 | // Undefined jsValue Undefined
24 | var Undefined UndefinedT = 0x00
25 |
26 |
27 | func GoValue(value *v8go.Value, ctx *v8go.Context) (interface{}, error) {
28 |
29 | if value.IsNull() {
30 | return nil, nil
31 | }
32 |
33 | if value.IsUndefined() {
34 | return Undefined, nil
35 | }
36 | }
37 | ```
38 |
39 | ## 总结
40 |
41 | 此问题已修复！
42 |
--------------------------------------------------------------------------------
/docs/源代码/Gou/加密处理器调用错误.md:
--------------------------------------------------------------------------------
1 | # 加密处理器调用错误
2 |
3 | 在 scripts js 脚本里面通过 Process 调用加密解密相关的处理器，为何会一直报 失败: Process:crypto.Hash format error 错误呢？
4 | let pwd = Process('crypto.Hash', 'SHA512', '123456')
5 |
6 | 这应该也是一个 bug。非白名单中的处理器名不能少于 3 个字段。
7 |
8 | 处理方法：
9 |
10 | - 使用 yao.crypto.Hash，而不是 crypto.Hash。
11 | - 使用 crypto.Hmac，而不是 crypto.Hmac
12 |
13 | ```go
14 | // yao-app-sources/gou/process.go
15 | var whitelist = map[string]bool{
16 | "flows": true,
17 | "session": true,
18 | "ssl": true,
19 | "websocket": true,
20 | "http": true,
21 | "widget": true,
22 | }
23 |
24 | func (process *Process) extraProcess() {
25 |
26 | namer := strings.Split(process.Name, ".")
27 | last := len(namer) - 1
28 |
29 | //这里报错
30 | if _, has := whitelist[namer[0]]; last < 2 && !has {
31 | exception.New("Process:%s format error", 400, process.Name).Throw()
32 | }
33 | }
34 |
35 | ```
36 |
--------------------------------------------------------------------------------
/docs/源代码/Gou/数据库Schema默认值转换异常.md:
--------------------------------------------------------------------------------
1 | # 数据库读取 Schema 转换成 Model 时默认值转换异常。
2 |
3 | `gou`与`xun`的处理逻辑存在不一致。
4 |
5 | 在`gou`开发库中缺少针对数据库类型默认值的转换处理。
6 |
7 | 源代码：
8 | `/data/projects/yao/yao-app-sources/gou/schema/xun/blueprint.go`
9 |
10 | ```go
11 | func parseColumnType(col *schema.Column, column *types.Column) {
12 | 。。。
13 |
14 | case "timestamp", "datetime"://这里的datetime是错误的。
15 | }
16 |
17 | ```
18 |
19 | 修正：
20 |
21 | `https://github.com/wwsheng009/gou/commits/saphana`
22 |
--------------------------------------------------------------------------------
/docs/源代码/Kun/console_log无法输出正确格式.md:
--------------------------------------------------------------------------------
1 | # console.log 无法正确输出
2 |
3 | 当在脚本中使用`console.log`打印`html`字符时，输出的是`unicode`编码而不是`utf8`编码。这与浏览器的输出差异比较大。
4 |
5 | `Yao Js`
6 |
7 | ```js
8 | function excute() {
9 | console.log('<');
10 | console.log('\u003C');
11 | }
12 |
13 | // 都是输出
14 | // "\u003c"
15 | ```
16 |
17 | `ES6 js`
18 |
19 | ```js
20 | function excute() {
21 | console.log('<');
22 | console.log('\u003C');
23 | }
24 |
25 | // 都是输出
26 | // <
27 | ```
28 |
29 | 原因，脚本中的`console.log`是`golang`函数的代理，在`golang`中使用`json.Marshal`方法处理对象时，把数据转换成了`unicode`编码
30 |
31 | 源代码位置：`/yao-app-sources/kun/utils/utils.go`
32 |
33 | ```go
34 |
35 | // Dump The Dump function dumps the given variables:
36 | func Dump(values ...interface{}) {
37 | f := colorjson.NewFormatter()
38 | f.Indent = 4
39 | for _, v := range values {
40 |
41 | jsoniter.Unmarshal(txt, &res)
42 | s, _ := f.Marshal(res) //uncode编码
43 | fmt.Printf("%s\n", s)
44 | }
45 | }
46 | ```
47 |
48 | 尝试修复如下，设置`html`符号不转义：
49 |
50 | https://github.com/wwsheng009/kun/commit/8ed8e7237d35e829050dff98ae0e5dd500380a14
51 |
52 | ```go
53 | // Dump The Dump function dumps the given variables:
54 | func Dump(values ...interface{}) {
55 | f := colorjson.NewFormatter()
56 | f.Indent = 4
57 | for _, v := range values {
58 |
59 | jsoniter.Unmarshal(txt, &res)
60 | // s, _ := f.Marshal(res)
61 | // fmt.Printf("%s\n", s)
62 | s, _ := UnescapeJsonMarshal(res)
63 | fmt.Printf("%s", s) //返回值已带有\n
64 | }
65 | }
66 |
67 | // https://blog.csdn.net/zhuhanzi/article/details/106156174
68 | // 修正console.log输出html符号异常
69 | func UnescapeJsonMarshal(jsonRaw interface{}) ([]byte, error) {
70 | buffer := &bytes.Buffer{}
71 | encoder := json.NewEncoder(buffer)
72 | encoder.SetEscapeHTML(false)
73 | //带有缩进的格式化
74 | encoder.SetIndent("", " ")
75 | err := encoder.Encode(jsonRaw)
76 | return buffer.Bytes(), err
77 | }
78 |
79 | ```
80 |
--------------------------------------------------------------------------------
/docs/源代码/Kun/index.md:
--------------------------------------------------------------------------------
1 | # Kun
2 |
3 |
4 |
5 | - [console_log无法输出正确格式](console_log无法输出正确格式.md)
6 |
7 |
--------------------------------------------------------------------------------
/docs/源代码/Xgen/index.md:
--------------------------------------------------------------------------------
1 | # Xgen
2 |
3 |
4 |
5 | - [xgen List控件保存数据时数据被清空](xgen%20List控件保存数据时数据被清空.md)
6 | - [xgen remoteSearch](xgen%20remoteSearch.md)
7 | - [xgen 批量上传功能](xgen%20批量上传功能.md)
8 |
9 |
--------------------------------------------------------------------------------
/docs/源代码/Xgen/xgen List控件保存数据时数据被清空.md:
--------------------------------------------------------------------------------
1 | # List 删除项目后，列表被清空
2 |
3 | 0.10.3/yao-wms/forms/plan.form.json 这个 form 里使用了 List 控件作为子表保存数据，
4 | 当用户删除已有的项目时，会清空整个列表。
5 |
6 | 为什么会出现这个问题？
7 |
8 | 因为这个控件的处理新增数据与修改数据时的数据结构是不一样的。
9 |
10 | 当你新增数据，没有删除数据时，这个控件对应的数据结构是数组，数组里保存了控件里的行数据。
11 |
12 | 而当我们有了删除操作后，这个控件对应的数据结构发生了变化。它会变成一个对象。对象里包含一个 data 对象和一个 delete 对象。
13 |
14 | - 在 data 对象里包含未被删除的对象列表，
15 | - 在 delete 包含删除对象列表。
16 |
17 | 没有删除操作时
18 |
19 | ```json
20 | [
21 | {
22 | "item1": 1
23 | },
24 | {
25 | "item2": 1
26 | }
27 | ]
28 | ```
29 |
30 | 有删除操作后
31 |
32 | ```json
33 | {
34 | "data": [{ "item1": 1 }],
35 | "delete": [{ "item2": 1 }]
36 | }
37 | ```
38 |
39 | 在赋值时，加个判断即可。
40 |
41 | 尝试修复如下：
42 | https://github.com/wwsheng009/xgen/commit/c2534e88404166749c66b965aed2bbd99f785333
43 |
--------------------------------------------------------------------------------
/docs/源代码/Xgen/xgen remoteSearch.md:
--------------------------------------------------------------------------------
1 | # `Select控件/Mention控件`远程`searchOptions`的 bug。
2 |
3 | 按后端的返回值来看，远程控件只有两个属性`api`与`params`,不会存在`key`。所以搜索条件的字段名会变成`undefined`。
4 |
5 | 请求示例如下：
6 | http://192.168.126.141:5099/api/__yao/table/material.category/component/fields.table.%E4%B8%8A%E7%BA%A7%E7%B1%BB%E7%9B%AE.edit.props.xProps/search?id=1&key=id&undefined=12
7 |
8 | 源代码：`/yao-app-sources/xgen-v1.0/packages/xgen/models/remote.ts`
9 |
10 | 尝试修复如下，使用参数中的一个`key`参数作为搜索字段
11 |
12 | https://github.com/wwsheng009/xgen/commit/641745d5b8f544388831f7973619baf53b2c8551
13 |
14 | ```js
15 | async searchOptions(v: string) {
16 | const search = this.raw_props.xProps.search
17 |
18 | if (!search) return
19 |
20 | const params = {
21 | ...search.params,
22 | // [search.key]: v
23 | [search.params?.key]: v
24 | }
25 | }
26 | ```
27 |
--------------------------------------------------------------------------------
/docs/源代码/Xgen/xgen 批量上传功能.md:
--------------------------------------------------------------------------------
1 | # Xgen 批量上传功能
2 |
3 | xgen 本身有批量上传功能，但是上传控件少了一个参数`api`。
4 |
5 | 这里通过硬改代码的方式处理。
6 |
7 | xgen 源代码尝试修复如下：
8 | https://github.com/wwsheng009/xgen/commit/8bac8871c9986efc13d0e8e7762e5b74bbf4fb85
9 |
10 | gou 代码修复 fs.system.Upload 类型报错：
11 | https://github.com/wwsheng009/gou/commit/7fafef2100057343024e6fbe7728fd7d58cb28c9
12 |
--------------------------------------------------------------------------------
/docs/源代码/Xun/index.md:
--------------------------------------------------------------------------------
1 | # Xun
2 |
3 |
4 |
5 | - [使用postgresql保存Embedding](使用postgresql保存Embedding.md)
6 | - [数据库连接配置](数据库连接配置.md)
7 | - [Mysql数据库事务](Mysql数据库事务.md)
8 | - [PG数据库增加自定义类型](PG数据库增加自定义类型.md)
9 | - [sqlite数据库bug](sqlite数据库bug.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/源代码/Xun/sqlite数据库bug.md:
--------------------------------------------------------------------------------
1 | # Sqlite 数据库表中的字段名不能与表名一样。
2 |
3 | 处理器：`schemas.default.TableGet`，无法读取表的字段定义，提示`schemas.default.TableGet the column %s does not exists`,
4 |
5 | 从代码上看，如果字段名与表名一样，会被排除掉。
6 |
7 | 尝试修复如下：
8 |
9 | https://github.com/wwsheng009/xun/commit/7127b0945f1b5c9c279fc2005e17836ffcc65c7d
10 |
11 | ```go
12 | selectColumns := []string{
13 | "m.name AS `table_name`",
14 | "p.name AS `name`",
15 | "p.cid AS `position`",
16 | "p.dflt_value AS `default`",
17 | "UPPER(p.type) as `type`",
18 | `CASE
19 | WHEN ` + "p.`notnull`" + ` == 0 THEN 1
20 | ELSE 0
21 | END AS ` + "`nullable`",
22 | `CASE
23 | WHEN INSTR(` + "p.`type`" + `, 'UNSIGNED' ) THEN 1
24 | WHEN p.pk = 1 and ` + "p.`type`" + ` = 'INTEGER' THEN 1
25 | ELSE 0
26 | END AS` + "`unsigned`",
27 | `CASE
28 | WHEN p.pk = 1 THEN 1
29 | ELSE 0
30 | END AS ` + "`primary`",
31 | `CASE
32 | WHEN p.pk = 1 and INSTR(m.sql, 'AUTOINCREMENT' ) THEN "AutoIncrement"
33 | ELSE ""
34 | END AS ` + "`extra`",
35 | }
36 | sql := fmt.Sprintf(`
37 | SELECT %s
38 | FROM sqlite_master m
39 | LEFT OUTER JOIN pragma_table_info((m.name)) p ON m.name <> p.name
40 | WHERE m.type = 'table' and table_name=%s
41 | `,
42 | strings.Join(selectColumns, ","),
43 | grammarSQL.VAL(tableName),
44 | )
45 |
46 |
47 | ```
48 |
49 | 出错的地方：
50 |
51 | ```go
52 | sql := fmt.Sprintf(`
53 | SELECT %s
54 | FROM sqlite_master m
55 | LEFT OUTER JOIN pragma_table_info((m.name)) p ON m.name <> p.name
56 | WHERE m.type = 'table' and table_name=%s
57 | `,
58 | strings.Join(selectColumns, ","),
59 | ```
60 |
61 | 从上面修改成下面的：
62 |
63 | ```go
64 | sql := fmt.Sprintf(`
65 | SELECT %s
66 | FROM sqlite_master m,
67 | pragma_table_info((m.name)) p
68 | WHERE m.type = 'table' and table_name=%s
69 | `,
70 | strings.Join(selectColumns, ","),
71 | ```
72 |
--------------------------------------------------------------------------------
/docs/源代码/Xun/数据库连接配置.md:
--------------------------------------------------------------------------------
1 | # 不同数据库连接配置
2 |
3 | ## bug 修复
4 |
5 | 修复由于只配置了`primary host`导致无法在`js query`中使用 Get 方法。
6 |
7 | https://github.com/wwsheng009/gou/commit/c21e8a8c9a2ee131d90006d8d8840134856019f4
8 |
--------------------------------------------------------------------------------
/docs/源代码/Yao/Compute 处理器无法处理关联表.md:
--------------------------------------------------------------------------------
1 | # Compute 无法处理关联表
2 |
3 | 如果 Compute 处理的对象是关联表，处理器无法起作用。
4 |
5 | 尝试修复如下:
6 | https://github.com/wwsheng009/yao/commit/d9e0b6ef1ea2175d24f2c57c0385a2e40546633a
7 |
--------------------------------------------------------------------------------
/docs/源代码/Yao/index.md:
--------------------------------------------------------------------------------
1 | # Yao
2 |
3 |
4 |
5 | - [处理器yao.component.selectoptions修正](处理器yao.component.selectoptions修正.md)
6 | - [Compute 处理器无法处理关联表](Compute%20处理器无法处理关联表.md)
7 | - [yao 应用打包功能pack](yao%20应用打包功能pack.md)
8 |
9 |
--------------------------------------------------------------------------------
/docs/源代码/Yao/yao 应用打包功能pack.md:
--------------------------------------------------------------------------------
1 | # yao 应用打包功能 pack
2 |
3 | 0.10.3 版本提供了一个程序应用打包的功能。操作命令是：
4 |
5 | 打包后的文件默认情况是保存在目录 dist/app.yaz
6 |
7 | ```sh
8 | # 不加密打包
9 | yao pack
10 |
11 | # 加密打包
12 | yao pack -l xxxx
13 |
14 | ```
15 |
16 | 指定程序包，使用参数-f 指定 yaz 或是使用环境变量指定应用包的路径 YAO_APP_SOURCE=app.yaz
17 |
18 | 使用程序包，解密使用-k
19 |
20 | ```sh
21 | # -f 指定yaz或是使用环境变量YAO_APP_SOURCE=app.yaz
22 | yao start -f app.yaz -k xxxx
23 |
24 | ```
25 |
--------------------------------------------------------------------------------
/docs/源代码/index.md:
--------------------------------------------------------------------------------
1 | # 源代码
2 |
3 | 针对于 Yao 的一些源代码分析与研究。
4 |
5 |
6 |
7 | - [Github Commit List](Github%20Commit%20List.md)
8 | - [源码编译](源码编译/index)
9 | - [Gou](Gou/index)
10 | - [Kun](Kun/index)
11 | - [Xgen](Xgen/index)
12 | - [Xun](Xun/index)
13 | - [Yao](Yao/index)
14 |
15 |
--------------------------------------------------------------------------------
/docs/源代码/源码编译/0.10.3-pre To 0.10.3-dev.md:
--------------------------------------------------------------------------------
1 | # 0.10.3-pre To 0.10.3
2 |
3 | new features:
4 |
5 | - config file support '.json','.yao','jsonc'
6 |
7 | ## gou 0.10.3-pre =>0.10.3
8 |
9 | ```sh
10 | git checkout saphana
11 |
12 | git checkout -b v0.10.3
13 |
14 | git fetch upstream
15 |
16 | git merge upstream/main
17 |
18 | ```
19 |
20 | handle the conflict files
21 |
22 | ## Yao 0.10.3-pre =>0.10.3
23 |
24 | ```sh
25 |
26 | git checkout main
27 |
28 | git git checkout -b v0.10.3
29 |
30 | git fetch upstream
31 |
32 | git merge upstream/v0.10.3
33 | ```
34 |
35 | handle the conflict files
36 |
37 | ## fallback to 0.10.3-pre
38 |
39 | ```sh
40 | cd yao
41 | git checkout main
42 |
43 | cd gou
44 | git checkout saphana
45 |
46 | ```
47 |
48 | ## switch to 0.10.3
49 |
50 | ```sh
51 | cd yao
52 | git checkout v0.10.3
53 |
54 | cd gou
55 | git checkout v0.10.3
56 | ```
57 |
58 | ## main change in 0.10.3
59 |
60 | - studio function not working yet
61 | - 读写文件的超级权限的变化
62 |
63 | ```js
64 | // WriteFile SU root
65 | // 0.10.2
66 | __YAO_SU_ROOT = true;
67 |
68 | //0.10.3
69 | __yao_data = { ROOT: true };
70 | ```
71 |
72 | 获取全局变量与权限
73 |
74 | ```js
75 | const test = () => {
76 | const result = Studio('unit.test.process', 'foo', 99, 0.618);
77 | return {
78 | ...result,
79 | __yao_global: __yao_data['DATA'], //全局数据,等于res["Global"]
80 | __yao_sid: __yao_data['SID'], //等于res["Sid"]
81 | __YAO_SU_ROOT: __yao_data['ROOT'] //是否超级权限
82 | };
83 | };
84 | test();
85 | ```
86 |
--------------------------------------------------------------------------------
/docs/源代码/源码编译/index.md:
--------------------------------------------------------------------------------
1 | # 源码编译
2 |
3 |
4 |
5 | - [0.10.3-pre To 0.10.3-dev](0.10.3-pre%20To%200.10.3-dev.md)
6 | - [编译yao源代码](编译yao源代码.md)
7 | - [windows版本适配](windows版本适配/index)
8 |
9 |
--------------------------------------------------------------------------------
/docs/源代码/源码编译/windows版本适配/index.md:
--------------------------------------------------------------------------------
1 | # windows 版本适配
2 |
3 |
4 |
5 | - [编译yao windows修改版本](编译yao%20windows修改版本.md)
6 | - [windows pack功能适配](windows%20pack功能适配.md)
7 |
8 |
--------------------------------------------------------------------------------
/docs/源代码/源码编译/windows版本适配/windows pack功能适配.md:
--------------------------------------------------------------------------------
1 | # 适用于 windows 的 pack 功能适配
2 |
3 | 0.10.3 版本提供了一个程序应用打包的功能。操作命令是：
4 |
5 | 打包后的文件默认情况是保存在目录 dist/app.yaz
6 |
7 | ```sh
8 | # 不加密打包
9 | yao pack
10 |
11 | # 加密打包
12 | yao pack -l xxxx
13 |
14 | ```
15 |
16 | 指定程序包，使用参数-f 指定 yaz 或是使用环境变量指定应用包的路径 YAO_APP_SOURCE=app.yaz
17 |
18 | 使用程序包，解密使用-k
19 |
20 | ```sh
21 | # -f 指定yaz或是使用环境变量YAO_APP_SOURCE=app.yaz
22 | yao start -f app.yaz -k xxxx
23 |
24 | ```
25 |
26 | 官方目前只测试了 linux 版本，不支持 windows 版，需要手工处理。
27 |
28 | 0.10.3 版本的 pack 功能 windows 平台适配
29 |
30 | https://github.com/wwsheng009/gou/commit/773b81ea80b289055ee26a303a625eec101556cd
31 |
32 | ## zip 打包文件路径只能使用 linux 风格的路径分隔符
33 |
34 | ```go
35 | relPath = strings.ReplaceAll(relPath, "\\", "/")
36 | ```
37 |
38 | ## 移除临时文件的处理
39 |
40 | windows 删除文件会判断当前文件是否在使用。需要把删除文件的操作放在最后面。
41 |
42 | ```go
43 | defer os.Remove(encryptFile)//移除文件要在最后操作
44 | defer encryptWriter.Close()
45 | ```
46 |
--------------------------------------------------------------------------------
/readme.md:
--------------------------------------------------------------------------------
1 | # 记录Yao应用开发过程中的一些问题与经验
2 |
3 | 收集的一些与 Yao 开发相关的文档，文档使用`vitepress`制作，并自动发布到`github page`上。直接访问地址：
4 |
5 | [https://wwsheng009.github.io/yao-docs](https://wwsheng009.github.io/yao-docs)
6 |
7 | cf pages 地址：
8 | [https://yao-docs.wwsheng.cloud](https://yao-docs.wwsheng.cloud/)
9 |
10 | ## 文档编写与构建
11 |
12 | 文档使用`markdown`格式编写，新建的文档存放在目录`/docs`。
13 |
14 | 在文档发布之前先本地构建一次检查有没有错误。
15 |
16 | ```sh
17 | pnpm run build
18 | ```
19 |
20 | ## `vitepress`配置文件自动生成
21 |
22 | `vitepress`以下配置文件使用脚本生成
23 |
24 | - `/docs/.vitepress/sidebar.ts`使用脚本`script/generate_config.ts`根据目录结构自动生成。
25 | - `/docs/.vitepress/nav.ts`使用脚本`script/generate_config.ts`根据目录结构自动生成。
26 |
27 | 监听文件变更，自动生成`vitepress`配置文件
28 |
29 | ```sh
30 | node script/watch.ts
31 | ```
32 |
33 | ## `index.md`文件的更新
34 |
35 | 当一个目录中新增/修改/删除文件后，索引文件`index.md`并不会自动的更新。
36 |
37 | 重建所有的`index.md`文件
38 |
39 | ```bash
40 | pnpm run build:index
41 | ```
42 |
--------------------------------------------------------------------------------
/scripts/cleanup.ts:
--------------------------------------------------------------------------------
1 | import fs from 'node:fs';
2 | import path from 'node:path';
3 | import { BaseDocPath } from './generate_config';
4 |
5 | function CleanUp(suffix: string) {
6 | deleteFilesWithBakSuffix(BaseDocPath, suffix);
7 | }
8 |
9 | // 检查目录及其子目录是否包含 .md 文件
10 | function hasMarkdownFiles(dirPath: string): boolean {
11 | const files = fs.readdirSync(dirPath);
12 |
13 | for (const file of files) {
14 | const filePath = path.join(dirPath, file);
15 | const stat = fs.statSync(filePath);
16 |
17 | if (stat.isDirectory()) {
18 | if (hasMarkdownFiles(filePath)) {
19 | return true;
20 | }
21 | } else if (file.endsWith('.md') && file !== 'index.md') {
22 | return true;
23 | }
24 | }
25 |
26 | return false;
27 | }
28 |
29 | // 定义删除函数
30 | function deleteFilesWithBakSuffix(dirPath: string, suffix: string) {
31 | if (dirPath.startsWith('.vitepress')) {
32 | return;
33 | }
34 |
35 | const match = suffix || '.bak';
36 | const files = fs.readdirSync(dirPath);
37 |
38 | // 检查目录是否只包含 index.md
39 | const hasOnlyIndexMd = files.length === 1 && files[0] === 'index.md';
40 | const indexMdPath = path.join(dirPath, 'index.md');
41 |
42 | // 遍历处理文件和目录
43 | files.forEach((file) => {
44 | const filePath = path.join(dirPath, file);
45 | const stat = fs.statSync(filePath);
46 |
47 | if (stat.isDirectory()) {
48 | // 递归处理子目录
49 | deleteFilesWithBakSuffix(filePath, suffix);
50 |
51 | // 检查子目录是否为空
52 | const subFiles = fs.readdirSync(filePath);
53 | if (subFiles.length === 0) {
54 | fs.rmdirSync(filePath);
55 | }
56 | }
57 | });
58 |
59 | // 如果目录中只有 index.md，且匹配删除条件，则删除它
60 | // 或者如果目录及其子目录中没有其他 .md 文件，也删除 index.md
61 | if (
62 | (hasOnlyIndexMd && match === 'index.md') ||
63 | (match === 'index.md' &&
64 | !hasMarkdownFiles(dirPath) &&
65 | fs.existsSync(indexMdPath))
66 | ) {
67 | fs.unlinkSync(indexMdPath);
68 | }
69 | }
70 |
71 | // CleanUp();
72 | CleanUp('index.md');
73 |
--------------------------------------------------------------------------------
/scripts/generate.ts:
--------------------------------------------------------------------------------
1 | import { CreateVitePressConfig } from './generate_config';
2 |
3 | // 生成站起index.md
4 | CreateVitePressConfig();
5 |
--------------------------------------------------------------------------------
/scripts/postbuild.ts:
--------------------------------------------------------------------------------
1 | import { copyFile } from 'node:fs/promises';
2 |
3 | // Path to the source file
4 | const source = './dist/yao-docs/index.html';
5 |
6 | // Path to the destination where file will be copied
7 | const destination = './dist/index.html';
8 |
9 | // Copying the file
10 | try {
11 | await copyFile(source, destination);
12 | console.log('File was copied successfully');
13 | } catch (err) {
14 | console.error('Error occurred while copying the file:', err);
15 | }
16 |
--------------------------------------------------------------------------------
/scripts/release.ts:
--------------------------------------------------------------------------------
1 | import { execSync } from 'node:child_process';
2 | import { readJSONSync } from 'fs-extra';
3 | import { updateContributors } from './utils';
4 |
5 | const { version: oldVersion } = readJSONSync('package.json');
6 |
7 | execSync('bumpp --no-commit --no-tag --no-push', { stdio: 'inherit' });
8 |
9 | const { version } = readJSONSync('package.json');
10 |
11 | if (oldVersion === version) {
12 | console.log('canceled');
13 | process.exit();
14 | }
15 |
16 | updateContributors();
17 |
18 | execSync('git add .', { stdio: 'inherit' });
19 |
20 | execSync(`git commit -m "chore: release v${version}"`, { stdio: 'inherit' });
21 | execSync(`git tag -a v${version} -m "v${version}"`, { stdio: 'inherit' });
22 |
--------------------------------------------------------------------------------
/scripts/update.ts:
--------------------------------------------------------------------------------
1 | import { updateContributors } from './utils';
2 |
3 | updateContributors();
4 |
--------------------------------------------------------------------------------
/scripts/watch.ts:
--------------------------------------------------------------------------------
1 | import fs from 'node:fs';
2 | import path from 'node:path';
3 | import { CreateVitePressConfig } from './generate_config';
4 | // Define the folder to watch
5 | const docsPath = path.resolve('./docs');
6 |
7 | // Define the callback function to execute when a file changes
8 | const callback = (eventType, filename) => {
9 | if (filename.startsWith('.vitepress')) {
10 | return;
11 | }
12 |
13 | console.log(`File ${filename} has been ${eventType}`);
14 |
15 | CreateVitePressConfig();
16 | };
17 |
18 | // Watch the folder for file changes
19 | fs.watch(docsPath, { recursive: true }, callback);
20 |
--------------------------------------------------------------------------------
/shims.d.ts:
--------------------------------------------------------------------------------
1 | declare module '*.vue' {
2 | import { ComponentOptions } from 'vue';
3 | const componentOptions: ComponentOptions;
4 | export default componentOptions;
5 | }
6 |
--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "module": "NodeNext",
4 | "moduleResolution": "NodeNext",
5 | "target": "esnext",
6 | "esModuleInterop": true,
7 | "strict": true,
8 | "skipLibCheck": true,
9 | "noUnusedLocals": true,
10 | "resolveJsonModule": true,
11 | "isolatedModules": true,
12 | "jsx": "preserve",
13 | "lib": ["ESNext", "dom", "ES2021.String"]
14 | },
15 | "include": [
16 | "docs",
17 | "docs/.vitepress/components/*.vue",
18 | "docs/.vitepress/*.ts",
19 | "docs/.vitepress/config.ts"
20 | ],
21 | "exclude": ["**/node_modules/**", "**/dist/**"]
22 | }
23 |
--------------------------------------------------------------------------------
/unocss.config.ts:
--------------------------------------------------------------------------------
1 | import {
2 | defineConfig,
3 | presetAttributify,
4 | presetIcons,
5 | presetUno,
6 | transformerDirectives,
7 | transformerVariantGroup
8 | } from 'unocss';
9 |
10 | export default defineConfig({
11 | shortcuts: {
12 | 'border-main': 'border-gray-400 border-opacity-30',
13 | 'bg-main': 'bg-gray-400',
14 | 'bg-base': 'bg-white dark:bg-hex-1a1a1a'
15 | },
16 | presets: [
17 | presetUno(),
18 | presetAttributify(),
19 | presetIcons({
20 | scale: 1.2,
21 | warn: true
22 | })
23 | ],
24 | theme: {
25 | colors: {
26 | primary: '#3eaf7c'
27 | },
28 | fontFamily: {
29 | mono: 'var(--vt-font-family-mono)'
30 | }
31 | },
32 | transformers: [transformerDirectives(), transformerVariantGroup()]
33 | });
34 |
--------------------------------------------------------------------------------