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: use ES modules in README.md #978

Merged
merged 5 commits into from Feb 8, 2022
Merged

fix: use ES modules in README.md #978

merged 5 commits into from Feb 8, 2022

Conversation

ehmicky
Copy link
Contributor

@ehmicky ehmicky commented Jan 28, 2022

Part of #749

This converts the examples in README.md to ES modules.


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
@github-actions github-actions bot added the type: bug code to address defects in shipped code label Jan 28, 2022
.eslintrc.js Outdated
files: '*.md/*.js',
parserOptions: {
sourceType: 'module',
},
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Workaround since the top-level repository is not using pure ES modules yet.
To remove once this is not the case anymore.


return archives
}
const archives = await zipFunctions('functions', 'functions-dist', {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Pure ES modules come with top-level await support too.

@ehmicky ehmicky removed the type: bug code to address defects in shipped code label Jan 28, 2022
@ehmicky ehmicky mentioned this pull request Jan 28, 2022
erezrokah
erezrokah previously approved these changes Feb 8, 2022
@kodiakhq kodiakhq bot merged commit 225f387 into main Feb 8, 2022
@kodiakhq kodiakhq bot deleted the chore/esm-readme branch February 8, 2022 18:13
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