{"id":20818493,"url":"https://github.com/yusangeng/chivy","last_synced_at":"2025-04-10T01:15:49.489Z","repository":{"id":57198140,"uuid":"99433541","full_name":"yusangeng/chivy","owner":"yusangeng","description":"浏览器控制台打印工具","archived":false,"fork":false,"pushed_at":"2025-01-22T07:04:24.000Z","size":180,"stargazers_count":44,"open_issues_count":0,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-10T01:15:40.857Z","etag":null,"topics":["console","console-log","logging"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yusangeng.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-08-05T16:10:25.000Z","updated_at":"2025-01-22T07:04:27.000Z","dependencies_parsed_at":"2025-02-18T22:01:49.663Z","dependency_job_id":"43a72e5a-d606-4661-8f6c-1a525605157e","html_url":"https://github.com/yusangeng/chivy","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusangeng%2Fchivy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusangeng%2Fchivy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusangeng%2Fchivy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusangeng%2Fchivy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yusangeng","download_url":"https://codeload.github.com/yusangeng/chivy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248137891,"owners_count":21053775,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["console","console-log","logging"],"created_at":"2024-11-17T21:47:05.158Z","updated_at":"2025-04-10T01:15:49.469Z","avatar_url":"https://github.com/yusangeng.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# chivy\n\n[![TypeScript](https://img.shields.io/badge/lang-typescript-blue.svg)](https://www.tslang.cn/) [![Build Status](https://github.com/yusangeng/chivy/workflows/test/badge.svg)](https://github.com/yusangeng/chivy/actions?query=workflow%3Atest) [![Coverage Status](https://coveralls.io/repos/github/yusangeng/chivy/badge.svg?branch=master)](https://coveralls.io/github/yusangeng/chivy) [![Npm Package Info](https://badge.fury.io/js/chivy.svg)](https://www.npmjs.com/package/chivy) [![Downloads](https://img.shields.io/npm/dw/chivy.svg?style=flat)](https://www.npmjs.com/package/chivy)\n\n## 综述\n\nchivy 是一个可配置的前端日志打印工具, 让你可以按照级别和模块管理你的 console.log, 或者通过自定义 driver 完成将控制台打印转发到后台等高级操作.\n\n## 安装\n\n```bash\nnpm install chivy\n```\n\n## 使用\n\n### 配置\n\nchivy 使用 konph 进行配置, konph 用法见: https://www.npmjs.com/package/konph\n\n配置项:\n\n- chivy-level: 当前网页 log 级别, 低于此级别的日志将不会打印. 可填写整数, 默认为 0. 也可填字符串, 字符串到整数换算规则如下(不区分大小写)：\n\n\u003e DEBUG: 0\n\u003e INFO: 1\n\u003e WARN: 2\n\u003e ERROR: 3\n\u003e MUTE: 4\n\n- chivy-modules: 被打开的模块名. 可填一个数组, 或者用\",\"隔开的字符串. 默认为['**']\n\n\u003e chivy-modules 中的 module 名使用\"/\"分割, 每一段称为一个 section, 匹配时以 section 为单位从左向右匹配.\n\u003e chivy-modules 中的 module 名支持单 section 通配符\"\\*\"和多 section 通配符\"\\*\\*\", 通配符和其他字符不能混用, 一个 section 要么是通配符, 要么是其他字符.\n\n- chivy-driver-flags: driver 打印配置. 类型为形如['color', 'level', 'module', 'time']的数组, 可以通过增删元素选择打印方式或字段：\n  - color: 彩色打印.\n  - level: 打印日志级别.\n  - module：打印模块名称.\n  - time：打印日志时间.\n\n注意：由于 driver 可以自定义实现, 此处的 flags 元素和元素解释也可自定义, 由自定义 driver 接收.\n\n配置例子:\n\n```js\nwindow.__Konph = {\n  \"chivy-level\": \"warn\",\n  \"chivy-modules\": [\"**\"], // 这样配置会打开所有module\n  \"chivy-driver-flags\": [\"color\", \"level\", \"module\"]\n};\n```\n\n### 代码示例\n\n```js\nimport Logger from \"chivy\";\n\nconst log = new Logger(\"project/module\");\n\nlog.debug(\"Debug message!\");\nlog.info(\"Info message!\");\nlog.warn(\"Warn message!\");\nlog.error(\"Error message!\");\n```\n\n### 自定义\n\nLogger 通过 Driver 执行打印, Filter 执行过滤. 通过依赖注入, 可以通过自定义 Driver 和 Filter 的方式自定义 chivy 的行为.\n\n例如:\n\n```typescript\nimport Logger, { IDriver, IFilter } from \"chivy\";\n\nclass Driver implements IDriver {\n  // ...\n}\n\nclass Filter implements IFilter {\n  // ...\n}\n\nLogger.injector.Driver = Driver;\nLogger.injector.Filter = Filter;\n\nconst log = new Logger(\"foo/bar\");\n```\n\nIDriver:\n\n```typescript\n/**\n * 日志打印接口.\n *\n * @export\n * @interface IDriver\n */\nexport interface IDriver {\n  /**\n   * 打印日志.\n   *\n   * @param {Level} level 日志级别\n   * @param {string} moduleName 模块名\n   * @param {Array} params 其他参数\n   *\n   * @memberof Driver\n   * @instance\n   */\n  log(level: Level, moduleName: string, ...params: any[]): void;\n}\n```\n\nIFilter:\n\n```typescript\n/**\n * 日志过滤器接口.\n *\n * @export\n * @interface IFilter\n */\nexport interface IFilter {\n  /**\n   * 过滤日志.\n   *\n   * 可以通过赋值Logger.injector.logFilter替换.\n   *\n   * @param {Level} level 日志级别\n   * @param {Path} moduleName 模块名\n   * @returns {boolean} 需要打印返回true, 否则返回false\n   */\n  exec(level: Level, moduleName: Path): boolean;\n}\n```\n\n其中 Path 是对使用\"/\"分隔的路径字符串的封装, 提供了 equal, match 和 toString 三个方法, 支持通配符. 如果外部需要使用, 可以通过如下代码引入:\n\n```js\nimport { IFilter, Path } from \"chivy\";\n\nclass Filter implements IFilter {\n  exec(level: Level, moduleName: Path): boolean {\n    return moduleName.match(\"foo/bar/**/Foobar\");\n  }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyusangeng%2Fchivy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyusangeng%2Fchivy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyusangeng%2Fchivy/lists"}