Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

package-name-conflict

bconnorwhite80.6kMIT1.0.3TypeScript support: included

Check if NPM package names conflict

npm, package, name, names, conflict, conflicts, check, if, any, transform, typescript, typed, ts

readme

package-name-conflict

npm typescript Coverage Status GitHub stars Twitter Follow

Check if NPM package names conflict.

To prevent typosquatting, NPM no longer allows names that differ from existing packages in punctuation only.

This package checks if package names conflict.

Note:
Package names are not validated. To validate package names, use validate-package-name.

Installation

yarn add package-name-conflict
npm install package-name-conflict

API

import { conflicts, conflictsAny, transform } from "package-name-conflict";

// Check if two package names conflict:

conflicts("abc.123", "Abc-123"); // true

// Return first conflicting package name in an array:

conflictsAny("abc123", ["test", "test2", "Abc-123"]); // "Abc-123"

conflictsAny("abc123", ["test", "test2"]); // false

// Transform a package name to its simplified form:

transform("Abc-123"); // "abc123"

Types:

function transform(name: string): string;

function conflicts(nameA: string, nameB: string): boolean;

function conflictsAny(name: string, names: string[]): string | false;

#


Dev DependenciesDavid

#


License license

MIT

#


changelog

1.0.3 (2021-04-07)

1.0.2 (2021-04-07)

Bug Fixes

  • bump build dependency, update README (a683457)

1.0.1 (2020-09-02)