likes
comments
collection
share

发布你的首个npm包,为开源做贡献引言 发布自己的第一个npm包是一个令人兴奋的里程碑,它不仅能展示你的技术能力,还能为

作者站长头像
站长
· 阅读数 36

发布你的首个npm包,为开源做贡献引言 发布自己的第一个npm包是一个令人兴奋的里程碑,它不仅能展示你的技术能力,还能为

引言

发布自己的第一个npm包是一个令人兴奋的里程碑,它不仅能展示你的技术能力,还能为开源社区做出贡献。日常工作中,我们常常用‘大牛’们的npm包,实际上,千里之行始于足下,你也可以,今天就开始花5分钟,建一个自己的包,改进,优化,给别人用,成为小牛。

准备工作

要创建并发布一个 npm 包,可以按照以下简单步骤操作:


步骤一:注册 npm 账号

  1. 前往 npm官网
  2. 点击“注册”并填写用户名、密码和邮箱。
  3. 注册完成后,检查邮箱并验证账号。

步骤二:创建项目文件夹

  1. 在计算机上创建一个新文件夹,例如 my-npm-package
  2. 打开命令行工具,进入该文件夹:
        mkdir my-add-package
        cd my-add-package
    

步骤三:初始化 npm 项目

  1. 在命令行中运行以下命令来初始化项目:
        npm init -y
    
    按提示填写包名、版本号等信息,可以直接回车使用默认值。
  2. 生成的 package.json 文件包含您输入的信息。确保包名唯一,可在 npm 上搜索确认。
    {
      "name": "my-add-package",
      "version": "1.0.0",
      "main": "index.js",
      ...
    }
    

步骤四:编写代码

  1. 在项目文件夹中创建一个 JavaScript 文件,例如 index.js,编写代码。例如:
        function add(a, b) {
            return a + b;
        }
    
        module.exports = add;
    

步骤五:登录 npm 账户

  1. 在命令行中登录您的 npm 账号:
    npm login
    
    按提示输入用户名、密码和邮箱。

步骤六:发布 npm 包

  1. 确保已连接到 npm 官方镜像(可通过以下命令切换):
    npm config set registry https://registry.npmjs.org/
    
  2. 发布包:
    npm publish
    
    发布成功后,如果一切顺利,你的包就会被上传到 npm 仓库。你可以在 npmjs.com 上搜索你的包名来确认它是否成功发布。

[可跳过]步骤七:更新 npm 包

  1. 修改代码或文档。
  2. 更新 package.json 中的版本号(遵循语义化版本控制)。
  3. 使用以下命令自动更新补丁版本并重新发布:
    npm version patch
    npm publish
    

[可跳过]步骤八:撤销已发布的包

如果需要撤销已发布的包,可以使用以下命令(注意:只有在发布后 24 小时内才允许撤销):

    npm unpublish <package-name> --force

譬如,下面这个是我发的包,大家可以通过npm i my-add-package下载.

步骤九:使用这个包

    const add = require('my-add-package');
    console.log(add(2, 3)); // 输出: 5

写在最后

  1. 是不是有爬虫在刷和扫描?我都没有推广,就有74个下载.
  2. 如果你使用了国内代理镜像,可能无法登陆,你需要先切回国际代理镜像.

祝你开发的开心,有成就感!

转载自:https://juejin.cn/post/7426035420730179594
评论
请登录