今天学习validate-npm-package-name的源码，以下内容来自个人总结

为什么要读validate-npm-package-name的源码？

因为我们常用的脚手架都用到了这个包，这个包用于对我们创建的项目的名字有了一定的规范。没有规矩，难以成方圆嘛。
因为我自己的技术栈是react，所以我关注了create-react-app 中对这个包的应用

  1. const validateProjectName = require('validate-npm-package-name');
  2. ...
  3. function chaeckAppName(appName){
  4.   // 通过 这个包的能力有针对性的校验名字
  5.   const validationResult = validateProjectName(appName);
  6.   // 源码中会返回一个validForNaePackages的boolean值，用于判断项目名是否通过了validationResult的校验
  7.   if (!validationResult.validForNewPackages) {
  8.     console.error(
  9.       chalk.red(
  10.         `Cannot create a project named ${chalk.green(
  11.           `"${appName}"`
  12.         )} because of npm naming restrictions:\n`
  13.       )
  14.     );
  15.     // 用于输出 validationResult 返回的所有错误信息（包括警告）
  16.     [
  17.       ...(validationResult.errors || []),
  18.       ...(validationResult.warnings || []),
  19.     ].forEach(error => {
  20.       console.error(chalk.red(`  * ${error}`));
  21.     });
  22.     console.error(chalk.red('\nPlease choose a different project name.'));
  23.     // 退出命令
  24.     process.exit(1);
  25.   }
  26. ...
  27. 其余代码
  28. ...
  29. }

出处链接：这里

解析validate-npm-package-name包

  1. // 启用严格模式
  2. 'use strict'
  4. // 定义正则用于约束名字
  5. var scopedPackagePattern = new RegExp('^(?:@([^/]+?)[/])?([^/]+?)$')
  6. // Node.js 提供的所有模块的名称列表。 可用于验证模块是否由第三方维护。
  7. var builtins = require('builtins')
  8. // 黑名单
  9. var blacklist = [
  10.   'node_modules',
  11.   'favicon.ico'
  12. ]
  13. // 主要方法
  14. var validate = module.exports = function (name) {
  15.   // 警告信息
  16.   var warnings = []
  17.   // 错误信息
  18.   var errors = []
  20.   // 输入名字不能为空
  21.   if (name === null) {
  22.     errors.push('name cannot be null')
  23.     return done(warnings, errors)
  24.   }
  25. // 输入名字不能是undefined
  26.   if (name === undefined) {
  27.     errors.push('name cannot be undefined')
  28.     return done(warnings, errors)
  29.   }
  30. // 输入名字要为字符串，不能是数字？不知道这里是否进行了内置的转换 number=>string
  31.   if (typeof name !== 'string') {
  32.     errors.push('name must be a string')
  33.     return done(warnings, errors)
  34.   }
  35. // 输入的名字必须要有长度
  36.   if (!name.length) {
  37.     errors.push('name length must be greater than zero')
  38.   }
  39. // 输入的名字不能以点开头
  40.   if (name.match(/^\./)) {
  41.     errors.push('name cannot start with a period')
  42.   }
  43. // 输入的名字不能以下划线开始
  44.   if (name.match(/^_/)) {
  45.     errors.push('name cannot start with an underscore')
  46.   }
  47. // 输入的名字不能以空格结尾
  48.   if (name.trim() !== name) {
  49.     errors.push('name cannot contain leading or trailing spaces')
  50.   }
  52.   // No funny business
  53.   // 不允许用户使用这些名字命名
  54.   blacklist.forEach(function (blacklistedName) {
  55.     if (name.toLowerCase() === blacklistedName) {
  56.       errors.push(blacklistedName + ' is a blacklisted name')
  57.     }
  58.   })
  60.   // Generate warnings for stuff that used to be allowed
  62.   // core module names like http, events, util, etc
  63.   // 用于验证输入的名字是否与core module具有相同的名字，如果有就抛出对应名称的警告
  64.   builtins.forEach(function (builtin) {
  65.     if (name.toLowerCase() === builtin) {
  66.       warnings.push(builtin + ' is a core module name')
  67.     }
  68.   })
  70.   // really-long-package-names-------------------------------such--length-----many---wow
  71.   // the thisisareallyreallylongpackagenameitshouldpublishdowenowhavealimittothelengthofpackagenames-poch.
  72.   // 规定输入名字的最大长度为214字符
  73.   if (name.length > 214) {
  74.     warnings.push('name can no longer contain more than 214 characters')
  75.   }
  77.   // mIxeD CaSe nAMEs
  78.   // 不允许输入的名字包含大写字母
  79.   if (name.toLowerCase() !== name) {
  80.     warnings.push('name can no longer contain capital letters')
  81.   }
  82. // 不允许输入的名字包含 ~ ' !()* 等符号
  83.   if (/[~'!()*]/.test(name.split('/').slice(-1)[0])) {
  84.     warnings.push('name can no longer contain special characters ("~\'!()*")')
  85.   }
  86. // 包名不能包含non-url-safe字符
  87.   // 关于encodeURIComponent不转义哪些字符
  88.   if (encodeURIComponent(name) !== name) {
  89.     // Maybe it's a scoped package name, like @user/package
  90.     var nameMatch = name.match(scopedPackagePattern)
  91.     if (nameMatch) {
  92.       var user = nameMatch[1]
  93.       var pkg = nameMatch[2]
  94.       if (encodeURIComponent(user) === user && encodeURIComponent(pkg) === pkg) {
  95.         return done(warnings, errors)
  96.       }
  97.     }
  99.     errors.push('name can only contain URL-friendly characters')
  100.   }
  102.   return done(warnings, errors)
  103. }
  105. validate.scopedPackagePattern = scopedPackagePattern
  106. // 调用公共方法，返回对应的warnings 和errors
  107. var done = function (warnings, errors) {
  108.   var result = {
  109.     // 我们一般用该属性来判断一个包名是否合法
  110.     validForNewPackages: errors.length === 0 && warnings.length === 0,
  111.     // 这个属性是用于兼容最开始node package name带来的遗留问题，那个时候有些包名不规范
  112.     validForOldPackages: errors.length === 0,
  113.     warnings: warnings,
  114.     errors: errors
  115.   }
  116.   if (!result.warnings.length) delete result.warnings
  117.   if (!result.errors.length) delete result.errors
  118.   return result
  119. }

出处：validate-npm-package-name