/deps/npm/node_modules/init-package-json/node_modules/validate-npm-package-name/index.js

https://gitlab.com/MichelZuniga/node · JavaScript · 101 lines · 74 code · 21 blank · 6 comment · 18 complexity · a12ef3c7eb084938e0e35f362c304e45 MD5 · raw file

  1. var scopedPackagePattern = new RegExp("^(?:@([^/]+?)[/])?([^/]+?)$");
  2. var builtins = require("builtins")
  3. var blacklist = [
  4. "node_modules",
  5. "favicon.ico"
  6. ];
  7. var validate = module.exports = function(name) {
  8. var warnings = []
  9. var errors = []
  10. if (name === null) {
  11. errors.push("name cannot be null")
  12. return done(warnings, errors)
  13. }
  14. if (name === undefined) {
  15. errors.push("name cannot be undefined")
  16. return done(warnings, errors)
  17. }
  18. if (typeof name !== "string") {
  19. errors.push("name must be a string")
  20. return done(warnings, errors)
  21. }
  22. if (!name.length) {
  23. errors.push("name length must be greater than zero")
  24. }
  25. if (name.match(/^\./)) {
  26. errors.push("name cannot start with a period")
  27. }
  28. if (name.match(/^_/)) {
  29. errors.push("name cannot start with an underscore")
  30. }
  31. if (name.trim() !== name) {
  32. errors.push("name cannot contain leading or trailing spaces")
  33. }
  34. // No funny business
  35. blacklist.forEach(function(blacklistedName){
  36. if (name.toLowerCase() === blacklistedName) {
  37. errors.push(blacklistedName + " is a blacklisted name")
  38. }
  39. })
  40. // Generate warnings for stuff that used to be allowed
  41. // core module names like http, events, util, etc
  42. builtins.forEach(function(builtin){
  43. if (name.toLowerCase() === builtin) {
  44. warnings.push(builtin + " is a core module name")
  45. }
  46. })
  47. // really-long-package-names-------------------------------such--length-----many---wow
  48. if (name.length > 50) {
  49. warnings.push("name can no longer contain more than 50 characters")
  50. }
  51. // mIxeD CaSe nAMEs
  52. if (name.toLowerCase() !== name) {
  53. warnings.push("name can no longer contain capital letters")
  54. }
  55. if (encodeURIComponent(name) !== name) {
  56. // Maybe it's a scoped package name, like @user/package
  57. var nameMatch = name.match(scopedPackagePattern)
  58. if (nameMatch) {
  59. var user = nameMatch[1]
  60. var pkg = nameMatch[2]
  61. if (encodeURIComponent(user) === user && encodeURIComponent(pkg) === pkg) {
  62. return done(warnings, errors)
  63. }
  64. }
  65. errors.push("name can only contain URL-friendly characters")
  66. }
  67. return done(warnings, errors)
  68. }
  69. validate.scopedPackagePattern = scopedPackagePattern
  70. var done = function (warnings, errors) {
  71. var result = {
  72. validForNewPackages: errors.length === 0 && warnings.length === 0,
  73. validForOldPackages: errors.length === 0,
  74. warnings: warnings,
  75. errors: errors
  76. }
  77. if (!result.warnings.length) delete result.warnings
  78. if (!result.errors.length) delete result.errors
  79. return result
  80. }