详细了解如何在npm上发布自己的包？

Posted 前端纸飞机

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了详细了解如何在npm上发布自己的包？相关的知识，希望对你有一定的参考价值。

大家好，我是纸飞机，想必大家都在项目中经常会使用npm install、yarn add、cnpm install等安装包的命令吧。那么大家好奇过，这些包都是怎么来的吗？不用迷茫，本篇文章就为你揭秘他们到底怎么来的并且手把手教你做一个属于你自己的一个可以npm安装的组件库。

🔥无论是npm、yarn还是cnpm他们都有一个统一的名字：javascript包管理工具。顾名思义都是用来管理包的，用户将包发在线上随时可用。并且cnpm和npm本就是同宗同源，他们的命令都大致相同，只是cnpm对国内有好些。yarn虽然不同，但无非就是多了个缓存离线下载。下面放出三个大哥的官网，大家可以去了解，这次的主题是npm包的上传。

🔥一、创建包

git init my_npm_comp
cd my_npm_comp
npm init -y

创建出这么个玩意，操作中初始化了一个git仓库，一个npm仓库（建立package.json依赖包文件）。

🔥二、编写组件库

这里要注意了，我们是要做一个组件库，而不是一个组件，所以我们需要尽量模块化。

我们在package.json同级下建立一个components文件夹， 然后里面建立的一个个文件的就是你的组件。例如我要来做个Alert组件和Toast组件。

首先components下建立Alert.js和Toast.js。

❤️1、Alert组件制作

这是个滥竽充数的组件，勿怪勿怪，为了凑个库，也好讲解。

components下的Alert.js：

let Alert = 
    show:function()
        alert('纸飞机666')
    



export default Alert;

❤️2、Toast组件制作

components下的Toast.js：

let Toast = 
  // 隐藏的 setTimeOut 引用
  hideTimeOut: null,
  /**
   * 初始化
   */
  init: function () 
    var toastNode = document.createElement("section");
    toastNode.innerhtml =
      '<i class="iconfont icon-success"></i><i class="iconfont icon-error"></i><span class="text">111</span>';
    toastNode.id = "toastWaka"; // 设置id，一个页面有且仅有一个Toast
    toastNode.setAttribute("class", "toast"); // 设置类名
    toastNode.style.display = "none"; // 设置隐藏
    document.body.appendChild(toastNode);
  ,
  /**
   * 显示Toast
   * @param text 文本内容
   * @param type 类型 success error
   * @param duration 持续时间
   */
  show: function (text, type, duration) 
    // 确保上一次的 TimeOut 已被清空
    if (this.hideTimeOut) 
      clearTimeout(this.hideTimeOut);
      this.hideTimeOut = null;
      // console.error('上一次的 TimeOut 还未走完!');
      // return;
    
    if (!text) 
      console.error("text 不能为空!");
      return;
    
    var domToastWaka = document.getElementById("toastWaka");
    console.log("domToastWaka", domToastWaka);
    if (!domToastWaka) 
      console.error("toastWaka DOM 不存在!");
      return;
    
    var domIconSuccess = domToastWaka.querySelector(".icon-success"); // 成功图标
    var domIconError = domToastWaka.querySelector(".icon-error"); // 错误图标
    var domToastText = domToastWaka.querySelector(".text"); // 文字
    domToastText.innerHTML = text || "";
    switch (type) 
      case "success":
        domIconSuccess.style.display = "inline";
        domIconError.style.display = "none";
        break;
      case "error":
        domIconSuccess.style.display = "none";
        domIconError.style.display = "inline";
        break;
      default:
        domIconSuccess.style.display = "none";
        domIconError.style.display = "none";
        break;
    
    domToastWaka.style.display = "block";
    // 不传的话默认2s
    var that = this;
    this.hideTimeOut = setTimeout(function () 
      domToastWaka.style.display = "none";
      that.hideTimeOut = null; // 置 TimeOut 引用为空
    , duration || 2000);
  ,
  /**
   * 隐藏 Toast
   */
  hide: function () 
    // 如果 TimeOut 存在
    if (this.hideTimeOut) 
      // 清空 TimeOut 引用
      clearTimeout(this.hideTimeOut);
      this.hideTimeOut = null;
    
    var domToastWaka = document.getElementById("toastWaka");
    if (domToastWaka) 
      domToastWaka.style.display = "none";
    
  ,
