-
Notifications
You must be signed in to change notification settings - Fork 233
Generate tests in dtslint with Vanilla #1284
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.
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
Draft
JanKrivanek
wants to merge
1
commit into
microsoft:main
Choose a base branch
from
JanKrivanek:dev/jankrivanek/testgen-dtslint-vanilla
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| import { deepEquals } from "@definitelytyped/utils"; | ||
| import fs from "fs"; | ||
| import { basename, dirname, join as joinPaths } from "path"; | ||
|
|
||
| /** @internal */ | ||
| export function findDTRoot(dirPath: string) { | ||
| let path = dirPath; | ||
| while (basename(path) !== "types" && dirname(path) !== "." && dirname(path) !== "/" && dirname(path) !== path) { | ||
| path = dirname(path); | ||
| } | ||
| return dirname(path); | ||
| } | ||
|
|
||
| /** @internal */ | ||
| export function assertPathIsInDefinitelyTyped(dirPath: string, dtRoot: string): void { | ||
| // TODO: It's not clear whether this assertion makes sense, and it's broken on Azure Pipelines (perhaps because DT isn't cloned into DefinitelyTyped) | ||
| // Re-enable it later if it makes sense. | ||
| // if (basename(dtRoot) !== "DefinitelyTyped")) { | ||
| if (!fs.existsSync(joinPaths(dtRoot, "types"))) { | ||
| throw new Error( | ||
| "Since this type definition includes a header (a comment starting with `// Type definitions for`), " + | ||
| "assumed this was a DefinitelyTyped package.\n" + | ||
| "But it is not in a `DefinitelyTyped/types/xxx` directory: " + | ||
| dirPath, | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Starting at some point in time, npm has banned all new packages whose names | ||
| * contain the word `download`. However, some older packages exist that still | ||
| * contain this name. | ||
| * @NOTE for contributors: The list of literal exceptions below should ONLY be | ||
| * extended with packages for which there already exists a corresponding type | ||
| * definition package in the `@types` scope. More information: | ||
| * https://github.com/microsoft/DefinitelyTyped-tools/pull/381. | ||
| * @internal | ||
| */ | ||
| export function assertPathIsNotBanned(packageName: string) { | ||
| if ( | ||
| /(^|\W)download($|\W)/.test(packageName) && | ||
| packageName !== "download" && | ||
| packageName !== "downloadjs" && | ||
| packageName !== "s3-download-stream" | ||
| ) { | ||
| // Since npm won't release their banned-words list, we'll have to manually add to this list. | ||
| throw new Error(`${packageName}: Contains the word 'download', which is banned by npm.`); | ||
| } | ||
| } | ||
|
|
||
| /** @internal */ | ||
| export function combineErrorsAndWarnings(errors: string[], warnings: string[]): Error | string { | ||
| const message = errors.concat(warnings).join("\n\n"); | ||
| return errors.length ? new Error(message) : message; | ||
| } | ||
|
|
||
| /** @internal */ | ||
| export function checkExpectedFiles(dirPath: string, isLatest: boolean): { errors: string[] } { | ||
| const errors = []; | ||
|
|
||
| if (isLatest) { | ||
| const expectedNpmIgnore = ["*", "!**/*.d.ts", "!**/*.d.cts", "!**/*.d.mts", "!**/*.d.*.ts"]; | ||
|
|
||
| if (basename(dirname(dirPath)) === "types") { | ||
| for (const subdir of fs.readdirSync(dirPath, { withFileTypes: true })) { | ||
| if (subdir.isDirectory() && /^v(\d+)(\.(\d+))?$/.test(subdir.name)) { | ||
| expectedNpmIgnore.push(`/${subdir.name}/`); | ||
| } | ||
| } | ||
| } else { | ||
| const thisDir = `/${basename(dirPath)}/`; | ||
| const parentNpmIgnorePath = joinPaths(dirname(dirPath), ".npmignore"); | ||
| if (!fs.existsSync(parentNpmIgnorePath)) { | ||
| errors.push(`${dirPath}: Missing parent '.npmignore'`); | ||
| } else { | ||
| const parentNpmIgnore = tryReadFileSync(parentNpmIgnorePath)?.trim().split(/\r?\n/); | ||
| if (!parentNpmIgnore || !parentNpmIgnore.includes(thisDir)) { | ||
| errors.push(`${dirPath}: Parent package '.npmignore' should contain ${thisDir}`); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| const expectedNpmIgnoreAsString = expectedNpmIgnore.join("\n"); | ||
| const npmIgnorePath = joinPaths(dirPath, ".npmignore"); | ||
| if (!fs.existsSync(npmIgnorePath)) { | ||
| errors.push(`${dirPath}: Missing '.npmignore'; should contain:\n${expectedNpmIgnoreAsString}`); | ||
| } | ||
|
|
||
| const actualNpmIgnore = tryReadFileSync(npmIgnorePath)?.trim().split(/\r?\n/); | ||
| if (!actualNpmIgnore || !deepEquals(actualNpmIgnore, expectedNpmIgnore)) { | ||
| errors.push(`${dirPath}: Incorrect '.npmignore'; should be:\n${expectedNpmIgnoreAsString}`); | ||
| } | ||
|
|
||
| if (fs.existsSync(joinPaths(dirPath, "OTHER_FILES.txt"))) { | ||
| errors.push( | ||
| `${dirPath}: Should not contain 'OTHER_FILES.txt'. All files matching "**/*.d.{ts,cts,mts,*.ts}" are automatically included.`, | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| if (!fs.existsSync(joinPaths(dirPath, "index.d.ts"))) { | ||
| errors.push(`${dirPath}: Must contain 'index.d.ts'.`); | ||
| } | ||
|
|
||
| if (fs.existsSync(joinPaths(dirPath, "tslint.json"))) { | ||
| errors.push( | ||
| `${dirPath}: Should not contain 'tslint.json'. This file is no longer required; place all lint-related options into .eslintrc.json.`, | ||
| ); | ||
| } | ||
|
|
||
| return { errors }; | ||
| } | ||
|
|
||
| function tryReadFileSync(path: string): string | undefined { | ||
| try { | ||
| return fs.readFileSync(path, "utf-8"); | ||
| } catch { | ||
| return undefined; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@internaldoesn't actually mean anything in Typescript. It's a tag used by the typescript team to build the typescript compiler but nowhere else. It doesn't mean anything more than "please don't use this" here, which I guess is O.K., but still a little misleading.