简介

validate-npm-package-name,顾名思义，主要是用来校验包名是否符合规范。传入一个字符串，返回一个包含
以下两个属性的一个对象。

  1. validForNewPackages :: Boolean
  2. validForOldPackages :: Boolean

用法

  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")

上面的结果都是：

  1. {
  2.   validForNewPackages: true,
  3.   validForOldPackages: true
  4. }

源码分析

现在进入源码部分，我们可以看到package.json中包含了一些依赖

package.json

  1. {
  2.     ...
  3.    "dependencies": {
  4.     "builtins": "^1.0.3"
  5.   },
  6.   "devDependencies": {
  7.     "standard": "^8.6.0",
  8.     "tap": "^10.0.0"
  9.   },
  10.   "scripts": {
  11.     "cov:test": "TAP_FLAGS='--cov' npm run test:code",
  12.     "test:code": "tap ${TAP_FLAGS:-'--'} test/*.js",
  13.     "test:style": "standard",
  14.     "test": "npm run test:code && npm run test:style"
  15.   },
  16.   ...
  17. }

builtins是获取Node的内置模块,例如可以用以下代码获取Node中模块的信息

  1. const m = require('module');
  2. console.log(m);

红框内的就是内置模块的数据，内置模块允许修改，但是不支持新增，可参照Node.js的内置模块说明
image.png
standard是JavaScript代码规范，自带linter 和代码修正，可以参考StandardJs中文
tap是NodeJs的一个测试框架，支持覆盖测试等，并且拥有美观的测试输出，Node Tap

image.png

所以

  1. npm run test

主要是执行了tap和standard的操作

index.js

代码里的正则可视图

  1. /^(?:@([^/]+?)[/])?([^/]+?)$/

image.png

其他部分的直接贴注释：

  1. 'use strict'
  2. // 包匹配的正则
  3. var scopedPackagePattern = new RegExp('^(?:@([^/]+?)[/])?([^/]+?)$')
  5. // 获取NodeJs的内置模块
  6. var builtins = require('builtins')
  8. // 黑明单列表，name不允许存在在黑名单中
  9. var blacklist = [
  10.   'node_modules',
  11.   'favicon.ico'
  12. ]
  14. var validate = module.exports = function (name) {
  15.   // 保存警告
  16.   var warnings = []
  17.   // 保存错误
  18.   var errors = []
  20.   // 不允许为null
  21.   if (name === null) {
  22.     errors.push('name cannot be null')
  23.     return done(warnings, errors)
  24.   }
  26.   // 不允许为undefined
  27.   if (name === undefined) {
  28.     errors.push('name cannot be undefined')
  29.     return done(warnings, errors)
  30.   }
  32.   // 必须是字符串类型
  33.   if (typeof name !== 'string') {
  34.     errors.push('name must be a string')
  35.     return done(warnings, errors)
  36.   }
  38.   // 不能是空字符串
  39.   if (!name.length) {
  40.     errors.push('name length must be greater than zero')
  41.   }
  43.   // 不能以.开头
  44.   if (name.match(/^\./)) {
  45.     errors.push('name cannot start with a period')
  46.   }
  48.   // 不能以_开头
  49.   if (name.match(/^_/)) {
  50.     errors.push('name cannot start with an underscore')
  51.   }
  53.   // 不允许有前后空格
  54.   if (name.trim() !== name) {
  55.     errors.push('name cannot contain leading or trailing spaces')
  56.   }
  58.   // 不允许出现在黑名单中
  60.   // No funny business
  61.   blacklist.forEach(function (blacklistedName) {
  62.     if (name.toLowerCase() === blacklistedName) {
  63.       errors.push(blacklistedName + ' is a blacklisted name')
  64.     }
  65.   })
  67.   // Generate warnings for stuff that used to be allowed
  69.   // 不允许是核心模块的名字
  71.   // core module names like http, events, util, etc
  72.   builtins.forEach(function (builtin) {
  73.     if (name.toLowerCase() === builtin) {
  74.       warnings.push(builtin + ' is a core module name')
  75.     }
  76.   })
  78.   // 长度不能超过214
  79.   // really-long-package-names-------------------------------such--length-----many---wow
  80.   // the thisisareallyreallylongpackagenameitshouldpublishdowenowhavealimittothelengthofpackagenames-poch.
  81.   if (name.length > 214) {
  82.     warnings.push('name can no longer contain more than 214 characters')
  83.   }
  85.   // 不允许大小写的情况
  86.   // mIxeD CaSe nAMEs
  87.   if (name.toLowerCase() !== name) {
  88.     warnings.push('name can no longer contain capital letters')
  89.   }
  91.   // 不能包含特殊字符：~'!()*
  92.   if (/[~'!()*]/.test(name.split('/').slice(-1)[0])) {
  93.     warnings.push('name can no longer contain special characters ("~\'!()*")')
  94.   }
  96.   // 合法的url字符
  97.   if (encodeURIComponent(name) !== name) {
  98.     // Maybe it's a scoped package name, like @user/package
  99.     var nameMatch = name.match(scopedPackagePattern)
  100.     if (nameMatch) {
  101.       var user = nameMatch[1]
  102.       var pkg = nameMatch[2]
  103.       if (encodeURIComponent(user) === user && encodeURIComponent(pkg) === pkg) {
  104.         return done(warnings, errors)
  105.       }
  106.     }
  108.     errors.push('name can only contain URL-friendly characters')
  109.   }
  111.   return done(warnings, errors)
  112. }
  114. validate.scopedPackagePattern = scopedPackagePattern
  116. // 处理的函数
  117. var done = function (warnings, errors) {
  118.   var result = {
  119.     validForNewPackages: errors.length === 0 && warnings.length === 0,
  120.     validForOldPackages: errors.length === 0,
  121.     warnings: warnings,
  122.     errors: errors
  123.   }
  124.   if (!result.warnings.length) delete result.warnings
  125.   if (!result.errors.length) delete result.errors
  126.   return result
  127. }

总结

1.了解了builtins，standard，tap
2.复习了正则