创建并发布NPM模块

2024-08-08 08:31:59 浏览数 (2)

创建模块项目

代码语言:javascript复制
$ mkdir my-npm-package
$ cd my-npm-package
$ npm init

添加模块代码

创建新文件 index.js,内容如下

代码语言:javascript复制
function helloworld() {
    console.log('Hello World!');
}

module.exports = helloworld;

测试模块

在模块目录(my-npm-package)下执行

代码语言:javascript复制
$ cd my-npm-package
$ npm link

创建一个新的工程来使用上面创建的模块,比如测试模块叫 my-npm-package-test

代码语言:javascript复制
$ mkdir my-npm-package-test
$ cd my-npm-package-test
$ npm init

在 my-npm-package-test 工程中使用 my-npm-package 模块

代码语言:javascript复制
$ cd my-npm-package-test
$ npm link my-npm-package 

此时会在 my-npm-package-test 工程中创建一个软链接,指向 my-npm-package 模块的安装路径。

创建测试代码,比如创建 test.js 文件,内容如下

代码语言:javascript复制
const helloworld = require('my-npm-package');

helloworld();

运行测试

代码语言:javascript复制
$ node test.js
Hello World!

由于是软链接,所以 my-npm-package 模块的代码修改后,不需要重新安装,直接在 my-npm-package-test 工程中重新运行测试即可。

发布NPM模块

在发布之前,需要先登录NPM账号,执行命令 npm login 即可。

代码语言:javascript复制
$ npm login

$ npm publish

模块发布后,就可以像使用其他NPM模块一样使用它了。(比如可以使用 npm install my-npm-package 来安装模块)

0 人点赞