;

Toast.init();

export default Toast;

❤️3、css样式和库导出出口

my_npm_comp下建立style.css放css样式，index.js是整个组件库的出口，便于后面install后导入组件。

style.css

/*toast样式*/
#toastWaka 
    position: absolute;
    display: none;
    left: 50%;
    bottom: 50%;
    z-index: 99999;
    margin: 0 auto;
    -webkit-transform: translate(-50%);
    transform: translate(-50%);
    width: 120px;
    height:40px;
    line-height: 40px;
    border-radius: 5px;
    text-align: center;
    color: #fff;
    background-color: rgba(000,000,000,0.5);

 
#toastWaka .text
    color: #fff;
    display: inline-block;
    font-size: 14px;
    position: absolute;
    top:0;
    bottom:0;
    right:0;
    left:0;

注意index.js非常重要，毕竟一定要有导出，你才能导入 。这里涉及到一些前端模块化的知识，后面会补充，有兴趣的小伙伴也可以自行去查看。

index.js

import Toast from './components/Toast'
import Alert from './components/Alert'


let myLibs = 

myLibs.Alert = Alert
myLibs.Toast = Toast

export default myLibs

🔥三、上传组件库

❤️1、先将npm源切换到npm

npm config set registry=http://registry.npmjs.org

❤️2、注册npm账号

已有账号可跳过。

首先去npmjs官网注册账号，一定要邮箱验证。

官网地址：npm

​

当然也可以使用npm命令注册： 看下面

bash终端注册账号：

npm adduser

按上图提示输入账号密码。Tip：输密码时字符不会显示出来，并且去邮箱验证账号，不验证push不了包。

❤️3、登陆账号

已登录账号可跳过。（使用npm whoami这条命令查看）

用命令创建账号会自动登录。官网手动创建的可如下操作：

npm login

我这边用huqinggui这个账号来演示。

❤️4、发布(推送)包

npm publish

从终端来看包是发布成功了，我们打开我们的npmjs来看，包是否存在。


哈哈，这不就是我们发布的包吗？？

Tip：如果推送不成功，说明可能存在同名的包，请改下package.json里的name再发布。具体的命令以及错误处理地址：❤️npm常用命令以及npm publish常见问题处理方法❤️_纸飞机博客-CSDN博客

修改了包后再publish报错就需要修改package.json中的version，相当于发布一个新的版本。例如第一次提交的1.0.0 => 1.0.1 ，第二次便可以发布了。

🔥四、使用组件库

❤️1、npm install 组件库

npm i my_npm_comp

包已经安装成功我们接下来引入。

❤️2、使用组件库

我们以vue为例，注意由于我们用的是原生js做的组件库，故可用在任何场景，当然你如果用vue或者react写的也是可以作为组件库的。

App.vue

<template>
  <div id="app">
      <button @click="openAlert()">打开Alert</button>
      <button @click="openToast()">打开Toast</button>
  </div>
</template>

<script> 
import myLibs from 'my_npm_comp'
import 'my_npm_comp/style.css'
export default 
  name: "App",
  components: ,
  data() 
    return 
      
    ;
  ,
  methods: 
    openAlert()
      myLibs.Alert.show();
    ,
    openToast()
      myLibs.Toast.show("我是toast!", "success", 3000);
    
  ,
;
</script>

我们来演示演示：

使用非常完美。就这样一个完整的组件库完美制作成功了。组件库不仅限于使用原生js来制作哦！小伙伴们可以自己动手尝试一遍哦，也可以自己做一套把常用的方法上传上去，随取随用，很舒服的。

🔥热门推荐🔥

微信支付成功不回调怎么半？

package.json奥秘一览！

宏任务和微任务的执行居然这么神奇！

前端开发居然可以提高这么大的效率！

npm常用命令大全！

前端异步我到底该怎么去解决？哪些玩意是异步啊！

以上是关于详细了解如何在npm上发布自己的包？的主要内容，如果未能解决你的问题，请参考以下文章

如何在npm上发布自己的包

带你深入了解NPM——NPM初学者指南

在npm上发布一个自己的包

在npm上发布一个自己的包

在npm上发布自己的包 全局包指令使用

如何发布一个npm包(基于vue)