Skip to content

Commit

Permalink
fix: standard-ize
Browse files Browse the repository at this point in the history
  • Loading branch information
@chrisdickinson
chrisdickinson committed Feb 13, 2017
1 parent 48f145f commit 0995a97
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 68 deletions.
47 changes: 23 additions & 24 deletions index.js
View file
Original file line number Diff line number Diff line change
@@ -1,79 +1,79 @@
var scopedPackagePattern = new RegExp("^(?:@([^/]+?)[/])?([^/]+?)$");
var builtins = require("builtins")
var blacklist = [
"node_modules",
"favicon.ico"
];
'use strict'

var validate = module.exports = function(name) {
var scopedPackagePattern = new RegExp('^(?:@([^/]+?)[/])?([^/]+?)$')
var builtins = require('builtins')
var blacklist = [
'node_modules',
'favicon.ico'
]

var validate = module.exports = function (name) {
var warnings = []
var errors = []

if (name === null) {
errors.push("name cannot be null")
errors.push('name cannot be null')
return done(warnings, errors)
}

if (name === undefined) {
errors.push("name cannot be undefined")
errors.push('name cannot be undefined')
return done(warnings, errors)
}

if (typeof name !== "string") {
errors.push("name must be a 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")
errors.push('name length must be greater than zero')
}

if (name.match(/^\./)) {
errors.push("name cannot start with a period")
errors.push('name cannot start with a period')
}

if (name.match(/^_/)) {
errors.push("name cannot start with an underscore")
errors.push('name cannot start with an underscore')
}

if (name.trim() !== name) {
errors.push("name cannot contain leading or trailing spaces")
errors.push('name cannot contain leading or trailing spaces')
}

// No funny business
blacklist.forEach(function(blacklistedName){
blacklist.forEach(function (blacklistedName) {
if (name.toLowerCase() === blacklistedName) {
errors.push(blacklistedName + " is a blacklisted name")
errors.push(blacklistedName + ' is a blacklisted name')
}
})

// Generate warnings for stuff that used to be allowed

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

// really-long-package-names-------------------------------such--length-----many---wow
// the thisisareallyreallylongpackagenameitshouldpublishdowenowhavealimittothelengthofpackagenames-poch.
if (name.length > 214) {
warnings.push("name can no longer contain more than 214 characters")
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")
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 ("~\'!()*")')
}

if (encodeURIComponent(name) !== name) {

// Maybe it's a scoped package name, like @user/package
var nameMatch = name.match(scopedPackagePattern)
if (nameMatch) {
Expand All @@ -84,11 +84,10 @@ var validate = module.exports = function(name) {
}
}

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

return done(warnings, errors)

}

validate.scopedPackagePattern = scopedPackagePattern
Expand Down
91 changes: 47 additions & 44 deletions test/index.js
View file
Original file line number Diff line number Diff line change
@@ -1,106 +1,109 @@
var validate = require("..")
var test = require("tap").test
var path = require("path")
var fs = require("fs")
'use strict'

test("validate-npm-package-name", function (t) {
var validate = require('..')
var test = require('tap').test

test('validate-npm-package-name', function (t) {
// Traditional

t.deepEqual(validate("some-package"), {validForNewPackages: true, validForOldPackages: true})
t.deepEqual(validate("example.com"), {validForNewPackages: true, validForOldPackages: true})
t.deepEqual(validate("under_score"), {validForNewPackages: true, validForOldPackages: true})
t.deepEqual(validate("period.js"), {validForNewPackages: true, validForOldPackages: true})
t.deepEqual(validate("123numeric"), {validForNewPackages: true, validForOldPackages: true})
t.deepEqual(validate("crazy!"), {validForNewPackages: false, validForOldPackages: true, warnings: [
'name can no longer contain special characters ("~\'!()*")'
]})
t.deepEqual(validate('some-package'), {validForNewPackages: true, validForOldPackages: true})
t.deepEqual(validate('example.com'), {validForNewPackages: true, validForOldPackages: true})
t.deepEqual(validate('under_score'), {validForNewPackages: true, validForOldPackages: true})
t.deepEqual(validate('period.js'), {validForNewPackages: true, validForOldPackages: true})
t.deepEqual(validate('123numeric'), {validForNewPackages: true, validForOldPackages: true})
t.deepEqual(validate('crazy!'), {
validForNewPackages: false,
validForOldPackages: true,
warnings: ['name can no longer contain special characters ("~\'!()*")']
})

// Scoped (npm 2+)

t.deepEqual(validate("@npm/thingy"), {validForNewPackages: true, validForOldPackages: true})
t.deepEqual(validate("@npm-zors/money!time.js"), {validForNewPackages: false, validForOldPackages: true, warnings: [
'name can no longer contain special characters ("~\'!()*")'
]})
t.deepEqual(validate('@npm/thingy'), {validForNewPackages: true, validForOldPackages: true})
t.deepEqual(validate('@npm-zors/money!time.js'), {
validForNewPackages: false,
validForOldPackages: true,
warnings: ['name can no longer contain special characters ("~\'!()*")']
})

// Invalid

t.deepEqual(validate(""), {
t.deepEqual(validate(''), {
validForNewPackages: false,
validForOldPackages: false,
errors: ["name length must be greater than zero"]})
errors: ['name length must be greater than zero']})

t.deepEqual(validate(""), {
t.deepEqual(validate(''), {
validForNewPackages: false,
validForOldPackages: false,
errors: ["name length must be greater than zero"]})
errors: ['name length must be greater than zero']})

t.deepEqual(validate(".start-with-period"), {
t.deepEqual(validate('.start-with-period'), {
validForNewPackages: false,
validForOldPackages: false,
errors: ["name cannot start with a period"]})
errors: ['name cannot start with a period']})

t.deepEqual(validate("_start-with-underscore"), {
t.deepEqual(validate('_start-with-underscore'), {
validForNewPackages: false,
validForOldPackages: false,
errors: ["name cannot start with an underscore"]})
errors: ['name cannot start with an underscore']})

t.deepEqual(validate("contain:colons"), {
t.deepEqual(validate('contain:colons'), {
validForNewPackages: false,
validForOldPackages: false,
errors: ["name can only contain URL-friendly characters"]})
errors: ['name can only contain URL-friendly characters']})

t.deepEqual(validate(" leading-space"), {
t.deepEqual(validate(' leading-space'), {
validForNewPackages: false,
validForOldPackages: false,
errors: ["name cannot contain leading or trailing spaces", "name can only contain URL-friendly characters"]})
errors: ['name cannot contain leading or trailing spaces', 'name can only contain URL-friendly characters']})

t.deepEqual(validate("trailing-space "), {
t.deepEqual(validate('trailing-space '), {
validForNewPackages: false,
validForOldPackages: false,
errors: ["name cannot contain leading or trailing spaces", "name can only contain URL-friendly characters"]})
errors: ['name cannot contain leading or trailing spaces', 'name can only contain URL-friendly characters']})

t.deepEqual(validate("s/l/a/s/h/e/s"), {
t.deepEqual(validate('s/l/a/s/h/e/s'), {
validForNewPackages: false,
validForOldPackages: false,
errors: ["name can only contain URL-friendly characters"]})
errors: ['name can only contain URL-friendly characters']})

t.deepEqual(validate("node_modules"), {
t.deepEqual(validate('node_modules'), {
validForNewPackages: false,
validForOldPackages: false,
errors: ["node_modules is a blacklisted name"]})
errors: ['node_modules is a blacklisted name']})

t.deepEqual(validate("favicon.ico"), {
t.deepEqual(validate('favicon.ico'), {
validForNewPackages: false,
validForOldPackages: false,
errors: ["favicon.ico is a blacklisted name"]})
errors: ['favicon.ico is a blacklisted name']})

// Node/IO Core

t.deepEqual(validate("http"), {
t.deepEqual(validate('http'), {
validForNewPackages: false,
validForOldPackages: true,
warnings: ["http is a core module name"]})
warnings: ['http is a core module name']})

// Long Package Names

t.deepEqual(validate("ifyouwanttogetthesumoftwonumberswherethosetwonumbersarechosenbyfindingthelargestoftwooutofthreenumbersandsquaringthemwhichismultiplyingthembyitselfthenyoushouldinputthreenumbersintothisfunctionanditwilldothatforyou-"), {
t.deepEqual(validate('ifyouwanttogetthesumoftwonumberswherethosetwonumbersarechosenbyfindingthelargestoftwooutofthreenumbersandsquaringthemwhichismultiplyingthembyitselfthenyoushouldinputthreenumbersintothisfunctionanditwilldothatforyou-'), {
validForNewPackages: false,
validForOldPackages: true,
warnings: ["name can no longer contain more than 214 characters"]
warnings: ['name can no longer contain more than 214 characters']
})

t.deepEqual(validate("ifyouwanttogetthesumoftwonumberswherethosetwonumbersarechosenbyfindingthelargestoftwooutofthreenumbersandsquaringthemwhichismultiplyingthembyitselfthenyoushouldinputthreenumbersintothisfunctionanditwilldothatforyou"), {
t.deepEqual(validate('ifyouwanttogetthesumoftwonumberswherethosetwonumbersarechosenbyfindingthelargestoftwooutofthreenumbersandsquaringthemwhichismultiplyingthembyitselfthenyoushouldinputthreenumbersintothisfunctionanditwilldothatforyou'), {
validForNewPackages: true,
validForOldPackages: true
})

// Legacy Mixed-Case

t.deepEqual(validate("CAPITAL-LETTERS"), {
t.deepEqual(validate('CAPITAL-LETTERS'), {
validForNewPackages: false,
validForOldPackages: true,
warnings: ["name can no longer contain capital letters"]})
warnings: ['name can no longer contain capital letters']})

t.end()
})

0 comments on commit 0995a97

Please sign in to comment.