发布一个npm包和命令行脚本

简介: 发布一个npm包和命令行脚本

1、注册账号

https://www.npmjs.com/


2、初始化npm项目


npm init

目录结构


├── index.js
└── package.json

3、项目配置

package.json
{
  "name": "2020ooxx",
  "version": "1.0.5",
  "description": "a demo package",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "mouday",
  "license": "ISC",
  "dependencies": {
  }
}

配置参数

https://docs.npmjs.com/files/package.json


常用参数


main:程序的入口文件,默认是index.js
devDependencies: 所依赖的开发环境下的包
dependencies:所依赖的线上环境下的包
repository: 代码存放地址(一般是git地址)
keywords:npm 包关键词

4、模块开发

index.js

function hello() {
    console.log("hello");
}
// 导出模块
module.exports.hello = hello

5、登录发布


# 检查npm源
npm config get registry
# 如过不是下面的地址需要设置
npm config set registry https://registry.npmjs.org
# 登录
npm adduser
# 发包
npm publish

6、安装测试

npm i 2020ooxx

demo.js


// 使用示例
// var ooxx = require("./index")
var ooxx = require("2020ooxx")
ooxx.hello();
// hello

7、命令行工具

bin/index.js


#!/usr/bin/env node
console.log("hi");

注意:不能缺少#!/usr/bin/env node


修改package.json

{
  "bin": {
    "my-cli": "bin/index.js"
  }
}

本地调试


$ npm link
$ my-cli
# hi

调试完成后可以发布

相关文章
|
2月前
|
JavaScript 前端开发 Java
npm学习一:npm 包管理工具 学习、使用。
这篇文章介绍了npm的基础知识和常用命令,包括安装包、查看包信息、管理依赖等操作,并提供了如何删除npm安装的镜像以及如何彻底删除node_modules文件夹的具体步骤。
104 2
|
2月前
|
JavaScript 前端开发 Java
npm学习一:npm 包管理工具 学习、使用。
这篇文章是关于npm包管理工具的学习、使用指南,包括npm概述、基础命令和如何安装webpack。
73 3
npm学习一:npm 包管理工具 学习、使用。
|
2月前
|
资源调度 前端开发 安全
前端实战:基于Verdaccio搭建私有npm仓库,轻松上传与下载自定义npm插件包
前端实战:基于Verdaccio搭建私有npm仓库,轻松上传与下载自定义npm插件包
127 0
|
3月前
|
数据安全/隐私保护
发布一个npm包
发布一个npm包
123 2
|
5月前
|
运维 Kubernetes Java
阿里云云效操作报错合集之npm包已经发布到了制品仓库,但流水线中拉取依赖时出现404错误,该如何排查
本合集将整理呈现用户在使用过程中遇到的报错及其对应的解决办法,包括但不限于账户权限设置错误、项目配置不正确、代码提交冲突、构建任务执行失败、测试环境异常、需求流转阻塞等问题。阿里云云效是一站式企业级研发协同和DevOps平台,为企业提供从需求规划、开发、测试、发布到运维、运营的全流程端到端服务和工具支撑,致力于提升企业的研发效能和创新能力。
阿里云云效操作报错合集之npm包已经发布到了制品仓库,但流水线中拉取依赖时出现404错误,该如何排查
|
4月前
NPM——删除已发布的包
NPM——删除已发布的包
151 1
|
4月前
|
JavaScript 前端开发 开发者
从零到一:教你如何发布自己的npm插件包
从零到一:教你如何发布自己的npm插件包
|
4月前
|
JavaScript
GitHub——自动发布NPM包
GitHub——自动发布NPM包
36 0
|
5月前
|
JavaScript 测试技术
npm发布自己的插件包
npm发布自己的插件包
|
5月前
|
JavaScript 开发工具 数据安全/隐私保护
npm包【详解】(内含npm包的开发、发布、安装、更新、搜索、卸载、查看、版本号更新规则、package.json详解等)
npm包【详解】(内含npm包的开发、发布、安装、更新、搜索、卸载、查看、版本号更新规则、package.json详解等)
125 0