npm包的命名规范

1. 包名类似,拒绝发布

把包名中的标点符号去掉并与现有的包进行比较,相同则不允许发布
例如:react-native已经存在,那么诸如

  • reactnative
  • react_native
  • react.native
    就不可以再发布了

2. 使用作用域

如果因为你起的包名与现有的包名太相近而被阻止发布这个包,那么找到一个独一无二包名最简单方法就是使用自己的作用域。你可以使用@+你的npm用户名加在包名前面将包划到你的npm账户作用域下。比如,我的npm用户名是jackie,所以我的作用域是@jackie
所以在package.json文件里把

{
    "name": “react-native"
}

修改成

{
    "name": “@jackie/react-native"
}

然后我要发布这个包。被划了作用域的包默认是私有的,所以要通过—access=public让它变为公有的包:

> npm publish --access=public
+ @jackie/react-native@1.0.0

3. 包命名的历史

在npm注册表上,包名的历史是一个很小心的地添加条件限制的过程。在最早的时候,npm允许在包名上添加url安全字符,包括大写和小写字母。但是现在创建的包名中不能再有大写字母了,但是在npm注册表中那些包名中有大写字母的包依然存在也依然在使用,包名仅仅在大小写上的差异让我们第一次遇到了误植事件!
可能大多数人遇到的例子是jsonstream。JSONStream 和 jsonstream 是不同的包但是很难区分,在一些大小写不敏感的系统中安装这些包就可能有问题

4. 好的包名可以帮助到所有人

我们希望新的包名规则可以帮助包开发者们挑选出合适的名字,并且能够帮助用户去避免意外获取到错误的包。

原作者:Wendy曹
链接:https://www.jianshu.com/p/7dc0083f30a6
来源:简书
简书著作权归作者所有。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值