diff --git a/DEV.md b/DEV.md index e751e90..3e429b4 100644 --- a/DEV.md +++ b/DEV.md @@ -1,6 +1,6 @@ # 开发者需知 -该版本将支持TS、TSX环境,提供Miao-Yunzai完全的类型声明及其开发文档。 +未来将支持TS、TSX环境,提供Miao-Yunzai完全的类型声明及其开发文档。 - 提交 @@ -17,6 +17,57 @@ */ ``` +- 注释风格 + +```ts +/** + * 返回false + * @param T 任意字符串 + * @returns false + */ +function getTest(T:string){ + return false +} +``` + +- 命名风格 + +```ts +// 获得test值 +function getTest(T:string){ +} +// 设置 +function setTest(T:string){ +} +// 删除 +function delTest(T:string){ +} +// 获取某数据依据为id +function getDataById(T:string){ +} + +// 系统常量 +const ENV_TEST = 'dev' + +// 局域常量 +const MyName = 'yunzai' + +// 可修改变量 +let values = '' + +// 禁止使用 var values = '' + +// 声明数组 +const Arr = [] + +// 不推荐 new + +// 声明对象 +const Obj = {} + +// 不推荐new +``` + ## 关于lib目录 lib目录将在未来逐渐放弃,在版本发布后,开发者需要有意识的对此变化做出调整. @@ -31,14 +82,22 @@ lib目录将在未来逐渐放弃,在版本发布后,开发者需要有意 --lib / tools / web.js / test.js / log.js / ksr.js // 计划废弃 --renderers + +// 其他内容逐步优化。。。 ``` ## 新版目录 + - 核心源码 src/core + +- 配置管理 + +src/config + - 数据管理 src/db @@ -51,7 +110,7 @@ src/mys src/utils -## 开发示例 +## 新开发示例 - 图片组件 @@ -81,7 +140,7 @@ import { join } from 'path' // puppeteer import { Puppeteer } from './puppeteer.ts' // component -import HelloComponent from '../component/hello.tsx' +import HelloComponent from './hello.tsx' // class Component { puppeteer: typeof Puppeteer.prototype @@ -121,4 +180,4 @@ class Component { ) } } -``` +``` \ No newline at end of file diff --git a/README.md b/README.md index 53a15be..2157317 100644 --- a/README.md +++ b/README.md @@ -73,14 +73,16 @@ sudo ln -s libstdc++.so.6.0.29 libstdc++.so.6 node >= 20.0.0 -```ts -ts-node alemon.config.ts +- 启动 + +```sh +npm run latest:app ``` -更改为 +- 重新登录 -```ts -node --no-warnings=ExperimentalWarning --loader ts-node/esm alemon.config.ts +```sh +npm run latest:app login ``` ## 致谢 diff --git a/package.json b/package.json index da11683..15a95b6 100644 --- a/package.json +++ b/package.json @@ -14,6 +14,8 @@ "ts:app": "ts-node src/main.ts", "ts:login": "ts-node src/main.ts login", "ts:build": "rollup --config rollup.config.js", + "latest:app": "node --no-warnings=ExperimentalWarning --loader ts-node/esm src/main.ts", + "latest:login": "node --no-warnings=ExperimentalWarning --loader ts-node/esm src/main.ts login", "format": "prettier --write .", "prepare": "husky" }, diff --git a/src/bot.ts b/src/bot.ts index e7a2402..4697c8b 100644 --- a/src/bot.ts +++ b/src/bot.ts @@ -16,6 +16,10 @@ import ListenerLoader from './lib/listener/loader.js' * 扩展 */ import { Client } from 'icqq' + +/** + * + */ export class Yunzai extends Client { /** * diff --git a/src/mys/MysUtil.ts b/src/mys/MysUtil.ts index 0ec09bc..06122fe 100644 --- a/src/mys/MysUtil.ts +++ b/src/mys/MysUtil.ts @@ -8,6 +8,9 @@ const games = [ { key: 'sr', name: '星穹铁道' } ] + + + /** * */