palantir/blueprint

Dynamic imports false positive on class-constants ESLint rule

Open

#6209 opened on Jun 7, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (20,263 stars) (2,167 forks)batch import
Domain: toolingP2Type: bughelp wanted

Description

Normal imports don't seem to be impacted by this, though dynamic imports are. Packages imported dynamically that include pt in their name seem to trigger an ESLint rule related to Blueprint.

root@______ # ./gradlew :subproject:eslint

> Task :subproject:eslint
error: use Blueprint `Classes` constant instead of string literal (@blueprintjs/classes-constants) at <redacted_filename>:

  49 | 
> 50 |         const { compileTypeScript } = await import("@example/pt-typescript");
     |                                                    ^

1 error found.
1 error potentially fixable with the `--fix` option.

> Task :subproject:eslint FAILED

FAILURE: Build failed with an exception.```

Contributor guide

Tech stack
typescriptreact
Domain
frontenddeveloper experiencetooling
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
knowledge of ESLint rulesunderstanding of Blueprint Classes constants
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Investigate the ESLint rule `@blueprintjs/classes constants` to understand why dynamic imports containing 'pt' trigger a false positive. Look at the rule implementation (likely in the Blueprint monorepo under packages/classes constants) and check if the regex or string matching logic incorrectly flags string literals inside dynamic import expressions. Consider adding a test case for dynamic imports to confirm the bug and then adjust the rule to skip dynamic import statements.