Skip to content

chore: enforce explicit Buffer import and add lint rule #6525

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

Conversation

shivarm
Copy link
Contributor

@shivarm shivarm commented May 22, 2025

explicitly import Buffer using const { Buffer } = require('node:buffer') for clarity and future compatibility, following Node.js best practices.

@bjohansebas
Copy link
Member

I'm not sure this is a good practice, Buffer is a global property

@krzysdz
Copy link
Contributor

krzysdz commented May 29, 2025

I'm not sure this is a good practice, Buffer is a global property

Node.js docs say:

While the Buffer class is available within the global scope, it is still recommended to explicitly reference it via an import or require statement.

This sentence replaced the previous

The Buffer class is within the global scope, making it unlikely that one would need to ever use require('buffer').Buffer.

in nodejs/node#39043, but I can't find any arguments for why it is recommended. I think that it's just a cosmetic change for compatibility (or explicit incompatibility) reasons with other environments, but that's just a guess.

@bjohansebas
Copy link
Member

@krzysdz Thanks for the references

Copy link
Member

@wesleytodd wesleytodd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be good to keep consistency, so if anyone is willing I think we have a bunch of other packages that could use this change.

FWIW, it is a cosmetic change but is still worth it to do because it sets a good example for anyone reading this code to learn from.

@Phillip9587
Copy link
Contributor

@shivarm Could you please update all occurrences of Buffer?

@wesleytodd If we want to keep that consistent we should add a lint rule to prevent usage of global Buffer:

rules:
  no-restricted-globals:
    - error
    - name: Buffer
      message: Use `import { Buffer } from "node:buffer"` instead of the global Buffer.

Copy link
Contributor

@Phillip9587 Phillip9587 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comment above

@wesleytodd
Copy link
Member

@wesleytodd If we want to keep that consistent we should add a lint rule to prevent usage of global Buffer:

I am against one off lint rule discussions on principal, but I agree it would be best if we had these things enforced by linting. Since we have an eslint config already in the repo, I am not opposed to adding one as a temporary step until we get a better setup overall. @shivarm you could add this rule so that you can find and fix all the other implicit global usage.

Signed-off-by: Shivam Sharma <meshivam81@gmail.com>
@shivarm shivarm force-pushed the explicitly-require-statement-buffer branch from 7611815 to bb8ac68 Compare June 20, 2025 16:25
@shivarm
Copy link
Contributor Author

shivarm commented Jun 20, 2025

@wesleytodd Done 👍

@shivarm shivarm changed the title Buffer: keep nodejs best practice chore: enforce explicit Buffer import and add lint rule Jun 20, 2025
Copy link

@Hardanish-Singh Hardanish-Singh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@bjohansebas bjohansebas merged commit 98c85eb into expressjs:master Jun 28, 2025
26 checks passed
@shivarm shivarm deleted the explicitly-require-statement-buffer branch June 28, 2025 05:02
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.

7 participants