feat: refactor with typescript to support esm and cjs both #56
Conversation
|
Warning Rate Limit Exceeded@fengmk2 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 31 minutes and 54 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. WalkthroughThe updates encompass a broad range of improvements and modernizations, including ESLint configurations, Node.js workflow updates, enhanced TypeScript support, and dependency upgrades. Key changes involve refactoring scripts to ES modules, updating package management, and introducing new functionalities like Changes
Sequence Diagram(s) (Beta)Silently ignored as the changes are too varied for a single diagram to represent effectively. Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
|
🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎ To accept the risk, merge this PR and you will not be notified again.
Next stepsWhat is an install script?Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts. Packages should not be running non-essential scripts during install and there are often solutions to problems people solve with install scripts that can be run at publish time instead. Take a deeper look at the dependencyTake a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev. Remove the packageIf you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency. Mark a package as acceptable riskTo ignore an alert, reply with a comment starting with
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 13
Outside diff range and nitpick comments (2)
bin/detect-port.ts (1)
Line range hint
49-49: ReplaceisNaNwithNumber.isNaNfor more accurate checks that avoid type coercion.- } else if (isNaN(port)) { + } else if (Number.isNaN(port)) {src/detect-port.ts (1)
Line range hint
19-47: Refactor to avoid reassigning function parameters.Reassigning function parameters can lead to confusing bugs and harder-to-maintain code. Consider using local variables instead.
- export default function detectPort(port?: number | string | PortConfig | DetectPortCallback, callback?: DetectPortCallback) { + export default function detectPort(inputPort?: number | string | PortConfig | DetectPortCallback, inputCallback?: DetectPortCallback) { + let port = inputPort; + let callback = inputCallback;
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (13)
- .eslintrc (1 hunks)
- .github/workflows/nodejs.yml (1 hunks)
- .github/workflows/release.yml (1 hunks)
- .gitignore (1 hunks)
- bin/detect-port.ts (3 hunks)
- package.json (2 hunks)
- src/detect-port.ts (5 hunks)
- src/index.ts (1 hunks)
- src/wait-port.ts (1 hunks)
- test/cli.test.ts (1 hunks)
- test/detect-port.test.ts (1 hunks)
- test/wait-port.test.ts (1 hunks)
- tsconfig.json (1 hunks)
Files skipped from review due to trivial changes (4)
- .eslintrc
- .github/workflows/release.yml
- .gitignore
- tsconfig.json
Additional Context Used
Biome (29)
bin/detect-port.ts (2)
31-31: Use Number.parseInt instead of the equivalent global.
49-49: isNaN is unsafe. It attempts a type coercion. Use Number.isNaN instead.
src/detect-port.ts (15)
49-49: Unexpected any. Specify a different type.
64-64: Unexpected any. Specify a different type.
94-94: Unexpected any. Specify a different type.
112-112: Unexpected any. Specify a different type.
119-119: Unexpected any. Specify a different type.
24-24: Reassigning a function parameter is confusing.
28-28: Reassigning a function parameter is confusing.
32-32: Reassigning a function parameter is confusing.
23-23: Reassigning a function parameter is confusing.
27-27: Reassigning a function parameter is confusing.
32-32: Use Number.parseInt instead of the equivalent global.
51-51: Reassigning a function parameter is confusing.
54-54: Reassigning a function parameter is confusing.
55-55: Reassigning a function parameter is confusing.
128-128: Reassigning a function parameter is confusing.
src/wait-port.ts (3)
21-21: Unexpected any. Specify a different type.
22-22: Unexpected any. Specify a different type.
14-14: Use Number.Infinity instead of the equivalent global.
test/cli.test.ts (3)
51-51: Template literals are preferred over string concatenation.
45-45: Use Number.parseInt instead of the equivalent global.
52-52: Use Number.parseInt instead of the equivalent global.
test/detect-port.test.ts (4)
51-51: Prefer for...of instead of forEach.
84-84: Unexpected any. Specify a different type.
90-90: Unexpected any. Specify a different type.
103-103: Template literals are preferred over string concatenation.
test/wait-port.test.ts (2)
11-11: Prefer for...of instead of forEach.
28-28: Unexpected any. Specify a different type.
GitHub Check Runs (3)
Node.js / Test (ubuntu-latest, 22) failure (2)
bin/detect-port.ts: [failure] 8-8:
The 'import.meta' meta-property is only allowed when the '--module' option is 'es2020', 'es2022', 'esnext', 'system', 'node16', or 'nodenext'.Node.js / Test (ubuntu-latest, 20) failure (2)
bin/detect-port.ts: [failure] 8-8:
The 'import.meta' meta-property is only allowed when the '--module' option is 'es2020', 'es2022', 'esnext', 'system', 'node16', or 'nodenext'.Node.js / Test (ubuntu-latest, 18) failure (2)
bin/detect-port.ts: [failure] 8-8:
The 'import.meta' meta-property is only allowed when the '--module' option is 'es2020', 'es2022', 'esnext', 'system', 'node16', or 'nodenext'.
Additional comments not posted (5)
src/index.ts (2)
1-2: The imports are correctly updated to use ES module syntax.
4-6: The export statements are correctly updated to support both default and named exports, aligning with the PR's objectives to support ESM and CJS..github/workflows/nodejs.yml (1)
12-15: The workflow file has been updated to use the latest versions of Node.js, ensuring compatibility with the new features and dropping support for older versions as per the PR description.package.json (1)
13-13: The updates to thepackage.jsonalign with the PR's objectives, including the update of dependencies and scripts to support TypeScript and the new module structure.Also applies to: 24-39, 42-74
bin/detect-port.ts (1)
8-8: Ensure the TypeScript configuration allows the use ofimport.meta. This might require setting themoduleoption tonodenextor similar intsconfig.json.Verification successful
The TypeScript configuration in
tsconfig.jsonhas themoduleoption set tonodenext, which supports the use ofimport.meta.
Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the TypeScript configuration for module option. # Test: Search for the TypeScript configuration. Expect: Module option set to support 'import.meta'. cat tsconfig.json | jq '.compilerOptions.module'Length of output: 59
| try { | ||
| const port = 9093; | ||
| await waitPort(port, { retries: 3, retryInterval: 100 }); | ||
| } catch (err:any) { |
There was a problem hiding this comment.
Avoid using any as a type for error handling. Specify a more precise type for better type safety.
- } catch (err:any) {
+ } catch (err: Error) {Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| } catch (err:any) { | |
| } catch (err: Error) { |
| describe('wait for port', () => { | ||
| const servers: net.Server[] = []; | ||
| after(() => { | ||
| servers.forEach(server => server.close()); |
There was a problem hiding this comment.
Consider using a for...of loop for better readability and performance when iterating over arrays.
- servers.forEach(server => server.close());
+ for (const server of servers) {
+ server.close();
+ }Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| servers.forEach(server => server.close()); | |
| for (const server of servers) { | |
| server.close(); | |
| } |
| } | ||
|
|
||
| export default async function waitPort(port: number, options: WaitPortOptions = {}) { | ||
| const { retryInterval = 1000, retries = Infinity } = options; |
There was a problem hiding this comment.
Use Number.Infinity instead of the global Infinity for better clarity and consistency in TypeScript.
- const { retryInterval = 1000, retries = Infinity } = options;
+ const { retryInterval = 1000, retries = Number.Infinity } = options;Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| const { retryInterval = 1000, retries = Infinity } = options; | |
| const { retryInterval = 1000, retries = Number.Infinity } = options; |
| (err as any).retries = retries; | ||
| (err as any).count = count; |
There was a problem hiding this comment.
Avoid using any as a type. Use a more specific type or define a custom error type to enhance type safety.
- (err as any).retries = retries;
- (err as any).count = count;
+ interface RetryError extends Error {
+ retries: number;
+ count: number;
+ }
+ const err: RetryError = new Error('retries exceeded') as RetryError;
+ err.retries = retries;
+ err.count = count;Committable suggestion was skipped due low confidence.
bin/detect-port.ts
Outdated
| @@ -21,18 +28,15 @@ | |||
| } | |||
| }; | |||
|
|
|||
| const main = require('..'); | |||
|
|
|||
| const port = parseInt(arg_0, 10); | |||
There was a problem hiding this comment.
Use Number.parseInt instead of the global parseInt for better clarity and consistency in TypeScript.
- const port = parseInt(arg_0, 10);
+ const port = Number.parseInt(arg_0, 10);Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| const port = parseInt(arg_0, 10); | |
| const port = Number.parseInt(arg_0, 10); |
| } | ||
| } | ||
|
|
||
| port = parseInt(port) || 0; | ||
| port = parseInt(port as unknown as string) || 0; |
There was a problem hiding this comment.
Use Number.parseInt for parsing integers.
- port = parseInt(port as unknown as string) || 0;
+ port = Number.parseInt(port as unknown as string) || 0;Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| port = parseInt(port as unknown as string) || 0; | |
| port = Number.parseInt(port as unknown as string) || 0; |
| @@ -50,7 +61,7 @@ | |||
| if (hostname) { | |||
| listen(port, hostname, (err, realPort) => { | |||
| if (err) { | |||
| if (err.code === 'EADDRNOTAVAIL') { | |||
| if ((err as any).code === 'EADDRNOTAVAIL') { | |||
There was a problem hiding this comment.
Specify a more precise type than any.
Using any defeats the purpose of TypeScript's static typing. It's better to define a more specific type or use TypeScript's utility types if the exact shape is not known.
- if ((err as any).code === 'EADDRNOTAVAIL') {
+ if ((err as NodeJS.ErrnoException).code === 'EADDRNOTAVAIL') {Also applies to: 94-94, 119-119
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| if ((err as any).code === 'EADDRNOTAVAIL') { | |
| if ((err as NodeJS.ErrnoException).code === 'EADDRNOTAVAIL') { |
| t.mock.reset(); | ||
| }); | ||
|
|
||
| it('work with listening next port 4001 because 4000 was listened to ' + ip(), async () => { |
There was a problem hiding this comment.
Use template literals for string operations.
- it('work with listening next port 4001 because 4000 was listened to ' + ip(), async () => {
+ it(`work with listening next port 4001 because 4000 was listened to ${ip()}`, async () => {Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| it('work with listening next port 4001 because 4000 was listened to ' + ip(), async () => { | |
| it(`work with listening next port 4001 because 4000 was listened to ${ip()}`, async () => { |
| } | ||
| }); | ||
| after(() => { | ||
| servers.forEach(server => server.close()); |
There was a problem hiding this comment.
Use modern JavaScript loops for better readability.
- servers.forEach(server => server.close());
+ for (const server of servers) {
+ server.close();
+ }Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| servers.forEach(server => server.close()); | |
| for (const server of servers) { | |
| server.close(); | |
| } |
| }); | ||
|
|
||
| it('should listen next port 4001 when localhost is not binding', async t => { | ||
| t.mock.method(dns, 'lookup', (address: string, callback: (...args: any[]) => void) => { |
There was a problem hiding this comment.
Specify a more precise type than any.
Using any defeats the purpose of TypeScript's static typing. It's better to define a more specific type or use TypeScript's utility types if the exact shape is not known.
- t.mock.method(dns, 'lookup', (address: string, callback: (...args: any[]) => void) => {
+ t.mock.method(dns, 'lookup', (address: string, callback: (err: NodeJS.ErrnoException | null, address: string[]) => void) => {Also applies to: 90-90
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| t.mock.method(dns, 'lookup', (address: string, callback: (...args: any[]) => void) => { | |
| t.mock.method(dns, 'lookup', (address: string, callback: (err: NodeJS.ErrnoException | null, address: string[]) => void) => { |
BREAKING CHANGE: Drop Node.js < 16 support
merge from #51
Summary by CodeRabbit
New Features
waitPortfunction to wait for a specified port to become available.Bug Fixes
detectPortfunction to handle different parameter combinations and enhance error handling.Documentation
.gitignoreto include new patterns and files.Chores
package.jsondependencies and scripts for better development workflow.Refactor
requireto ES module imports for better compliance with modern JavaScript standards.