dx: Lint rule for imports#2345
Merged
Merged
Conversation
|
pkg.pr.new packages benchmark commit |
📊 Bundle Size Comparison
👀 Notable resultsStatic test results:No major changes. Dynamic test results:No major changes. 📋 All resultsClick to reveal the results table (353 entries).
If you wish to run a comparison for other, slower bundlers, run the 'Tree-shake test' from the GitHub Actions menu. |
There was a problem hiding this comment.
Pull request overview
Adds a new internal ESLint plugin consumed by the repo’s oxlint configuration to enforce import-path hygiene (simplifying redundant relative paths and preventing overly-deep relative imports in docs examples), and applies path simplifications across the TypeGPU package.
Changes:
- Introduces
packages/eslint-plugin-internalwith two rules:no-useless-path-segmentsandno-long-imports, plus Vitest-based rule tests. - Wires the new plugin + rules into
oxlint.config.tsand workspace dependencies. - Simplifies several TypeGPU internal imports by removing redundant path segments.
Reviewed changes
Copilot reviewed 22 out of 23 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| pnpm-lock.yaml | Adds the new workspace plugin and updates lock entries accordingly. |
| package.json | Adds eslint-plugin-internal as a workspace dev dependency. |
| oxlint.config.ts | Loads eslint-plugin-internal and enables the new rules (glob-scoped for examples). |
| packages/typegpu/src/tgsl/generationHelpers.ts | Simplifies internal imports to shorter relative paths. |
| packages/typegpu/src/core/unroll/tgpuUnroll.ts | Simplifies internal imports to shorter relative paths. |
| packages/typegpu/src/core/slot/slotTypes.ts | Fixes redundant/odd relative import segment (./../). |
| packages/typegpu/src/core/root/rootTypes.ts | Simplifies imports for querySet and tgpuComputeFn. |
| packages/typegpu/src/core/root/init.ts | Simplifies querySet imports. |
| packages/typegpu/src/core/querySet/querySet.ts | Simplifies root types import. |
| packages/typegpu/src/core/pipeline/renderPipeline.ts | Simplifies buffer/querySet imports. |
| packages/typegpu/src/core/pipeline/computePipeline.ts | Simplifies querySet import. |
| packages/eslint-plugin-internal/* | New internal lint plugin package, rules, tests, and build/test configs. |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 21 out of 22 changed files in this pull request and generated 1 comment.
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
reczkok
reviewed
Apr 14, 2026
| return { | ||
| ImportDeclaration(node) { | ||
| const importPath = node.source.value; | ||
| if (importPath.startsWith('../../') && !importPath.startsWith('../../common/')) { |
Contributor
There was a problem hiding this comment.
Doesn't this introduce a pretty high chance of false positives?
Contributor
Author
There was a problem hiding this comment.
We only enable this rule on example files, where this will not work due to stackblitz pathing requirements
Resolution Time Benchmark---
config:
themeVariables:
xyChart:
plotColorPalette: "#E63946, #3B82F6, #059669"
---
xychart
title "Random Branching (🔴 PR | 🔵 main | 🟢 release)"
x-axis "max depth" [1, 2, 3, 4, 5, 6, 7, 8]
y-axis "time (ms)"
line [0.87, 1.73, 3.65, 6.38, 7.21, 10.71, 19.62, 24.58]
line [0.92, 1.85, 3.88, 6.06, 7.72, 10.94, 20.72, 23.69]
line [0.91, 1.84, 4.09, 6.37, 7.79, 10.03, 20.47, 21.71]
---
config:
themeVariables:
xyChart:
plotColorPalette: "#E63946, #3B82F6, #059669"
---
xychart
title "Linear Recursion (🔴 PR | 🔵 main | 🟢 release)"
x-axis "max depth" [1, 2, 3, 4, 5, 6, 7, 8]
y-axis "time (ms)"
line [0.32, 0.54, 0.68, 0.85, 1.12, 1.17, 1.35, 1.53]
line [0.32, 0.52, 0.66, 0.81, 1.09, 1.20, 1.40, 1.54]
line [0.30, 0.50, 0.63, 0.79, 1.07, 1.19, 1.43, 1.56]
---
config:
themeVariables:
xyChart:
plotColorPalette: "#E63946, #3B82F6, #059669"
---
xychart
title "Full Tree (🔴 PR | 🔵 main | 🟢 release)"
x-axis "max depth" [1, 2, 3, 4, 5, 6, 7, 8]
y-axis "time (ms)"
line [0.76, 1.92, 3.98, 5.82, 11.71, 24.08, 52.40, 106.17]
line [0.84, 2.02, 3.59, 5.87, 11.78, 24.50, 52.50, 108.54]
line [0.91, 2.01, 3.67, 5.82, 11.81, 25.08, 52.64, 108.76]
|
cieplypolar
reviewed
Apr 28, 2026
cieplypolar
reviewed
Apr 28, 2026
cieplypolar
reviewed
Apr 28, 2026
cieplypolar
reviewed
Apr 28, 2026
cieplypolar
requested changes
Apr 28, 2026
Collaborator
cieplypolar
left a comment
cieplypolar
left a comment
There was a problem hiding this comment.
Great work! I left some comments that should be addressed before merge.
cieplypolar
approved these changes
May 21, 2026
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
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.
This PR introduces a new internal lint plugin, along with
two rulesone rule.Rule
noUselessPathSegments- mirrors eslint-plugin-import rule that is not yet implemented in oxlint, it looks for unnecessary import segments like../../src/file.txt->../file.txt.RulenoLongImports- forbids imports starting with../..in examples (except../../common), since they are most likely an import mishap likeimport { vec2f } from '../../../../../../packages/typegpu/src/data/vector.ts';that won't work on stackblitz anyway.