validate-npm-package-name源码阅读

1.简介

validate-npm-package-name,看名字就可以猜到,是一个检测包名的工具包,其中源码很简单,主要是正则的运用,以及代码中怎么把错误,以什么样的方式抛出的.

2.使用

//直接引入后将名字放入校验
var validate = require("validate-npm-package-name")

validate("some-package")
validate("example.com")
validate("under_score")
validate("123numeric")
validate("@npm/thingy")
validate("@jane/foo.js")


//包名正确没有问题后,就会返回这个对象,其中都为true,就没问题
{
  validForNewPackages: true,
  validForOldPackages: true
}


//当放入错误的包名时,会将具体的error信息同样返回
validate("excited!")
validate(" leading-space:and:weirdchars")

{
  validForNewPackages: false,
  validForOldPackages: false,
  errors: [
    'name cannot contain leading or trailing spaces',
    'name can only contain URL-friendly characters'
  ]
}

github地址为 github.com/npm/validat…

因为代码非常短,建议直接加1s查看即可 github1s.com/npm/validat…

3.源码

'use strict'

var scopedPackagePattern = new RegExp('^(?:@([^/]+?)[/])?([^/]+?)$')
// builtins为所有ndoe中的核心模块名字
var builtins = require('builtins')
var blacklist = [  'node_modules',  'favicon.ico']

var validate = module.exports = function (name) {
  var warnings = []
  var errors = []
	
  // 传入名字不能为 null
  if (name === null) {
    errors.push('name cannot be null')
    return done(warnings, errors)
  }

  //传入名字不能为 undefiined
  if (name === undefined) {
    errors.push('name cannot be undefined')
    return done(warnings, errors)
  }

  // 包名必须是 string 类型
  if (typeof name !== 'string') {
    errors.push('name must be a string')
    return done(warnings, errors)
  }

  //不能传入 '' 空字符串
  if (!name.length) {
    errors.push('name length must be greater than zero')
  }

  //不能以 '.' 开头
  if (name.match(/^./)) {
    errors.push('name cannot start with a period')
  }

  //不能以 '_' 开头
  if (name.match(/^_/)) {
    errors.push('name cannot start with an underscore')
  }

  //字符串前后不包含空格
  if (name.trim() !== name) {
    errors.push('name cannot contain leading or trailing spaces')
  }
	
  //不能使用 node_modules  favicon.ico
  // No funny business
  blacklist.forEach(function (blacklistedName) {
    if (name.toLowerCase() === blacklistedName) {
      errors.push(blacklistedName + ' is a blacklisted name')
    }
  })

  
  //不能以node中已存在的包来命名
  // Generate warnings for stuff that used to be allowed

  // core module names like http, events, util, etc
  builtins.forEach(function (builtin) {
    if (name.toLowerCase() === builtin) {
      warnings.push(builtin + ' is a core module name')
    }
  })

  // really-long-package-names-------------------------------such--length-----many---wow
  // the thisisareallyreallylongpackagenameitshouldpublishdowenowhavealimittothelengthofpackagenames-poch.
  //长度不能超过214个字符
  if (name.length > 214) {
    warnings.push('name can no longer contain more than 214 characters')
  }

  //不能包含大写字母
  // mIxeD CaSe nAMEs
  if (name.toLowerCase() !== name) {
    warnings.push('name can no longer contain capital letters')
  }

  
  //不能包含  ~ ! * 字符
  if (/[~'!()*]/.test(name.split('/').slice(-1)[0])) {
    warnings.push('name can no longer contain special characters ("~'!()*")')
  }

  
  //不能使用encodeURIComponent编码后的存在特殊字符,如汉字
  if (encodeURIComponent(name) !== name) {
    // Maybe it's a scoped package name, like @user/package
    var nameMatch = name.match(scopedPackagePattern)
    //存在http://等
    if (nameMatch) {
      var user = nameMatch[1]
      var pkg = nameMatch[2]
      if (encodeURIComponent(user) === user && encodeURIComponent(pkg) === pkg) {
        return done(warnings, errors)
      }
    }

    errors.push('name can only contain URL-friendly characters')
  }

  return done(warnings, errors)
}

validate.scopedPackagePattern = scopedPackagePattern


//在这里汇总问题,判断问题的数量,如果有则抛出errors,没有的话就删除errors,warnings
var done = function (warnings, errors) {
  var result = {
    validForNewPackages: errors.length === 0 && warnings.length === 0,
    validForOldPackages: errors.length === 0,
    warnings: warnings,
    errors: errors
  }
  if (!result.warnings.length) delete result.warnings
  if (!result.errors.length) delete result.errors
  return result
}

原文地址:www.yuque.com/docs/share/… 《validate-npm-package-name源码阅读》