{"id":30662453,"url":"https://github.com/ben-lau/wx-router","last_synced_at":"2025-08-31T16:03:56.014Z","repository":{"id":42876684,"uuid":"256953980","full_name":"ben-lau/wx-router","owner":"ben-lau","description":"微信小程序的路由类","archived":false,"fork":false,"pushed_at":"2023-01-06T03:46:48.000Z","size":619,"stargazers_count":8,"open_issues_count":11,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-31T07:03:52.358Z","etag":null,"topics":["miniprogram","mp","router","wx"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/ben-lau.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}},"created_at":"2020-04-19T08:50:14.000Z","updated_at":"2025-05-23T23:51:27.000Z","dependencies_parsed_at":"2023-02-05T06:01:41.105Z","dependency_job_id":null,"html_url":"https://github.com/ben-lau/wx-router","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/ben-lau/wx-router","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ben-lau%2Fwx-router","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ben-lau%2Fwx-router/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ben-lau%2Fwx-router/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ben-lau%2Fwx-router/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ben-lau","download_url":"https://codeload.github.com/ben-lau/wx-router/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ben-lau%2Fwx-router/sbom","scorecard":{"id":231229,"data":{"date":"2025-08-11","repo":{"name":"github.com/ben-lau/wx-router","commit":"d8e9cd6405a9183df4d0cb8864afb1323ab80684"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 0/6 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 6 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"42 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw","Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-vh7m-p724-62c2","Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w","Warn: Project is vulnerable to: GHSA-434g-2637-qmqr","Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m","Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw","Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p","Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747","Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq","Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488","Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-h7cp-r72f-jxh6","Warn: Project is vulnerable to: GHSA-v62p-rq8g-8h59","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94","Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw","Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-17T04:54:28.392Z","repository_id":42876684,"created_at":"2025-08-17T04:54:28.393Z","updated_at":"2025-08-17T04:54:28.393Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273003115,"owners_count":25028999,"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","status":"online","status_checked_at":"2025-08-31T02:00:09.071Z","response_time":79,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["miniprogram","mp","router","wx"],"created_at":"2025-08-31T16:03:51.375Z","updated_at":"2025-08-31T16:03:56.005Z","avatar_url":"https://github.com/ben-lau.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# wx-router\n\n\u003e 更好用的小程序路由\n\n## 概述\n\n`wx-router`是一个**微信小程序路由类**，封装了小程序路由 api，并且解决了部分小程序路由 api 中不好用的一些地方，提升开发效率和语义化，以及更优雅的编程体验。\n\n## 特性\n\n- 支持 Promise 化调用\n- 支持别名跳转\n- 支持路由传值保持类型\n- 调用简单化，不需要确定页面是否 tabbar 页面（合并 navigateTo 和 switchTab）\n- 支持 switchTab 和 navigateBack**传值**\n\n#### todo\n\n- [ ] 路由守卫\n\n## 起步\n\n#### 下载\n\n- 整个下载或克隆\n  [点击下载](https://github.com/ben-lau/wx-router/releases)源码后解压移除`example`文件夹后可以直接放到你的项目中。当然也可以参考 example 的用例。\n- npm (是的 wx-router 被用了)\n\n```bash\nnpm install wx-mp-router --save\n```\n\n## 用法\n\n#### [示例](https://github.com/ben-lau/wx-router/tree/master/example)\n\n克隆项目后，小程序工具打开项目指向`example`文件夹即可。\n\n#### 初始化\n\n```javascript\nimport WxRouter from 'wx-mp-router';\nexport const router = new WxRouter([\n  {\n    url: '/pages/index/index',\n    name: 'Index'\n  },\n  {\n    url: '/pages/home/home',\n    name: 'Home'\n  }\n]);\n```\n\n需要自己再维护一个路由列表，但是支持 name 跳转\n\n## api\n\n#### `go` -\u003e navigateTo + switchTab\n\n不需要区分 tab 页面和非 tab 页面\n\n```typescript\ndeclare function go(options: {\n  url?: string;\n  name?: string;\n  query?: Record\u003cstring, any\u003e;\n}): Promise\u003cany\u003e;\n```\n\n```javascript\nrouter.go({\n  url: '/pages/index/index',\n  query: { id: '123', isAuth: true }\n});\nrouter.go({\n  name: 'Index', // 支持别名跳转\n  query: { id: '123', isAuth: true }\n});\n```\n\n#### `goBack` -\u003e navigateBack\n\n支持传参\n\n```typescript\ndeclare function goBack(options: {\n  delta?: number;\n  query?: Record\u003cstring, any\u003e;\n}): Promise\u003cany\u003e;\n```\n\n```javascript\nrouter.goBack({\n  delta: 3,\n  query: { id: '123', isAuth: true }\n});\n```\n\n#### `redirect` -\u003e redirectTo\n\n也是不需要区分 tab 页面和非 tab 页面\n\n```typescript\ndeclare function redirect(options: {\n  url?: string;\n  name?: string;\n  query?: Record\u003cstring, any\u003e;\n}): Promise\u003cany\u003e;\n```\n\n```javascript\nrouter.redirect({\n  url: '/pages/index/index',\n  query: { id: '123', isAuth: true }\n});\nrouter.redirect({\n  name: 'Index', // 支持别名跳转\n  query: { id: '123', isAuth: true }\n});\n```\n\n#### `reLaunch` -\u003e reLaunch\n\n```typescript\ndeclare function reLaunch(options: {\n  url?: string;\n  name?: string;\n  query?: Record\u003cstring, any\u003e;\n}): Promise\u003cany\u003e;\n```\n\n```javascript\nrouter.reLaunch({\n  url: '/pages/index/index',\n  query: { id: '123', isAuth: true }\n});\nrouter.reLaunch({\n  name: 'Index', // 支持别名跳转\n  query: { id: '123', isAuth: true }\n});\n```\n\n#### `onRoute`\n\n路由改变钩子,在路由改变时触发，返回一个取消订阅的方法\n\n```typescript\ndeclare function onRoute(callback: Function): Function;\n```\n\n```javascript\nrouter.onRoute((e, query) =\u003e {\n  console.log(\n    e, // 事件\n    query // 参数\n  );\n});\n```\n\n## 题外话\n\n本项目起因是因为公司项目需求且小程序目前解决方案本人都觉得不优雅而发起的。旨在解决以下场景\n\n- 1、tabbar 页面是非固定的，购物车 tab 可能在任何位置甚至不存在。（自定义小程序 tab）\n- 2、navigateTo 和 switchTab 区分出两个 api，而页面动态化，所有页面都可能是 tab 页面（自定义小程序页面）\n- 3、小程序中更改 tab 的 badge(setTabBarBadge,removeTabBarBadge)都需要在 tab 页面调用。（购物车数量标记）\n- 4、tab 页面点击需要给触发另一个 tab 页逻辑。（switchTab 不能带参数）\n- 5、跳转到很深的页面后回到很前面一页，需要出发部分逻辑，中间的页面也有可能回去也要带不同的逻辑（注册场景）\n\n当然，以上所有场景都可以用\u003cfont color=\"red\" size=\"3\"\u003e全局状态\u003c/font\u003e或者\u003cfont color=\"red\" size=\"3\"\u003e事件总线\u003c/font\u003e解决，本人项目也有实现封装（有空再分享），但是并不优雅，页面与页面间耦合度高。\n\n**PS.本人在找工作中，有没好的内推介绍一下嘿嘿。**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fben-lau%2Fwx-router","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fben-lau%2Fwx-router","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fben-lau%2Fwx-router/lists"}