为了深入学习JS我写了一个JS工具库 | 从零到一发布到npm上(1)

简介: 自从工作以来,写项目的时候经常需要手写一些方法和引入一些js库JS基础又十分重要,于是就萌生出自己创建一个JS工具库并发布到npm上的想法于是就创建了一个名为learnjts的项目,在空余时间也写了几个工具函数,后续还会再继续增加...这篇文章就是一篇实战文章,我把自己创建项目,发布到npm,以及遇到的问题和解决方案全都记录了下来,如果你也想创建一个自己的js工具库,可以根据这篇文章一步一步的尝试一下

创建项目


打开命令窗口,创建一个项目文件

mkdir learnjts  // 创建了一个名为 learnjts 的文件夹
cd learnjts  // 进入此文件夹


image.png


然后初始化项目

npm init

我们可以看到:让我们给项目起一个名字,括号内是默认文件夹的名字,不用修改,回车就可以


image.png


还会弹出来许多的参数,我们可以写上,也可以一路回车,一直到最后,就会生成一个package.json文件夹


image.png


如果要修改可以直接在这里修改

创建一个src文件夹,里面放一些js文件,可以写工具方法,再在根目录下创建一个index.js作为入口文件


image.png


写工具方法


项目骨架已经建好了,接下来我们开始写工具方法

第一个工具方法,我写了一个数据类型的判断方法

先在src文件夹下面建一个getDataType.js

function getDataType(target){
    let type = typeof target
    // 判断是否是复杂数据类型
    if(type === 'object'){
        return Object.prototype.toString.call(target).replace(/^[object (\S+)]$/, '$1').toLowerCase();
    }else{
        // 基础数据类型直接返回
        return type
    }
}
//导出这个方法
export default getDataType


image.png


然后在index.js文件里导入 getDataType方法,并且验证是否能够使用

然后就会发现,报错了


从报错信息我们可以看到是 import出错了

解决方案:给package.js添加一个属性

"type":"module",

此时再运行一下可以看到,能够正常运行了


image.png


以后我们在src目录下肯定会增加很多工具函数,所以可以吧index.js当成一个入口,所有的工具函数都可以从这里导出出去

import getDataType from './src/getDataType.js'
export {
    getDataType,
}


image.png


注册npm账号


要想自己的工具库别人也能够使用,需要把它发到npm上 npm官网

此时就需要注册一个npm账号了

注册npm需要有一个邮箱,任何邮箱都可以,能接收到验证码就可以,注册时会收到验证码


image.png


开始发布


当你注册好npm账号后,你就可以去项目中准备 发布 了


设置npm源


但是在发布之前,需要检查一下npm源,如果是其他源,就会发布失败,此时你需要把它设置为npm源

在项目终端里输入npm config get registry,可以查看当前源

npm config get registry


image.png


可以看到此时我的源是npm源,可以发布,如果是淘宝源呢?

就需要设置npm源

npm config set registry https://registry.npmjs.org/


登录npm账号


因为我们是第一次发布包,所以需要在终端登录我们的npm用户,输入我们的用户名,和密码和邮箱

在终端输入

npm adduser

需要注意的是,我们输入密码时,不会再终端上显示出来,输入完直接按回车就好

接着开始让你输入npm的邮箱号,再次按回车时,会给你的邮箱发一个验证码,你需要把这个验证码再输入上


image.png


发布到npm上


登录好后,开始发布,在终端输入

npm publish

发布的时候,有可能就会报错:提示信息就会问你:你没有登录对账号吧?

其实真正的错误原因:是因为你的项目名称和npm上的项目重名了


image.png


在起名字的时候,你可以去npm上搜一下


image.png


嘿嘿^_^ 这个其实是我之前写好的,只是为了给大家演示,又从零搭建又写了一遍

如果没有搜到,则说明你可以使用这个名字


image.png


如果你重名了,你就在package.js里面改名吧


image.png


此时再次发布,就可以看到,发布成功了


image.png

回到npm,点击自己的头像,再点击Profile,就可以看到自己的npm库了


image.png


目录
相关文章
|
2月前
|
移动开发 JavaScript 前端开发
一些处理浏览器兼容性问题的JavaScript库
这些库在处理浏览器兼容性问题方面都有着各自的特点和优势,可以根据具体的需求和项目情况选择合适的库来使用,从而提高代码的兼容性和稳定性,为用户提供更好的体验。同时,随着浏览器技术的不断发展,还需要持续关注和学习新的兼容性解决方案。
112 48
|
2月前
|
JavaScript 前端开发
Moment.js与其他处理时间戳格式差异的JavaScript库相比有什么优势?
Moment.js与其他处理时间戳格式差异的JavaScript库相比有什么优势?
|
2月前
|
CDN
如何在项目中使用Moment.js库?
如何在项目中使用Moment.js库?
|
2月前
|
Web App开发 JavaScript 前端开发
如何学习JavaScript?
如何学习JavaScript?
52 5
|
2月前
|
JavaScript 前端开发
如何在不影响性能的前提下使用JavaScript库来实现复杂的动画效果?
如何在不影响性能的前提下使用JavaScript库来实现复杂的动画效果?
|
2月前
|
JavaScript 前端开发 索引
JavaScript学习第二章--字符串
本文介绍了JavaScript中的字符串处理,包括普通字符串和模板字符串的使用方法及常见字符串操作方法如`charAt`、`concat`、`endsWith`等,适合前端学习者参考。作者是一位热爱前端技术的大一学生,专注于分享实用的编程技巧。
34 2
|
2月前
|
存储 JavaScript 前端开发
JavaScript学习第一章
本文档介绍了JavaScript的基础知识,包括其在网页中的作用、如何通过JavaScript动态设置HTML元素的CSS属性,以及JavaScript中的变量类型(`var`、`let`、`const`)和数据类型(基本数据类型与引用数据类型)。通过实例代码详细解释了JavaScript的核心概念,适合初学者入门学习。
55 1
|
2月前
|
算法 开发者
Moment.js库是如何处理不同浏览器的时间戳格式差异的?
总的来说,Moment.js 通过一系列的技术手段和策略,有效地处理了不同浏览器的时间戳格式差异,为开发者提供了一个稳定、可靠且易于使用的时间处理工具。
46 1
|
2月前
|
JavaScript 前端开发 搜索推荐
Moment.js、Day.js、Miment,日期时间库怎么选?
【10月更文挑战第29天】如果你需要一个功能强大、插件丰富的日期时间库,并且对性能要求不是特别苛刻,Moment.js是一个不错的选择;如果你追求极致的轻量级和高性能,那么Day.js可能更适合你;而如果你有一些特定的日期时间处理需求,并且希望在性能和功能之间取得平衡,Miment也是可以考虑的。
|
2月前
|
存储 JavaScript 前端开发
decimal.js库的安装和使用方法
【10月更文挑战第24天】decimal.js 是一个非常实用的高精度计算库,通过合理的安装和使用,可以在 JavaScript 中实现精确的数值计算和处理。你可以根据具体的需求和项目情况,灵活运用该库来解决数字精度丢失的问题。

推荐镜像

更多