美文网首页
如何写一个自己的npm包

如何写一个自己的npm包

作者: 莣忧草_3b53 | 来源:发表于2018-09-27 21:52 被阅读0次

    1.写自己的npm包一定要注册自己的npm账号

    账号注册网址

    2.创建自己的npm包

    i.在自己的目录下进行npm init

    name:
    包的名字,默认是你这个文件夹的名字。先去npm上找一下有没有同名的包。最好的测试方式就是,在命令行里面输入npm install 要取的名字,如果没有报错,npm上没有跟你同名的包,把包发布出去。如果成功下载下来了,则不能发布。

    version:
    你这个包的版本,默认是1.0.0

    description:
    包的作用

    entry point:
    入口文件,默认是Index.js,你也可以自己填写你自己的文件名

    test command:
    测试命令,这个直接回车就好了,因为目前还不需要这个。

    git repository:
    这个是git仓库地址,如果你的包是先放到github上或者其他git仓库里,这时候你的文件夹里面会存在一个隐藏的.git目录,npm会读到这个目录作为这一项的默认值。如果没有的话,直接回车继续。

    keyword:
    这个是一个重点,这个关系到有多少人会搜到你的npm包。

    author:写你的账号或者你的github账号吧

    license:这个直接回车,开源文件来着。。。

    ii.建立src文件夹,并建立index.js

    注意目录结构入下
    -package.json
    -package-lock.json
    -src/index.js
    -node_module[如果没有引入包等就不会产生该文件夹]

    iii.我们写a+b的代码

    在index文件中写入代码

    function add (num1, num2) {
        num1 = parseFloat(num1)
        num2 = parseFloat(num2)
        return num1 + num2
    }  
    module.exports = add;
    
    iiii.最重要的,写好README.md,大家知道该包的作用

    3.登陆发布包

    i登陆

    npm login
    或者使用添加npm用户
    npm adduser
    按照提示输入自己的用户名和密码

    ii发布包

    然后,在你的目录下使用npm publish
    npm publish
    注意:每一次发布新的一版,version版本要改变,不然npm会给我报错。一般情况下,一旦你要修改你已经发布后的代码,然后又要执行发布操作,务必到package.json里面,把version改一下,比如从1.0.0改为1.0.1,然后在执行npm publish,这样就可以成功发布了。

    相关文章

      网友评论

          本文标题:如何写一个自己的npm包

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