美文网首页Cordovacordova/phonegap
在npm上面发布自己的插件

在npm上面发布自己的插件

作者: 待花谢花开 | 来源:发表于2017-06-15 09:07 被阅读11次

    在上一篇文章中我们已经开发了一个自己的插件,但是我们的插件是通过以下的方式进行安装的:

    cordova plugin add https://github.com/DaiHuaXieHuaKai/GaoDeLocation.git --variable API_KEY=your key
    

    如果我们想要想安装device插件那样通过cordova plugin add cordova-plugin-device安装的话我们需要怎么做呢?下面就让我们来看看怎么将自己的插件发布吧。
    首先我在前面的博客中已经写过一篇关于发布npm包的文章,同样我们这里也需要像那样做。
    首先我们要在我们插件的目录下新建一个package.json和一个readme.md文件。
    package.json可以通过

    plugman createpackagejson 你的插件目录
    

    然后根据提示填写信息,在这个过程中需要你填写你的插件项目的git地址,所以我们需要先将自己的插件上传到git,具体方法就不多说了,不会自行百度。最终如下:

    {
      "name": "cordova-plugin-gaodelocation",//注意这里的格式,并只能为小写
      "version": "1.0.0",
      "description": "Use of a gold maps to locate, to obtain location information",
      "cordova": {
        "id": "com.zhaoying.GaoDeLocation",
        "platforms": [
          "android"
        ]
      },
      "repository": {
        "type": "git",
        "url": "https://github.com/DaiHuaXieHuaKai/GaoDeLocation.git"
      },
      "keywords": [
        "ecosystem:cordova",
        "cordova-android"
      ],
      "author": "zhaoying",
      "license": "ISC",
      "bugs": {
        "url": "https://github.com/DaiHuaXieHuaKai/GaoDeLocation/issues"
      },
      "homepage": "https://github.com/DaiHuaXieHuaKai/GaoDeLocation#readme"
    }
    
    

    readme.md文件主要是对插件的介绍和如何使用。里面内容可以采用markdown语法进行排版。
    最终的插件格式如下:


    这里写图片描述

    然后我们需要使用npm将插件上传到npm。
    如果没有在npm注册用户的话,先执行

    npm addUser
    

    已经注册用户的话则执行:

    npm login
    

    最后执行

    npm publish
    

    然后在npm中就可以找到自己上传的包,便可以通过cordova plugin add cordova-plugin-gaodelocation进行插件的安装了。

    相关文章

      网友评论

        本文标题:在npm上面发布自己的插件

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