开发并发布一个属于自己的包(npm)

一、CommonJS规范导入require

创建一个npm包涉及几个步骤,包括设置你的项目结构、编写代码、编写文档、测试你的代码,以及发布到npm仓库。以下是一个基本的指南,帮助你从头开始创建一个npm包。

步骤 1: 初始化npm项目

  1. 创建项目文件夹:首先,你需要一个文件夹来存放你的项目。

    mkdir muzidigbig-utils-npm
    cd muzidigbig-utils-npm
  2. 初始化npm项目:在项目文件夹中,运行以下命令来初始化一个新的npm项目。

    npm init -y

    这会创建一个package.json文件,包含一些默认设置。

步骤 2: 编写代码

  1. 创建文件:根据你的包需要,创建必要的文件和目录结构。例如,如果你打算创建一个简单的工具函数库,你可以创建一个index.js文件。

    // index.js
    function sayHello(name) {return `Hello, ${name}!`;
    }module.exports = { sayHello };

步骤 3: 编写文档

  1. 更新package.json:在package.json文件中,你可以添加更详细的描述、关键字、作者信息等。

    {"name": "muzidigbig-utils-npm","version": "1.0.0","description": "A simple npm package example.","main": "index.js","scripts": {"test": "echo \"Error: no test specified\" && exit 1"},"keywords": ["muzidigbig", "utils", "npm"],"author": "muzidigbig","license": "ISC"
    }

name: 包名称,
version: 版本号,
description: 包描述,
main: 入口文件,
keywords:数组(搜索关键字),
license:开源协议 

步骤 4: 测试你的代码

  1. 添加测试脚本:你可以使用Jest、Mocha等测试框架来测试你的代码。首先,安装Jest:

    npm install --save-dev jest
  2. 创建测试文件:例如,创建一个 test/my-package.test.js 文件:

    const { sayHello } = require('../index');
    test('says hello', () => {expect(sayHello('World')).toBe('Hello, World!');
    });
  3. 更新package.json的scripts:添加一个测试脚

    "scripts": {"test": "jest"
    }
  4. 运行测试

    npm test


步骤 5: 发布到npm仓库

  1. 登录到npm:如果你还没有登录,运行以下命令:

    npm login


    首先确保你本地的镜像为 npm 镜像

    查看镜像
    npm config get registry修改为 npm镜像
    npm config set registry https://registry.npmjs.org/修改为 npm镜像(全局)
    sudo npm config set -g registry https://registry.npmjs.org/
  2. 发布包确保你的版本号在package.json中是唯一的(遵循语义版本控制),然后运行:

    npm publish

    每次 npm publish 都需要修改 package.json version版本号保证其唯一。

  3. 验证发布:登录到npm网站,查看你的包是否已经发布。
    通过以上步骤,你可以成功创建一个并发布一个npm包。记得在开发过程中不断更新文档和添加更多功能,以使你的包更加完善和有用。

删除 npm包

执行命令 npm unpublish 包名 --force,即可从 npm 删除已发布的包。

注意
① npm unpublish 命令只能删除 72 小时以内发布的包
② npm unpublish 删除的包,在 24 小时内不允许重复发布

Usage 用法

1.项目中安装依赖: 

npm install muzidigbig-utils-npm

2.引入包 

// const { sayHello } = require('muzidigbig-utils-npm');
import { sayHello } from 'muzidigbig-utils-npm'; // ES6
console.log(sayHello('World')); // Outputs: Hello, World!

二、升级为ES6模块导入(import/export)

Node.js > v13.2.0

步骤 1: 设置type为module

在项目的package.json中添加"type": "module",这样Node.js会将所有的.js文件都当成ES6模块来处理‌

步骤 2: 代码转译

使用如Babel这样的转译工具将代码转译为兼容老版本Node.js的格式‌ 

npm i @babel/core @babel/preset-env

配置 Babel

通常使用 .babelrc 文件或 babel.config.cjs 文件来配置 Babel

module.exports = {presets: ['@babel/preset-env'],
}

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/902705.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

CRTP(Curiously Recurring Template Pattern)

C 中的 CRTP(奇异递归模板模式) CRTP(Curiously Recurring Template Pattern)是一种利用模板继承实现 静态多态(Static Polymorphism) 的设计模式。通过基类模板以派生类作为模板参数,CRTP 允许…

小白工具视频转MPG, 功能丰富齐全,无需下载软件,在线使用,超实用

在视频格式转换需求日益多样的今天,小白工具网的在线视频转 MPG 功能https://www.xiaobaitool.net/videos/convert-to-mpg/ )脱颖而出,凭借其出色特性,成为众多用户处理视频格式转换的优质选择。 从格式兼容性来看,它支…

银河麒麟系统离线安装nodejs

本篇文章我们介绍如何通过nvm(node版本管理工具)来实现离线安装nodejs 第一步:下载nvm https://github.com/nvm-sh/nvm/releases/tag/v0.40.1 在页面找到【Source code(tar.gz)】下载 第二步:安装nvm 将下载好的tar.gz拷贝到银河麒麟系统文件夹下(加…

Go语言中包导入下划线的作用解析

在Go语言的代码中,有时会看到类似以下的导入语句: import _ "github.com/mattn/go-sqlite3"这种以下划线_开头的导入方式,显得有些特别,尤其是对于新手来说,可能会感到困惑,为什么要这样写&…

Winddows11官网下载安装VMware Workstation Pro17(图文详解)

Winddows11安装VMware17 1、官网下载2、安装3、总结 1、官网下载 官网地址 点击Products,滑到最下面,选择SEE DESKTOPP HYPERVISORS 选择 DOWNLOAD FUSION OR WORKSTATION 自动跳转到下面哪个服界面,注册 输入邮箱地址和图片下面的文字…

