feat(lint): configure unicorn/prefer-top-level-await rule #218
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Disable top-level await in library code (src/) to ensure compatibility with consumers who may not support ES modules with top-level await - Enable top-level await in examples/ for cleaner, more readable scripts - Add examples override with no-console off for script-style files
commit: |
- Add unicorn/prefer-module rule globally to enforce ESM patterns - Disallows __dirname/__filename in favour of import.meta.url - Disallows require() in favour of import
There was a problem hiding this comment.
Pull request overview
This PR configures the unicorn/prefer-top-level-await ESLint rule to ensure library code remains compatible with consumers while enabling cleaner code patterns in example scripts.
- Disables
unicorn/prefer-top-level-awaitin library source code (src/) for maximum compatibility - Enables
unicorn/prefer-top-level-awaitinexamples/directory to encourage modern async patterns - Adds
no-consoleoverride for example files to allow console output in scripts
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
This reverts commit a5e0cb0.
This was referenced Dec 11, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
unicorn/prefer-top-level-awaitin library code (src/) to ensure compatibility with consumers who may not support ES modules with top-level awaitunicorn/prefer-top-level-awaitinexamples/for cleaner, more readable scriptsno-consoleoff for script-style filesReferences
Test plan
pnpm lintpasses