美文网首页
react(ts) 发布声明文件到 NPM 上的 @types

react(ts) 发布声明文件到 NPM 上的 @types

作者: Bournefont | 来源:发表于2020-04-06 13:47 被阅读0次

    上一篇文章,解决了react-page-layout的声明文件问题。详见文章(https://www.jianshu.com/p/2fa454ad4fe1)

    这个声明文件到最后很简单,只是declare和export,参数类型什么的都没有限制,乍一想很不严谨,但是毕竟这是个第三方的包,有自己不了解的地方,写的太详细限制的太严格然后出错了要改反而麻烦,还是包容一点更好。如果仅是在自己项目里写的话,当然可以详细一点。像我想发布到@types上,能正常用就越简单越好。

    写完声明文件以后,就想着能不能方便一下也需要用到这个组件的人。干脆看能不能发布到@types上。于是就看了看相关的文档 https://www.tslang.cn/docs/handbook/declaration-files/publishing.html  

    首先去https://github.com/DefinitelyTyped/DefinitelyTyped上fork了然后clone,但是速度是在太慢了。还好找到了码云上面有个镜像https://gitee.com/mirrors/definitelytyped/

    先去码云上拉取了代码,然后在types文件下面新建了自己的项目文件夹名称react-page-layout文件夹,建好相关的四个文件。

    写好各个文件相应的代码,

    运行npm run lint, npm run test验证一下代码,

    然后需要提交到github仓库,但是是一开始从码云上的镜像拉取的代码.

    只能先git remote rm origin删除掉关联的码云仓库,然后git remote add origin https://github.com/Bournegithub/DefinitelyTyped.git关联到之前fork过的项目,然后提交代码。

    提交完成后发现已经有自己的远程分支。这个时候ide也出现了提示问要不要合并代码,点击就打开了合并代码请求页面,当然直接在项目上点击发起也可以。

    因为是新增,所以把模版中的修改和删除都去掉,只填写上面两部分就可以了。

    按照模版填好相应的内容然后就等着管理员处理吧。会安排相应的人来review代码,如果有问题,你需要修改之后重新提交。管理员可能会和你沟通提交的问题。修复之后,管理员会把你的代码合并到主代码库中。

    相关文章

      网友评论

          本文标题:react(ts) 发布声明文件到 NPM 上的 @types

          本文链接:https://www.haomeiwen.com/subject/lhwckhtx.html