1. 源码简介

validate-npm-package-name 作用：检测 npm 包的名称是否符合标准

简单例子：

  2. var validate = require("validate-npm-package-name")
  4. validate("some-package")
  5. validate("example.com")
  6. validate("under_score")
  7. validate("123numeric")
  8. validate("@npm/thingy")
  9. validate("@jane/foo.js")

学习目标：
1）学习 validate-npm-package-name 源码，了解它的使用场景，输出记录文档。

源码地址：
https://github.com/npm/validate-npm-package-name

2. 源码

源码是一个 100 行左右的 js 文件，我们来解读一下它的逻辑：

  1. var scopedPackagePattern = new RegExp('^(?:@([^/]+?)[/])?([^/]+?)$')
  2. var builtins = require('builtins')
  3. var blacklist = [
  4.   'node_modules',
  5.   'favicon.ico'
  6. ]
  8. var validate = module.exports = function (name) {
  9.   var warnings = []
  10.   var errors = []
  11.   // 验证是否 null
  12.   if (name === null) {
  13.     errors.push('name cannot be null')
  14.     return done(warnings, errors)
  15.   }
  16.   // 验证是否 undefined
  17.   if (name === undefined) {
  18.     errors.push('name cannot be undefined')
  19.     return done(warnings, errors)
  20.   }
  21.   // 验证是否 string 类型
  22.   if (typeof name !== 'string') {
  23.     errors.push('name must be a string')
  24.     return done(warnings, errors)
  25.   }
  26.   // 验证 name 长度
  27.   if (!name.length) {
  28.     errors.push('name length must be greater than zero')
  29.   }
  30.   // 验证 name 是否以.开头
  31.   if (name.match(/^\./)) {
  32.     errors.push('name cannot start with a period')
  33.   }
  34.   // 验证 name 是否以_开头
  35.   if (name.match(/^_/)) {
  36.     errors.push('name cannot start with an underscore')
  37.   }
  38.   // 验证 name 前导或尾随是否包含空格
  39.   if (name.trim() !== name) {
  40.     errors.push('name cannot contain leading or trailing spaces')
  41.   }
  43.   // 不能是黑名单里的包
  44.   blacklist.forEach(function (blacklistedName) {
  45.     if (name.toLowerCase() === blacklistedName) {
  46.       errors.push(blacklistedName + ' is a blacklisted name')
  47.     }
  48.   })
  50.   // 不能是node.js 内置模块列表
  51.   builtins.forEach(function (builtin) {
  52.     if (name.toLowerCase() === builtin) {
  53.       warnings.push(builtin + ' is a core module name')
  54.     }
  55.   })
  57.   // 限制包名长度
  58.   if (name.length > 214) {
  59.     warnings.push('name can no longer contain more than 214 characters')
  60.   }
  62.   // 包名不能包含大写字母
  63.   if (name.toLowerCase() !== name) {
  64.     warnings.push('name can no longer contain capital letters')
  65.   }
  67.   // 包名不能包含特殊符号：~\'!()*
  68.   if (/[~'!()*]/.test(name.split('/').slice(-1)[0])) {
  69.     warnings.push('name can no longer contain special characters ("~\'!()*")')
  70.   }
  72.   // 有些字符会引起歧义，使用 encodeURIComponent 编码
  73.   if (encodeURIComponent(name) !== name) {
  74.     // Maybe it's a scoped package name, like @user/package
  75.     var nameMatch = name.match(scopedPackagePattern)
  76.     if (nameMatch) {
  77.       var user = nameMatch[1]
  78.       var pkg = nameMatch[2]
  79.       if (encodeURIComponent(user) === user && encodeURIComponent(pkg) === pkg) {
  80.         return done(warnings, errors)
  81.       }
  82.     }
  84.     errors.push('name can only contain URL-friendly characters')
  85.   }
  87.   return done(warnings, errors)
  88. }
  90. // scopedPackagePattern 暴露给外面使用，方便私域定制npm发布设置校验规则
  91. validate.scopedPackagePattern = scopedPackagePattern
  93. // 结果返回函数
  94. var done = function (warnings, errors) {
  95.   var result = {
  96.     validForNewPackages: errors.length === 0 && warnings.length === 0,
  97.     validForOldPackages: errors.length === 0,
  98.     warnings: warnings,
  99.     errors: errors
  100.   }
  101.   if (!result.warnings.length) delete result.warnings
  102.   if (!result.errors.length) delete result.errors
  103.   return result
  104. }

3. 总结

validate-npm-package-name 其实就是一个校验包名的函数，很简单~
它的应用场景很广泛，可以用于验证组件库包名（就不用自己写验证了~），做 cli 脚手架时创建项目也可以用到，只要是规则一致。