Skip to content
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

fix: fix JSON imports for ES modules #982

Merged
merged 3 commits into from Feb 8, 2022
Merged

fix: fix JSON imports for ES modules #982

merged 3 commits into from Feb 8, 2022

Conversation

ehmicky
Copy link
Contributor

@ehmicky ehmicky commented Jan 28, 2022

Part of #749

JSON imports with ES modules support in Node.js is still experimental. Therefore, to migrate to ES modules, we need to replace it with doing manual fs.readFile() + JSON.parse().


For us to review and ship your PR efficiently, please perform the following steps:

  • Open a bug/issue before writing your code
    🧑‍💻. This ensures we can discuss the changes and get feedback from everyone that should be involved. If you`re
    fixing a typo or something that`s on fire 🔥 (e.g. incident related), you can skip this step.
  • Read the contribution guidelines 📖. This ensures your code follows our style guide and
    passes our tests.
  • Update or add tests (if any source code was changed or added) 🧪
  • Update or add documentation (if features were changed or added) 📝
  • Make sure the status checks below are successful ✅

@ehmicky ehmicky added the type: chore work needed to keep the product and development running smoothly label Jan 28, 2022
@ehmicky ehmicky changed the title chore: fix JSON imports for ES modules fix: fix JSON imports for ES modules Jan 28, 2022
@github-actions github-actions bot added the type: bug code to address defects in shipped code label Jan 28, 2022
.eslintrc.js Outdated
@@ -2,6 +2,11 @@ const { overrides } = require('@netlify/eslint-config-node')

module.exports = {
extends: '@netlify/eslint-config-node',
rules: {
// This rule enforces using Buffers with `JSON.parse()`. However, TypeScript
// does not recognize yet that `JSON.parse()` accepts Buffers as argument.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Due to the above, we pass utf8 when in TypeScript, but not when in JavaScript.

@ehmicky ehmicky removed the type: bug code to address defects in shipped code label Jan 28, 2022
This was referenced Jan 28, 2022
erezrokah
erezrokah previously approved these changes Feb 8, 2022
@ehmicky ehmicky merged commit 64089d8 into main Feb 8, 2022
@ehmicky ehmicky deleted the chore/json-imports branch February 8, 2022 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge type: chore work needed to keep the product and development running smoothly
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants