节点Kit
NodeKit是用于您Node.js应用程序,脚本和库的简单工具包. 它为日志,遥测,配置和错误处理提供了功能,因此可以在您不同的项目中拥有熟悉的基础.
安装
npm install --save @gravity-ui/nodekit
开始
在您的工程中添加依赖性 :
npm install --save @gravity-ui/nodekit
然后在您的应用程序中导入并输入节点Kit :
import {NodeKit} from '@gravity-ui/nodekit';
const nodeKit = new NodeKit();
nodekit.ctx.log('App is ready');
文档
见 docs/ 其他文档目录 :
docs/configuration.md指定您如何配置节点kit本身和基于节点kit的应用程序docs/contexts.md描述节点Kit上下文、记录和跟踪的概念docs/app-error.md包含用户为您的应用程序提供的实用自定义错误类描述docs/utils.md列出一些与 NodeKit 捆绑的辅助函数
捐款
开始
获取节点Kit寄存器和示例应用程序的副本 :
git clone [email protected]:gravity-ui/nodekit
git clone [email protected]:gravity-ui/nodekit-examples
链接您的节点 kit 到 npm 并启动编译器 :
cd nodekit && npm link && npm run dev
然后,在另一个终端,去例,打开你感兴趣的一个, 链接你的节点,然后启动应用程序:
cd nodekit-examples/basic-app && npm i && npm link @gravity-ui/nodekit
npm run dev
此时您可以同时对NodeKit进行修改并演示应用,并实时看到结果.
许可证
根据麻省理工学院的许可证分发。 见 自由主义 详细情况.
对于人工智能特工
一个由Gravity UI后端共享的基础Node.js工具包(博客、遥测、打出错误、配置、请求语境).
何时使用
- 任何希望共享记录、遥测(跟踪)和输入的节点/标语
AppError。 。 。 . - 提供请求范围上下文(日志/跟踪),跨越异域边界.
- 将多种服务集中在同一生态系统中的做法始终如一.
不使用时
- 显示 HTTP 路由、 中间软件或服务器, 使用
@gravity-ui/expresskit——以NodeKit为顶部并增加了Express/HTTP层. - 对于一个独立,单文件的脚本,没有日志/遥测需要,平原节点API比完整的NodeKit上下文系统更轻.
常见陷阱
- 幻觉
import {Logger}编号 :logger——通过节点Kit上下文实现记录:new NodeKit()接下来nodekit.ctx.log(...),而不是单独的日志导出. - 反复证实节点Kit - 创建一个
NodeKit实例并分享ctx; 创建许多实例来分解记录/遥测配置. - 抛出平地
Error- 用捆绑的AppError(见docs/app-error.md)所以误差代码和遥测被一致地捕获. - 跳过配置初始化 ——节点Kit读取施工配置;审查
docs/configuration.md在假设默认之前.
AI代理的文件
安装版本的可代理读取文档位于 node_modules/@gravity-ui/nodekit/dist/docs/INDEX.md。 。 。 .