-
-
Notifications
You must be signed in to change notification settings - Fork 966
feat(oxfmt): add node version hint for ts config import failures #21046
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
Merged
+98
−1
Merged
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
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,49 @@ | ||
| import { extname as pathExtname } from "node:path"; | ||
| import { fileURLToPath } from "node:url"; | ||
|
|
||
| export const NODE_TYPESCRIPT_SUPPORT_RANGE = "^20.19.0 || >=22.12.0"; | ||
|
|
||
| const TS_MODULE_EXTENSIONS = new Set([".ts", ".mts", ".cts"]); | ||
leaysgur marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| function normalizeModuleSpecifierPath(specifier: string): string { | ||
| if (!specifier.startsWith("file:")) return specifier; | ||
|
|
||
| try { | ||
| return fileURLToPath(specifier); | ||
| } catch { | ||
| return specifier; | ||
| } | ||
| } | ||
|
|
||
| export function isTypeScriptModuleSpecifier(specifier: string): boolean { | ||
| const ext = pathExtname(normalizeModuleSpecifierPath(specifier)).toLowerCase(); | ||
| return TS_MODULE_EXTENSIONS.has(ext); | ||
| } | ||
|
|
||
| function isUnknownFileExtensionError(err: unknown): boolean { | ||
| if ((err as { code?: unknown })?.code === "ERR_UNKNOWN_FILE_EXTENSION") return true; | ||
|
|
||
| const message = (err as { message?: unknown })?.message; | ||
| return typeof message === "string" && /unknown(?: or unsupported)? file extension/i.test(message); | ||
| } | ||
|
|
||
| function getErrorSummary(err: unknown): string { | ||
| if (err instanceof Error) return String(err); | ||
|
|
||
| const message = (err as { message?: unknown })?.message; | ||
| if (typeof message === "string" && message !== "") return message; | ||
|
|
||
| return "Unknown error"; | ||
| } | ||
|
|
||
| export function getUnsupportedTypeScriptModuleLoadHintForError( | ||
| err: unknown, | ||
| specifier: string, | ||
| nodeVersion: string = process.version, | ||
| ): string | null { | ||
| if (!isTypeScriptModuleSpecifier(specifier) || !isUnknownFileExtensionError(err)) { | ||
| return null; | ||
| } | ||
|
|
||
| return `${getErrorSummary(err)}\n\nTypeScript config files require Node.js ${NODE_TYPESCRIPT_SUPPORT_RANGE}.\nDetected Node.js ${nodeVersion}.\nPlease upgrade Node.js or use a JSON config file instead.`; | ||
| } | ||
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,41 @@ | ||
| import { describe, expect, it } from "vitest"; | ||
| import { | ||
| NODE_TYPESCRIPT_SUPPORT_RANGE, | ||
| getUnsupportedTypeScriptModuleLoadHintForError, | ||
| isTypeScriptModuleSpecifier, | ||
| } from "../../../src-js/cli/node_version"; | ||
|
|
||
| describe("node_version", () => { | ||
| it("detects supported TypeScript config specifiers", () => { | ||
| expect(isTypeScriptModuleSpecifier("/tmp/oxfmt.config.ts")).toBe(true); | ||
| expect(isTypeScriptModuleSpecifier("/tmp/oxfmt.config.mts")).toBe(true); | ||
| expect(isTypeScriptModuleSpecifier("/tmp/oxfmt.config.cts")).toBe(true); | ||
| expect(isTypeScriptModuleSpecifier("file:///tmp/oxfmt.config.ts")).toBe(true); | ||
| expect(isTypeScriptModuleSpecifier("/tmp/oxfmt.config.js")).toBe(false); | ||
| }); | ||
|
|
||
| it("adds a node version hint for unsupported TypeScript module loading", () => { | ||
| const err = new TypeError( | ||
| 'Unknown file extension ".ts" for /tmp/oxfmt.config.ts', | ||
| ) as TypeError & { | ||
| code?: string; | ||
| }; | ||
| err.code = "ERR_UNKNOWN_FILE_EXTENSION"; | ||
|
|
||
| expect( | ||
| getUnsupportedTypeScriptModuleLoadHintForError(err, "/tmp/oxfmt.config.ts", "v22.11.0"), | ||
| ).toBe( | ||
| `TypeError: Unknown file extension ".ts" for /tmp/oxfmt.config.ts\n\nTypeScript config files require Node.js ${NODE_TYPESCRIPT_SUPPORT_RANGE}.\nDetected Node.js v22.11.0.\nPlease upgrade Node.js or use a JSON config file instead.`, | ||
| ); | ||
| }); | ||
|
|
||
| it("does not add the hint for non-TypeScript specifiers or unrelated errors", () => { | ||
| const err = new Error("Cannot find package"); | ||
| expect(getUnsupportedTypeScriptModuleLoadHintForError(err, "/tmp/oxfmt.config.ts")).toBeNull(); | ||
|
|
||
| const unknownExtension = new TypeError('Unknown file extension ".ts"'); | ||
| expect( | ||
| getUnsupportedTypeScriptModuleLoadHintForError(unknownExtension, "/tmp/oxfmt.config.js"), | ||
| ).toBeNull(); | ||
| }); | ||
| }); |
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.
Uh oh!
There was an error while loading. Please reload this page.