创建并发布 Scoped NPM 模块

2024-08-09 10:10:31 浏览数 (1)

接前一篇文章,如果创建的 NPM 包在 NPM 上已经存在,那么此时可以修改包名,或者通过Scoped NPM包的方式发布。

Scoped NPM包是指那些以@符号开头的NPM包,这些包通常用于组织内部的项目。

创建一个Scoped NPM模块

在创建NPM模块之前,你需要先创建一个Scoped NPM模块。

代码语言:javascript复制
$ mkdir my-npm-package
$ cd my-npm-package
$ npm init --scope=@<user>

如果工程已经创建了,可以在工程目录下运行 npm adduser 来添加用户

代码语言:javascript复制
$ npm adduser --scope=@<user>

此时package.json文件中name字段会包含scope内容<user>,比如:

代码语言:javascript复制
...
"name": "@<user>/my-npm-package",
...

添加模块代码

创建新文件 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 @<user>/my-npm-package 

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

创建测试代码,比如创建 test.js 文件,内容如下,导入包的时候需要添加scope内容<user>。

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

helloworld();

运行测试

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

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

发布NPM包

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

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

$ npm publish --access public

npm notice 
npm notice 


	

0 人点赞