DeepSeek智能时空数据分析(二):3秒对话式搞定“等时圈”绘制

序言:时空数据分析很有用,但是GIS/时空数据库技术门槛太高 时空数据分析在优化业务运营中至关重要,然而,三大挑战仍制约其发展:技术门槛高,需融合GIS理论、SQL开发与时空数据库等多领域知识;空…

【Linux网络】应用层自定义协议与序列化及Socket模拟封装

📢博客主页:https://blog.csdn.net/2301_779549673 📢博客仓库:https://gitee.com/JohnKingW/linux_test/tree/master/lesson 📢欢迎点赞 👍 收藏 ⭐留言 📝 如有错误敬请指正! &…

基于大模型的结肠癌全病程预测与诊疗方案研究

目录 一、引言 1.1 研究背景与意义 1.2 研究目的与创新点 二、结肠癌概述 2.1 流行病学特征 2.2 发病机制与危险因素 2.3 临床症状与诊断方法 三、大模型技术原理与应用现状 3.1 大模型的基本原理 3.2 在医疗领域的应用情况 3.3 在结肠癌预测中的潜力分析 四、术前…

【UML建模】starUML工具

一.概述 StarUML是一款UML工具,允许用户创建和管理UML(统一建模语言)模型,广泛应用于软件工程领域。它的主要功能包括创建各种UML图:如用例图、类图、序列图等,支持代码生成与反向工程,以及提供…

模板元编程(Template Metaprogramming, TMP)

C 模板元编程(Template Metaprogramming, TMP) 模板元编程是一种利用 C 模板系统在 编译期间 完成计算、类型操作和代码生成的编程范式。其核心优势在于通过 零运行时开销 实现高效、类型安全的代码。以下是模板元编程的详细分步解析。 1. 编译时计算 …

Android Build Variants(构建变体)详解

Android Build Variants(构建变体)是 Android 开发中用于生成不同版本应用程序的一种机制。它允许开发者根据不同的需求,如不同的应用市场、不同的功能模块、不同的环境配置等,从同一个代码库中生成多个不同的 APK。 组成部分 B…

26考研|数学分析:数项级数

数项级数这一章的开始,开启了新的关于“级数”这一新的概念体系的学习进程,此部分共包含四章的内容,分别为数项级数、函数项级数、幂级数以及傅里叶级数。这一章中,首先要掌握级数的相关概念与定义,重难点在于掌握判断…

拥抱健康生活,解锁养生之道

在生活节奏日益加快的当下,健康养生已成为人们关注的焦点。科学的养生方法,能帮助我们增强体质、预防疾病,以更饱满的精神状态拥抱生活。 合理饮食是养生的基石。《黄帝内经》中提到 “五谷为养,五果为助,五畜为益&…

房地产安装工程师简历模板

模板信息 简历范文名称:房地产安装工程师简历模板,所属行业:其他 | 职位,模板编号:XUCP9X 专业的个人简历模板,逻辑清晰,排版简洁美观,让你的个人简历显得更专业,找到好…

HTML5 详细学习笔记

1. HTML5 简介 HTML5 是最新的 HTML 标准&#xff0c;于 2014 年 10 月由 W3C 完成标准制定。它增加了许多新特性&#xff0c;包括语义化标签、多媒体支持、图形效果、离线存储等。 1.1 HTML5 文档基本结构 <!DOCTYPE html> <html lang"zh-CN"> <h…

【网络入侵检测】基于Suricata源码分析NFQ IPS模式实现

【作者主页】只道当时是寻常 【专栏介绍】Suricata入侵检测。专注网络、主机安全,欢迎关注与评论。 1. 概要 👋 本文聚焦于 Suricata 7.0.10 版本源码,深入剖析其 NFQ(Netfilter Queue)模式的实现原理。通过系统性拆解初始化阶段的配置流程、数据包监听机制的构建逻辑,以…

C语言结构体和union内存对齐

在C语言的世界里&#xff0c;结构体&#xff08;struct&#xff09;和联合体&#xff08;union&#xff09;的内存布局一直是困扰许多开发者的难题。当我们定义一个结构体时&#xff0c;编译器会按照特定的规则为每个成员分配内存空间&#xff0c;这些规则被称为内存对齐。看似…

本地部署DeepSeek-R1模型接入PyCharm

以下是DeepSeek-R1本地部署及接入PyCharm的详细步骤指南,整合了视频内容及官方文档核心要点: 一、本地部署DeepSeek-R1模型 1. 安装Ollama框架 ​下载安装包 访问Ollama官网(https://ollama.com/download)Windows用户选择.exe文件,macOS用户选择.dmg包。 ​安装验证 双击…

IEEE综述 | 车道拓扑推理20年演进:从程序化建模到车载传感器

导读 车道拓扑推理对于高精建图和自动驾驶应用至关重要&#xff0c;从早期的程序化建模方法发展到基于车载传感器的方法&#xff0c;但是很少有工作对车道拓扑推理技术进行全面概述。为此&#xff0c;本文系统性地调研了车道拓扑推理技术&#xff0c;同时确定了未来研究的挑战和…

开源模型应用落地-语音合成-MegaTTS3-零样本克隆与多语言生成的突破

一、前言 在人工智能技术飞速发展的今天,文本转语音(TTS)技术正以前所未有的速度改变着人机交互的方式。近日,字节跳动与浙江大学联合推出了一款名为MegaTTS3 的开源TTS模型,再次刷新了行业对高质量语音合成的认知。作为一款轻量化设计的模型,MegaTTS3以仅0.45亿参数 的规…