lin-first
v1.3.0
Published
first package
Downloads
7
Readme
npm包发布测试
一、初始化项目
创建项目文件夹: 在你的计算机上创建一个新的文件夹,用于存放你的 npm 包项目。
初始化 npm 项目: 打开命令行界面,进入到项目文件夹中,并运行以下命令初始化 npm 项目:
npm init -y
这个命令会引导你填写项目的基本信息,比如包名称、版本、描述等,并生成一个 package.json 文件。
编写代码: 在项目文件夹中编写你的 npm 包的代码,包括 JavaScript 文件、配置文件等。
编写 README 文件: 创建一个 README.md 文件,用于描述你的 npm 包的用途、安装方法、使用示例等。
编写测试代码(可选): 如果需要对你的 npm 包进行测试,可以编写测试代码,并使用适当的测试框架进行测试。
二、编写 package.json 文件
package.json 文件是 npm 包的配置文件,用于描述 npm 包的基本信息、依赖关系和脚本等。
- 包名称: 在 package.json 文件中,将 "name" 字段的值设置为你的 npm 包的名称。
- 包版本: 在 package.json 文件中,将 "version" 字段的值设置为你的 npm 包的版本号。
- 包描述: 在 package.json 文件中,将 "description" 字段的值设置为你的 npm 包的描述。
- 包入口文件: 在 package.json 文件中,将 "main" 字段的值设置为你的 npm 包的入口文件。
- 包依赖: 在 package.json 文件中,将 "dependencies" 字段的值设置为你的 npm 包的依赖关系。
- 包作者: 在 package.json 文件中,将 "author" 字段的值设置为你的 npm 包的作者信息。
- 包许可证: 在 package.json 文件中,将 "license" 字段的值设置为你的 npm 包的许可证。
- 包脚本: 在 package.json 文件中,将 "scripts" 字段的值设置为你的 npm 包的脚本命令。
- 包仓库: 在 package.json 文件中,将 "repository" 字段的值设置为你的 npm 包的仓库地址。
- 包关键字: 在 package.json 文件中,将 "keywords" 字段的值设置为你的 npm 包的关键字。
- 包主页: 在 package.json 文件中,将 "homepage" 字段的值设置为你的 npm 包的官网地址。
- 包 bug 报告: 在 package.json 文件中,将 "bugs" 字段的值设置为你的 npm 包的 bug 报告地址。
- 包贡献者: 在 package.json 文件中,将 "contributors" 字段的值设置为你的 npm 包的贡献者信息。
- 包维护者: 在 package.json 文件中,将 "maintainers" 字段的值设置为你的 npm 包的维护者信息。
- 包贡献者: 在 package.json 文件中,将 "contributors" 字段的值设置为你的 npm 包的贡献者信息。
三、账号注册
- 创建 npm 账号: 如果你还没有 npm 账号,首先需要在 npm 官网 上注册一个账号。
- 登录 npm 账号: 在命令行中,运行以下命令登录 npm 账号:
npm login
- 验证登录状态: 登录成功后,你可以使用以下命令来验证当前登录状态:
npm whoami
如果输出了你的 npm 用户名,则表示登录成功。
四、发布 npm 包
- 登录 npm。
- 确认包名唯一性: 在发布包之前,确保你的包名在 npm 上是唯一的,否则可能会与现有的包冲突。
- 验证包内容和版本号: 在发布之前,确保你的包内容完整、符合规范,并且已经更新了正确的版本号。
- 发布 npm 包: 在命令行中,运行以下命令将你的 npm 包发布到 npm 上:
npm publish
五、更新 npm 包
npm verion patch # 更新补丁版本号
npm version minor # 更新次版本号
npm version major # 更新主版本号
六、demo
index.js
文件编写代码,并上传到npm仓库:
function sayHello() {
console.log("Hello, lin-first!");
}
module.exports = sayHello;
- 其它项目使用:
npm i lin-first
import linFirst from 'lin-first'
linFirst()