Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[feature] 希望在文档里面写明暴露的 API 地址和传入参数,让我们直接发送请求进行包的请求 #709

Open
sonofmagic opened this issue Oct 8, 2024 · 2 comments
Labels
help wanted Extra attention is needed

Comments

@sonofmagic
Copy link

sonofmagic commented Oct 8, 2024

为什么我需要这个功能

因为 cnpm 在某些场景下并不方便,

比如我需要同步镜像功能, 我还要安装 cnpm, 然后执行 cnpm sync cnpmcore

从 cnpm 抽离功能

我的想法是,把 cnpm bin 里的一些功能都抽出来

比如 cnpm sync 的实现是 https://github.com/cnpm/cnpm/blob/master/bin/cnpm-sync.js

就可以从里面,完整的吧 cnpm sync 的功能搞出来

但是我在抽离功能的时候,发现 cnpm 里面有很多过时的依赖,比如 bagpipe (11年没有更新), npm-request (9 年没有更新)

期望

所以希望能够把写在 cnpm 里面,真正的那些 API 整理成文档,写在 https://github.com/cnpm/cnpmcore/tree/master/docs

让我们直接发送请求去调用。

比如 PUT https://registry.npmmirror.com/[pkgName]/sync?publish=false&nodeps=false 这样的API

@elrrrrrrr
Copy link
Member

cnpm/cnpm@11cfecc
sync 模块部分最近刚修改过,目前 sync 逻辑比较简单,应该也可以直接抽出来?

或者目前 web 上也的实现也可以独立出来 ref: https://github.com/cnpm/cnpmweb/blob/master/src/components/Sync.tsx#L31

sync 属于私有 api,内部实现逻辑可能还会做一些策略调整,没法保证稳定性,就没有放在公开的文档内了。

@elrrrrrrr
Copy link
Member

但是我在抽离功能的时候,发现 cnpm 里面有很多过时的依赖,比如 bagpipe (11年没有更新), npm-request (9 年没有更新)

😄 感兴趣的话可以一起来优化下

@fengmk2 fengmk2 added the help wanted Extra attention is needed label Nov 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants