如何自己创建一个工具项目并上传到npm上使用

这篇具有很好参考价值的文章主要介绍了如何自己创建一个工具项目并上传到npm上使用。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

第一步:npm官网注册一个自己的账号

第二步:在cmd窗口创建一个项目(这里我以vue3为例子)

npm create vite 项目名

选择框架: 

如何自己创建一个工具项目并上传到npm上使用,npm,node.js,上传自己的npm项目

 选择语言:

如何自己创建一个工具项目并上传到npm上使用,npm,node.js,上传自己的npm项目

在项目中使用命令安装项目依赖:

npm i

  运行项目:

npm run dev

 运行成功界面:

如何自己创建一个工具项目并上传到npm上使用,npm,node.js,上传自己的npm项目

注意:

  • version:当前发布的版本号,项目每次改动后需要修改版本后再发布,  默认要0.0.1开始才能上传,相同版本是传不上去的,一定要记得每次更改了代码都改下版本号。

  • name: 包名只能小写, 不能和npm所有的的包名重复,我一开始用tool-cli,发现上传失败,名字被占用了就不行了。

package.json代码如下:

{
  "name": "tt-tool",
  "private": false, // 默认是true,要改成false,不然后期没法成功上传
  "version": "0.0.1",
  "type": "module",
  "scripts": {
    "dev": "vite",
    "build": "vite build",
    "preview": "vite preview"
  },
  "dependencies": {
    "vue": "^3.2.47"
  },
  "devDependencies": {
    "@vitejs/plugin-vue": "^4.1.0",
    "vite": "^4.3.9"
  }
}

如何自己创建一个工具项目并上传到npm上使用,npm,node.js,上传自己的npm项目

 第三步:添加npm用户信息

npm adduser    //1. 根据提示输入你的 username、password、email

如果发现输入了以上命令没有让你接着输入账号密码,那看一下你的npm配置,修改下:

npm config list    //可查看你当前的 npm 配置
 
npm config set registry https://registry.npmjs.org/    //npm 源更换为 npm 官方源

再执行npm adduser就好了 

注意:输入密码时是不会显示的,你照常输就行

如何自己创建一个工具项目并上传到npm上使用,npm,node.js,上传自己的npm项目

 发布项目:

npm publish    //发布

注意:如果发布报错“This package has been marked as private”,那更改package.json 配置,修改 private 属性值为 false 就好了。

如何自己创建一个工具项目并上传到npm上使用,npm,node.js,上传自己的npm项目

 成功的界面如下:

如何自己创建一个工具项目并上传到npm上使用,npm,node.js,上传自己的npm项目

 第四步:测试自己上传的项目是否正常

另外找一个项目输入命令安装自己上传到npm上面的项目(我的叫tt-tool)

npm install tt-tool

看到以下提示就代表成功了:

如何自己创建一个工具项目并上传到npm上使用,npm,node.js,上传自己的npm项目

第五步:如何在工具类项目中抛出一些方法供引入其它项目使用

这里我把它分为两种:

第一种:项目只抛出一些纯方法,而不是组件的形式。

1、"npm create vite demo"创建项目,框架选others 

如何自己创建一个工具项目并上传到npm上使用,npm,node.js,上传自己的npm项目

2、模板选library , 回车之后选语言就创建成功了

如何自己创建一个工具项目并上传到npm上使用,npm,node.js,上传自己的npm项目

3、项目的代码结构大致如下:

如何自己创建一个工具项目并上传到npm上使用,npm,node.js,上传自己的npm项目

 vite.config.js代码:

import { defineConfig } from "vite";

export default defineConfig({
  build: {
    //构建的库
    //通过build.lib把代码打包成一个第3方库,这个库可以直接在浏览器和node.js环境中使用
    lib: {
      entry: './lib/main.js', // 入口文件目录(相对于根目录来说)
      name: 'TtUtils', // 导出的全局变量名称
      fileName: 'ttUtils', // 构建后的代码文件名
      minify:true, // 是否对代码进行压缩
    }
  }
})

将要抛出的方法统一写在lib文件夹中

如何自己创建一个工具项目并上传到npm上使用,npm,node.js,上传自己的npm项目

 通过build命令构建项目生成目标文件(截图中是ttUtils.js),再通过npm publish命令将项目发布到npm上,外部项目通过npm install xxx的方式安装,使用前先在main.js或组件中引入。文章来源地址https://www.toymoban.com/news/detail-525090.html

