1. 这是什么？

validate-npm-package-name的作用就是：检验npm包的名称是否符合命名标准。

官网中也列出这个工具应该如何使用且举例了正确的包名称

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

2.学习目标

粗略的看了一下源码的内容，能大致知道通过本次阅读能学习到的知识有：

  • 知道正确的包名称应该怎么命名
  • 简单理解正则表达式

3.阅读源码

整个源码分为两个函数

  • validate()，接收一个参数——包名称
  • done()，接收两个参数——警告数组、错误数组

3.1 validate()

这部分主要是一些字符串判断的校验

  1. var validate = module.exports = function (name) {
  2.   var warnings = []
  3.   var errors = []
  5.   // 不能为null
  6.   if (name === null) {
  7.     errors.push('name cannot be null')
  8.     return done(warnings, errors)
  9.   }
  11.   // 不能为undefined
  12.   if (name === undefined) {
  13.     errors.push('name cannot be undefined')
  14.     return done(warnings, errors)
  15.   }
  17.   // 必须是一个字符串
  18.   if (typeof name !== 'string') {
  19.     errors.push('name must be a string')
  20.     return done(warnings, errors)
  21.   }
  23.   // 名称不能为空
  24.   if (!name.length) {
  25.     errors.push('name length must be greater than zero')
  26.   }
  28.   // 名称不能以.开头
  29.   if (name.match(/^\./)) {
  30.     errors.push('name cannot start with a period')
  31.   }
  33.   // 名称不能以下划线开头
  34.   if (name.match(/^_/)) {
  35.     errors.push('name cannot start with an underscore')
  36.   }
  38.   // 名称尾部不能有空格
  39.   if (name.trim() !== name) {
  40.     errors.push('name cannot contain leading or trailing spaces')
  41.   }
  43.   /* var blacklist = [
  44.       'node_modules',
  45.       'favicon.ico'
  46.         ]
  47.   */
  48.   // 不能出现黑名单中的名字
  49.   // No funny business
  50.   blacklist.forEach(function (blacklistedName) {
  51.     if (name.toLowerCase() === blacklistedName) {
  52.       errors.push(blacklistedName + ' is a blacklisted name')
  53.     }
  54.   })
  57.   // 不能是node内置模块的名称，这里引入了一个包，包里是node内置模块的数组
  58.   // core module names like http, events, util, etc
  59.   builtins.forEach(function (builtin) {
  60.     if (name.toLowerCase() === builtin) {
  61.       warnings.push(builtin + ' is a core module name')
  62.     }
  63.   })
  65.   // 名称不可以很长很长很长很长
  66.   if (name.length > 214) {
  67.     warnings.push('name can no longer contain more than 214 characters')
  68.   }
  70.   // 大小写不能同时出现
  71.   if (name.toLowerCase() !== name) {
  72.     warnings.push('name can no longer contain capital letters')
  73.   }
  75.   // 不能包含()~ ! *等符号
  76.   if (/[~'!()*]/.test(name.split('/').slice(-1)[0])) {
  77.     warnings.push('name can no longer contain special characters ("~\'!()*")')
  78.   }
  80.   // 有些内容可能会出现歧义，所以需要encode一下，比如出现/，或@baidu/anti-spam
  81.   // 如果encode前后内容一致，则会通过
  82.   // 否则会报错
  83.   if (encodeURIComponent(name) !== name) {
  84.     // Maybe it's a scoped package name, like @user/package
  85.     var nameMatch = name.match(scopedPackagePattern)
  86.     if (nameMatch) {
  87.       var user = nameMatch[1]
  88.       var pkg = nameMatch[2]
  89.       if (encodeURIComponent(user) === user && encodeURIComponent(pkg) === pkg) {
  90.         return done(warnings, errors)
  91.       }
  92.     }
  94.     errors.push('name can only contain URL-friendly characters')
  95.   }
  97.   return done(warnings, errors)
  98. }

这一部分已经将所有包命名规则都校验了一遍，如果出现不合理的情况时，则会往errors、warnings数组中push错误信息

3.2 done()

这一部分则是对校验完的参数进行处理

  1. var done = function (warnings, errors) {
  2.   var result = {
  3.     // 如果没有错误和警告，就为true
  4.     validForNewPackages: errors.length === 0 && warnings.length === 0,
  5.     // 如果没有错误就为true
  6.     validForOldPackages: errors.length === 0,
  7.     warnings: warnings,
  8.     errors: errors
  9.   }
  10.   // 检查errors、warnings数组的长度，如果有空，则删除该属性
  11.   if (!result.warnings.length) delete result.warnings
  12.   if (!result.errors.length) delete result.errors
  14.   // 返回一个校验后的最终结果对象
  15.   return result
  16. }

4. 总结

这次的源码较其他期比较简单，但也能学习到如果需要制定一个公共的约定时，需要考虑的判断因素会比较多，各方面都需要进行考虑。因此在项目开发中，对复杂的业务场景进行处理时，也应该考虑各种情况的出现，避免代码出现问题