Skip to content

feat: mention "nonNpm": "conflict" in readme and error message #1119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

feat: mention "nonNpm": "conflict" in readme and error message #1119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
40d1e22
Update README.md
fowl2 Dec 9, 2024
c02c985
Update checks.ts (#1)
fowl2 Dec 9, 2024
41a6e83
Update checks.ts
fowl2 Dec 9, 2024
a4e6270
Update packages/dtslint/README.md
fowl2 Dec 10, 2024
8d0e926
Update checks.ts
fowl2 Dec 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/dtslint/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Also:

For types that do not have a matching NPM package, add two properties:

1. `"nonNpm": true`
1. `"nonNpm": true`, or `"nonNpm": "conflict"` if there is an npm package but it is unrelated.
2. `"nonNpmDescription"`, a human-readable name for the project that is being typed.

#### `types/.eslintrc.json`
Expand Down
10 changes: 7 additions & 3 deletions packages/dtslint/src/checks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,10 @@ export async function checkNpmVersionAndGetMatchingImplementationPackage(
errors.push(
`Package ${packageJson.name} is marked as non-npm, but ${packageName} exists on npm. ` +
`If these types are being added to DefinitelyTyped for the first time, please choose ` +
`a different name that does not conflict with an existing npm package.`,
`a different name that does not conflict with an existing npm package. If this is an ` +
`existing conflict, mark these types as \`"nonNpm": "conflict"\`. See `+
`https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.md#naming for ` +
`for more information.,
);
} else if (!packageJson.nonNpm) {
if (!satisfies(packageVersion, typesPackageVersion)) {
Expand All @@ -279,7 +282,8 @@ export async function checkNpmVersionAndGetMatchingImplementationPackage(
`If these types are for the existing npm package ${packageName}, change the ${packageDirectoryNameWithVersion}/package.json ` +
`major and minor version to match an existing version of the npm package. If these types are unrelated to ` +
`the npm package ${packageName}, add \`"nonNpm": true\` to the package.json and choose a different name ` +
`that does not conflict with an existing npm package.`,
`that does not conflict with an existing npm package. See https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.md#naming ` +
`for more information.`,
);
} else {
try {
Expand All @@ -295,7 +299,7 @@ export async function checkNpmVersionAndGetMatchingImplementationPackage(
} else if (packageJson.nonNpm === "conflict") {
errors.push(
`Package ${packageJson.name} is marked as \`"nonNpm": "conflict"\`, but no conflicting package name was ` +
`found on npm. These non-npm types can be makred as \`"nonNpm": true\` instead.`,
`found on npm. These non-npm types can be marked as \`"nonNpm": true\` instead.`,
);
} else if (!packageJson.nonNpm) {
errors.push(
Expand Down
Loading