到了这里,关于如何自己创建一个工具项目并上传到npm上使用的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 如何使用pycharm创建一个python项目

    1.打开pycharm,点击new project 2.修改项目存放位置,点击第二个圆圈,点击add interpreter添加解释器 3.选择一个系统内置的解释器 4.点击创建按钮即可 5.打开该项目 6.在工程的地方点击鼠标右键–》选择new–》选择python file 7.给你的python文件取一个文件名,按回车键,创建成功

    2024年02月12日
    浏览(30)
  • 如何使用Visual Studio创建第一个新项目

    第一步,打开Visual Studio进行创建新项目 这里可以选择空项目 在这里设置项目名称及位置(建议新建一个文件夹存放自己的代码) 在源文件里新建 新建源文件进行编写代码 这里可以选择文件类型设置名称 编写程序后,进行运行 如果没有错误的话,运行成功 到这里的话,你

    2024年02月12日
    浏览(47)
  • 如何使用Vue的ui界面创建一个新项目

    第一步: win+r打开命令提示符,然后输入cmd后回车。 第二步: 在命令行输入命令vue ui(中间有空格)后回车,弹出ui界面。 第三步: 点击创建,双击地址栏确定我们要保存框架的地址,回车确定该地址,然后点击下面的   第四步: 完成第三步进入以下界面: 依次输入项目名

    2024年02月05日
    浏览(41)
  • 如何使用社区版IDEA创建一个Spring Boot项目

    这篇博客,我们要教大家如何使用社区版IDEA来创建一个Spring Boot的项目。 首先我们要下载一个插件——Spring Boot Helper,只有安装了这个插件我们才能创建Spring Boot项目,如下图所示:  【注意】这个时候和平时下载插件不同,不要直接点“下载”按钮, 因为这个插件是需要

    2024年02月12日
    浏览(43)
  • 如何将自己的项目上传到github上,并进行项目管理

    将项目上传到GitHub并进行项目管理是一个多步骤的过程。以下是一个简单的示例,指导您如何完成这一过程: 1. 创建GitHub账户 如果您还没有GitHub账户,请先在 GitHub 上注册一个。 2. 创建新仓库 登录您的GitHub账户。 在GitHub主页的右上角,点击 \\\"+\\\" 图标,然后选择 \\\"New repositor

    2024年02月03日
    浏览(33)
  • 手把手教你实现一个JavaWeb项目:创建一个自己的网页博客系统(前端+后端)(一)

    一篇博客带你实现一个真正的项目!  先来看看它是什么样式的: 目录: 1、大体步骤🦖:         1、创建Maven项目🦕         2、引入依赖🦕         3、创建必要的目录🦕         4、编写代码🦕         5、打包部署(基于SmartTomcat)🦕         

    2024年02月06日
    浏览(43)
  • Python基础篇(一):如何使用PyCharm创建第一个Python项目(包含tools)

    环境 版本 Python 3.11.4 PyCharm 2023.1.2 OS windows10 PyCharm是一款由JetBrains开发的强大的Python集成开发环境(IDE)。它提供了丰富的功能和工具,旨在提高Python开发者的生产力和效率。以下是PyCharm的一些主要特点和功能: 代码编辑和智能感知:PyCharm提供了先进的代码编辑器,具有语

    2024年02月11日
    浏览(44)
  • 上传自己的npm依赖包

    有时候我们需要对某个依赖包的源码进行修改进行使用,但我们又不能对已有的源码官网进行上传更新,这时,我们可以获取依赖包进行修改后,自行部署到https://npmjs.com中 1.官网https://npmjs.com中注册一个账号(账号,密码,邮箱,记住了,到时候要用) 2.对自己要上传的依赖

    2024年02月11日
    浏览(28)
  • 文本----简单编写文章的方法(中),后端接口的编写,自己编写好页面就上传到自己的服务器上,使用富文本编辑器进行编辑,想写好一个项目,先分析一下需求,再理一下实现思路,再搞几层,配好参数校验,lomb

    1.1 今天在编写代码的时候,突然想实现一个目标:怎样能够在自己的网站上发一些文章  (lingyidianke.com) 1.2 参考自己之前写的一些资料,做一做试试,那么怎么做呢?首先,我们参考一下我们之前的资料,之前写过的大事件资料: 1.2.1 从项目结构上看,我们要创两个项目 1

    2024年02月19日
    浏览(42)
  • Gitee平台如何Clone别人的项目再上传到自己新建的仓库

    PS :注意需要在本地先安装Git软件 文章来源于:Qiujianju 1.找到自己下载的别人的项目的文件夹所在地 2.在当前页面右键点击Git Bash Here 打开窗口如图   3.git clone 代码地址( 如果已经从idea里面下载过了,则不需要这一步 ),此情况用于只知道项目url的情况 4.进入克隆下的项目中,

    2024年02月12日
    浏览(54)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包