{"id":18262881,"url":"https://github.com/midwayjs/luckyeye","last_synced_at":"2025-04-04T20:30:57.904Z","repository":{"id":45242297,"uuid":"330354852","full_name":"midwayjs/luckyeye","owner":"midwayjs","description":null,"archived":false,"fork":false,"pushed_at":"2022-07-12T06:47:11.000Z","size":30,"stargazers_count":4,"open_issues_count":1,"forks_count":2,"subscribers_count":17,"default_branch":"master","last_synced_at":"2024-04-23T22:09:54.461Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/midwayjs.png","metadata":{"files":{"readme":"README.md","changelog":"History.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-01-17T09:23:45.000Z","updated_at":"2022-07-29T14:43:12.000Z","dependencies_parsed_at":"2022-09-05T17:20:55.068Z","dependency_job_id":null,"html_url":"https://github.com/midwayjs/luckyeye","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/midwayjs%2Fluckyeye","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/midwayjs%2Fluckyeye/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/midwayjs%2Fluckyeye/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/midwayjs%2Fluckyeye/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/midwayjs","download_url":"https://codeload.github.com/midwayjs/luckyeye/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247246209,"owners_count":20907752,"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":[],"created_at":"2024-11-05T11:09:07.316Z","updated_at":"2025-04-04T20:30:55.807Z","avatar_url":"https://github.com/midwayjs.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# LuckyEye\n\n![](https://img.alicdn.com/tfs/TB1mhZBauuSBuNjy1XcXXcYjFXa-1080-700.png)\n\n用于检查 Node.js 应用的各项问题，用于在出错的时候进行自助式快速排查的小工具。\n\n## 使用\n\n```sh\nnpm i @midwayjs/luckyeye --save-dev\nnpx luckyeye\n```\n\n在 `package.json` 中加入下面的包配置。\n\n```json\n{\n  \"midway-luckyeye\": {\n    \"packages\": [\n      \"midway_v2\"\n    ]\n  }\n}\n```\n\n`midway_v2` 是默认的针对 midway v2 的规则检查包。\n\n也可以使用自己的 npm 包规则。\n\n```json\n{\n  \"midway-luckyeye\": {\n    \"packages\": [\n      \"npm:xxxx\"\n    ]\n  }\n}\n```\n\n\n## API\n\nluckyeye 工具可以添加一些通用的检查项，目前没有实现插件机制，最好的方式就是进行提交 MR。\n\nluckyeye 工具的想法是把检查项分为几个规则组，每个规则组里有对应的检查项，相当于 mocha 的两层维度，每个规则组目前由一个文件（函数）表示。\n\n通过简单的 `register` 方法和传入的 runner 对象实现了一个简单的检查器。\n\n目前 runner 支持输出消息，检查，警告这三类，同时也支持特定场景的忽略情况，支持同步和异步操作。\n\n以下是简单的例子。\n\n```js\nexports.register = (runner) =\u003e {\n  runner\n    .group('基础环境检查')\n    .skipWhen(() =\u003e {\n      // 下面的就不走了\n      return true;\n    })\n    .info('node 版本', () =\u003e {\n      // 输出一些信息\n      return 'v12.9.0'\n    })\n    .check('检查文件是否存在', () =\u003e {\n      // 检查\n      return [fs.existsSync('/home/admin/.image_info'), '未找到信息'];\n    })\n    .warn('警告', async () =\u003e {\n      return [true, '输出警告的信息']\n    });\n\n};\n```\n\nrunner 包括几个通用的输出接口\n\n- group(groupName: string)\n- check(title: string, () =\u003e {}) : Promise \\\u003cArray[result: boolean, failMessage: string]\u003e\n- info(title: string, () =\u003e {}) : Promise \\\u003cArray[message: string]\u003e\n- warn(title: string, () =\u003e {}) : Promise \\\u003cArray[result: boolean, warnMessage: string]\u003e\n- skipWhen(() =\u003e {}): Promise \\\u003cresult: boolean\u003e 返回true，则整段跳过执行，类似 xdescribe\n\n接口很简单，看 /src/rule 目录下的例子就好。\n\n如果要发布为 npm 包，需要导出包含 rules 属性的规则数组。\n\n```js\nexports.rules = [\n  register\n]\n```\n\n## Reporter\n\nluckyeye 设计能支持多个不同的 Reporter，目前实现只有 ConsoleReporter。\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmidwayjs%2Fluckyeye","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmidwayjs%2Fluckyeye","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmidwayjs%2Fluckyeye/lists"}