为了深入学习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


目录
相关文章
|
19天前
|
Web App开发 JavaScript 前端开发
使用 Chrome 浏览器的内存分析工具来检测 JavaScript 中的内存泄漏
【10月更文挑战第25天】利用 Chrome 浏览器的内存分析工具,可以较为准确地检测 JavaScript 中的内存泄漏问题,并帮助我们找出潜在的泄漏点,以便采取相应的解决措施。
129 9
|
21天前
|
监控 前端开发 JavaScript
React 静态网站生成工具 Next.js 入门指南
【10月更文挑战第20天】Next.js 是一个基于 React 的服务器端渲染框架,由 Vercel 开发。本文从基础概念出发,逐步探讨 Next.js 的常见问题、易错点及解决方法,并通过具体代码示例进行说明,帮助开发者快速构建高性能的 Web 应用。
56 10
|
1月前
|
JavaScript
js学习--商品列表商品详情
js学习--商品列表商品详情
19 2
|
1月前
|
JavaScript
js学习--九宫格抽奖
js学习--九宫格抽奖
18 2
|
1月前
|
JavaScript
js学习--开屏弹窗
js学习--开屏弹窗
35 1
|
1月前
|
JavaScript
js学习--抽奖
js学习--抽奖
15 1
|
1月前
|
Web App开发 JavaScript 前端开发
Node.js:JavaScript世界的全能工具
Node.js:JavaScript世界的全能工具
|
1月前
|
JavaScript 前端开发 容器
js之dom学习
js之dom学习
35 0
|
Web App开发 JavaScript 前端开发
在项目中使用Google托管的JavaScript库
《在项目中使用Google托管的JavaScript库》 作者:chszs,转载需注明。 作者博客主页:http://blog.csdn.net/chszs Google提供了很多开源JavaScript库的托管,包括jQuery、Dojo、MooTools、Prototype、SWFObject、WebFont Loader、script.aculo.us、jQuery UI、AngularJS等。
811 0
|
前端开发 JavaScript Web App开发
在项目中使用Google托管的JavaScript库
版权声明:本文为博主chszs的原创文章,未经博主允许不得转载。 https://blog.csdn.net/chszs/article/details/8085295 《在项目中使用Google托管的JavaScript库》 作者:chszs,转载需注明。
877 0

推荐镜像

更多