Check if a namespace on npm is being hogged
MPL-2.0 License
Check if a namespace on npm is being hogged.
npm install squatter --save
Get it into your program.
const squatter = require('squatter');
Check whether a given package name is being squatted.
squatter('foo').then((isSquatted) => {
console.log(isSquatted); // true
});
squatter('build-path').then((isSquatted) => {
console.log(isSquatted); // false
});
A heuristic is used to determine if a package is a squatter.
A squatter is a package that is not either exempt, useful, or high quality.
Packages are guilty until proven innocent.
A package is exempt (aka not a squatter) if it has at least one of:
A package is useful (aka not a squatter) if it has all of:
A package is high quality (aka not a squatter) if it has at least 80% of:
Returns a Promise
for a boolean
of whether the name is being hogged on npm, as determined by the algorithm.
Type: string
Example: build-path
Any valid npm package name.
See squatter-cli to use this on the command line.
See our contributing guidelines for more details.
git checkout -b my-new-feature
git commit -am 'Add some feature'
git push origin my-new-feature
Go make something, dang it.