Skip to content

refactor: update fs/promises imports to use node: prefix#2006

Closed
divyarathodgit wants to merge 1 commit intoasyncapi:masterfrom
divyarathodgit:fix/node-imports-fs
Closed

refactor: update fs/promises imports to use node: prefix#2006
divyarathodgit wants to merge 1 commit intoasyncapi:masterfrom
divyarathodgit:fix/node-imports-fs

Conversation

@divyarathodgit
Copy link

@divyarathodgit divyarathodgit commented Feb 16, 2026

This PR standardizes the usage of the Node core modules by adding the node: prefix to fs/promises imports across the codebase.

The Problem:
Older imports like require('fs/promises') trigger warnings in SonarCloud and can cause resolution issues in stricter, modern Node environments (like Node 24). This addresses the issue recently raised by @varshitha in the #generator Slack channel regarding SonarCloud flagging these imports.

The Fix:

Updated apps/generator/scripts/build-templates.js

Updated packages/helpers/src/testing.js

Updated packages/helpers/test/testing.test.js (including Jest mocks).

Verification:

npm run test passes successfully in packages/helpers.

Summary by CodeRabbit

  • Chores
    • Updated Node.js module import conventions across the codebase for improved compatibility and consistency. No functional changes or user impact.

Updates outdated fs/promises imports across the codebase to use the modern node:fs/promises prefix, resolving SonarCloud warnings and ensuring compatibility with strict Node 24+ environments.
@changeset-bot
Copy link

changeset-bot bot commented Feb 16, 2026

⚠️ No Changeset found

Latest commit: ff81db2

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@asyncapi-bot
Copy link
Contributor

What reviewer looks at during PR review

The following are ideal points maintainers look for during review. Reviewing these points yourself beforehand can help streamline the review process and reduce time to merge.

  1. PR Title: Use a concise title that follows our Conventional Commits guidelines and clearly summarizes the change using imperative mood (it means spoken or written as if giving a command or instruction, like "add new helper for listing operations")

    Note - In Generator, prepend feat: or fix: in PR title only when PATCH/MINOR release must be triggered.

  2. PR Description: Clearly explain the issue being solved, summarize the changes made, and mention the related issue.

    Note - In Generator, we use Maintainers Work board to track progress. Ensure the PR Description includes Resolves #<issue-number> or Fixes #<issue-number> this will automatically close the linked issue when the PR is merged and helps automate the maintainers workflow.

  3. Documentation: Update the relevant Generator documentation to accurately reflect the changes introduced in the PR, ensuring users and contributors have up-to-date guidance.

  4. Comments and JSDoc: Write clear and consistent JSDoc comments for functions, including parameter types, return values, and error conditions, so others can easily understand and use the code.

  5. DRY Code: Ensure the code follows the Don't Repeat Yourself principle. Look out for duplicate logic that can be reused.

  6. Test Coverage: Ensure the new code is well-tested with meaningful test cases that pass consistently and cover all relevant edge cases.

  7. Commit History: Contributors should avoid force-pushing as much as possible. It makes it harder to track incremental changes and review the latest updates.

  8. Template Design Principles Alignment: While reviewing template-related changes in the packages/ directory, ensure they align with the Assumptions and Principles. If any principle feels outdated or no longer applicable, start a discussion these principles are meant to evolve with the project.

  9. Reduce Scope When Needed: If an issue or PR feels too large or complex, consider splitting it and creating follow-up issues. Smaller, focused PRs are easier to review and merge.

  10. Bot Comments: As reviewers, check that contributors have appropriately addressed comments or suggestions made by automated bots. If there are bot comments the reviewer disagrees with, react to them or mark them as resolved, so the review history remains clear and accurate.

@coderabbitai
Copy link

coderabbitai bot commented Feb 16, 2026

No actionable comments were generated in the recent review. 🎉


📝 Walkthrough

Walkthrough

This pull request updates import paths from fs/promises to node:fs/promises across three files. This change modernizes the code to use Node.js's explicit module prefix convention without altering any logic or functionality.

Changes

Cohort / File(s) Summary
Import path modernization - Generator
apps/generator/scripts/build-templates.js
Updated fs/promises import to node:fs/promises.
Import path modernization - Helpers
packages/helpers/src/testing.js, packages/helpers/test/testing.test.js
Updated fs/promises imports to node:fs/promises in source and test files, including jest.mock references.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title uses the 'refactor:' prefix consistent with Conventional Commits, clearly describes the main change (updating fs/promises imports to use node: prefix), and accurately reflects the changeset across all modified files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into master

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@sonarqubecloud
Copy link

@Adi-204
Copy link
Member

Adi-204 commented Feb 16, 2026

Thanks for the contribution. I’m closing this PR because, there is no existing issue linked in the PR.

Please make sure to follow the contribution guidelines, which explain when issues are considered ready for implementation and when pull requests are appropriate.

@Adi-204 Adi-204 closed this Feb 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants