Commit dd18383
feat(linter/node): implement no-top-level-await rule (#24634)
This implements
[`no-top-level-await`](https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/no-top-level-await.md)
from the Node ESLint plugin (#493).
AI Disclosure: Generated with Claude Code. Reviewed and tested by me.
I have an alternative implementation using a Program visitor but it made
no difference performance-wise on vscode or in benchmarking outside
extreme cases, so I don't think it's really worth the trouble vs the
simpler implementation here. It's still in the commit history if that
implementation is preferred.
There is one notable difference between this and the original
implementation, which is that the `convertPath` option is not
implemented, and the checking of `package.json`/`.npmignore` is not
implemented (it was used for checking if the given module was actually
exposed in the library) as there's no way to check against those in
oxlint. There's an argument to be made that this makes the rule not
worth implementing, and I'm open to that argument if we'd prefer to mark
this rule as unsupported instead.
All tests were ported from the original rule (excluding those reliant on
the mentioned config options/checks that were skipped). I've also had
Claude add a few additional test cases (see commit
40418f7) on top to cover behavior that
wasn't tested previously. I have confirmed that all of these tests are
identical to the behavior of the upstream rule, but I can remove them if
we don't want to have any divergence from the upstream test suite.
---------
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>1 parent 79060a1 commit dd18383
8 files changed
Lines changed: 309 additions & 1 deletion
File tree
- apps/oxlint/src-js/package
- crates/oxc_linter/src
- generated
- rules/node
- snapshots
- npm/oxlint
- tasks/track_linter_timings
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1234,6 +1234,7 @@ export interface DummyRuleMap { | |||
| 1234 | 1234 | "node/no-path-concat"?: RuleNoConfig; | |
| 1235 | 1235 | "node/no-process-env"?: RuleNoConfig | [AllowWarnDeny, NoProcessEnvConfig]; | |
| 1236 | 1236 | "node/no-sync"?: RuleNoConfig | [AllowWarnDeny, NoSyncConfig]; | |
| 1237 | + "node/no-top-level-await"?: RuleNoConfig | [AllowWarnDeny, NoTopLevelAwaitConfig]; | ||
| 1237 | 1238 | "object-shorthand"?: | |
| 1238 | 1239 | RuleNoConfig | [AllowWarnDeny, ShorthandType] | [AllowWarnDeny, ShorthandType, ObjectShorthandOptions]; | |
| 1239 | 1240 | "operator-assignment"?: RuleNoConfig | [AllowWarnDeny, AlwaysNever]; | |
@@ -4046,6 +4047,14 @@ export interface NoSyncConfig { | |||
| 4046 | 4047 | */ | |
| 4047 | 4048 | ignores?: string[]; | |
| 4048 | 4049 | } | |
| 4050 | + export interface NoTopLevelAwaitConfig { | ||
| 4051 | + /** | ||
| 4052 | + * If `true`, top-level `await` is allowed in files that start with a | ||
| 4053 | + * hashbang (`#!`), which marks them as executable scripts rather than | ||
| 4054 | + * importable modules. | ||
| 4055 | + */ | ||
| 4056 | + ignoreBin?: boolean; | ||
| 4057 | + } | ||
| 4049 | 4058 | export interface ObjectShorthandOptions { | |
| 4050 | 4059 | avoidExplicitReturnArrows?: boolean; | |
| 4051 | 4060 | avoidQuotes?: boolean; | |
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -853,6 +853,7 @@ pub(crate) mod node { | |||
| 853 | 853 | pub mod no_path_concat; | |
| 854 | 854 | pub mod no_process_env; | |
| 855 | 855 | pub mod no_sync; | |
| 856 | + pub mod no_top_level_await; | ||
| 856 | 857 | } | |
| 857 | 858 | ||
| 858 | 859 | /// <https://github.com/vuejs/eslint-plugin-vue> | |
0 commit comments