feat: Lint plugin POC

[aleksanderkatan]

This is an eslint plugin, thus it should be compatible with oxc.
The plugin currently has one rule, which detects int/int divisions.
I did not do any package publishing stuff yet.

To test the CLI locally in the typegpu package:

• run nr build in the lint plugin package,
• run pnpm install -D eslint, pnpm install -D @typescript-eslint/parser in typegpu package,
• add "eslint-plugin-typegpu": "workspace:*" dependency to typegpu dev dependencies in package.json,
• add an eslint.config.js file

import typegpu from 'eslint-plugin-typegpu';
import tsParser from '@typescript-eslint/parser';

export default [
  typegpu.configs.recommended,
  {
    files: ['**/*.ts', '**/*.tsx'],
    languageOptions: {
      parser: tsParser,
    },
  },
];

• run ni; npx eslint in typegpu package.

The plugin tests use vitest's describe and it under the hood, and are compatible with hot reload. Tests are wrapped into a describe to let vitest's static analysis know that this is in fact a test file.

[github-actions]

pkg.pr.new

packages
Ready to be installed by your favorite package manager ⬇️

https://pkg.pr.new/software-mansion/TypeGPU/typegpu@079548664b63bd73426ab4ad78b462aec0e77f33

https://pkg.pr.new/software-mansion/TypeGPU/@typegpu/noise@079548664b63bd73426ab4ad78b462aec0e77f33

https://pkg.pr.new/software-mansion/TypeGPU/unplugin-typegpu@079548664b63bd73426ab4ad78b462aec0e77f33

benchmark
view benchmark

commit
view commit

[github-actions]

📊 Bundle Size Comparison

🟢 Decreased	➖ Unchanged	🔴 Increased	❔ Unknown
0	331	0	0

👀 Notable results

Static test results:

No major changes.

Dynamic test results:

No major changes.

📋 All results

Click to reveal the results table (330 entries).

Test	tsdown
dataImportEverything.ts	80.07 kB (➖)
dataImportOneDirect.ts	40.68 kB (➖)
dataImportOneStar.ts	40.68 kB (➖)
functionWithUseGpu.ts	268 B (➖)
functionWithoutUseGpu.ts	24 B (➖)
importEntireLibrary.ts	259.36 kB (➖)
stdImportEverything.ts	112.71 kB (➖)
stdImportOneDirect.ts	61.91 kB (➖)
stdImportOneStar.ts	61.91 kB (➖)
tgpuImportEverything.ts	239.90 kB (➖)
tgpuImportOne.ts	239.91 kB (➖)
MissingBindGroupsError from typegpu.ts	1.29 kB (➖)
MissingLinksError from typegpu.ts	208 B (➖)
MissingSlotValueError from typegpu.ts	153 B (➖)
MissingVertexBuffersError from typegpu.ts	1.29 kB (➖)
NotUniformError from typegpu.ts	1.25 kB (➖)
ResolutionError from typegpu.ts	1.48 kB (➖)
Void from typegpudata.ts	675 B (➖)
abs from typegpustd.ts	78.58 kB (➖)
acos from typegpustd.ts	78.58 kB (➖)
acosh from typegpustd.ts	78.58 kB (➖)
add from typegpustd.ts	61.91 kB (➖)
align from typegpudata.ts	42.35 kB (➖)
alignmentOf from typegpudata.ts	38.77 kB (➖)
allEq from typegpustd.ts	64.31 kB (➖)
all from typegpustd.ts	64.31 kB (➖)
and from typegpustd.ts	64.31 kB (➖)
any from typegpustd.ts	64.32 kB (➖)
arrayLength from typegpustd.ts	11.03 kB (➖)
arrayOf from typegpudata.ts	42.56 kB (➖)
asin from typegpustd.ts	78.58 kB (➖)
asinh from typegpustd.ts	78.58 kB (➖)
atan2 from typegpustd.ts	78.58 kB (➖)
atan from typegpustd.ts	78.58 kB (➖)
atanh from typegpustd.ts	78.58 kB (➖)
atomicAdd from typegpustd.ts	12.57 kB (➖)
atomicAnd from typegpustd.ts	12.57 kB (➖)
atomicLoad from typegpustd.ts	12.56 kB (➖)
atomicMax from typegpustd.ts	12.57 kB (➖)
atomicMin from typegpustd.ts	12.57 kB (➖)
atomicOr from typegpustd.ts	12.57 kB (➖)
atomicStore from typegpustd.ts	12.56 kB (➖)
atomicSub from typegpustd.ts	12.57 kB (➖)
atomicXor from typegpustd.ts	12.57 kB (➖)
atomic from typegpudata.ts	714 B (➖)
bitcastU32toF32 from typegpustd.ts	59.68 kB (➖)
bitcastU32toI32 from typegpustd.ts	59.68 kB (➖)
bool from typegpudata.ts	10.56 kB (➖)
builtin from typegpudata.ts	44.91 kB (➖)
ceil from typegpustd.ts	78.58 kB (➖)
clamp from typegpustd.ts	78.58 kB (➖)
common from typegpu.ts	54.50 kB (➖)
comparisonSampler from typegpudata.ts	694 B (➖)
cos from typegpustd.ts	78.58 kB (➖)
cosh from typegpustd.ts	78.58 kB (➖)
countLeadingZeros from typegpustd.ts	78.58 kB (➖)
countOneBits from typegpustd.ts	78.58 kB (➖)
countTrailingZeros from typegpustd.ts	78.58 kB (➖)
cross from typegpustd.ts	78.58 kB (➖)
d from typegpu.ts	80.08 kB (➖)
deepEqual from typegpudata.ts	2.71 kB (➖)
degrees from typegpustd.ts	78.58 kB (➖)
determinant from typegpustd.ts	78.58 kB (➖)
disarrayOf from typegpudata.ts	12.51 kB (➖)
discard from typegpustd.ts	9.10 kB (➖)
distance from typegpustd.ts	78.58 kB (➖)
div from typegpustd.ts	61.91 kB (➖)
dot4I8Packed from typegpustd.ts	78.58 kB (➖)
dot4U8Packed from typegpustd.ts	78.58 kB (➖)
dot from typegpustd.ts	78.58 kB (➖)
dpdxCoarse from typegpustd.ts	9.96 kB (➖)
dpdxFine from typegpustd.ts	9.96 kB (➖)
dpdx from typegpustd.ts	9.95 kB (➖)
dpdyCoarse from typegpustd.ts	9.96 kB (➖)
dpdyFine from typegpustd.ts	9.96 kB (➖)
dpdy from typegpustd.ts	9.96 kB (➖)
eq from typegpustd.ts	64.31 kB (➖)
exp2 from typegpustd.ts	78.58 kB (➖)
exp from typegpustd.ts	78.58 kB (➖)
extensionEnabled from typegpustd.ts	12.08 kB (➖)
extractBits from typegpustd.ts	78.58 kB (➖)
f16 from typegpudata.ts	10.56 kB (➖)
f32 from typegpudata.ts	10.56 kB (➖)
faceForward from typegpustd.ts	78.58 kB (➖)
firstLeadingBit from typegpustd.ts	78.58 kB (➖)
firstTrailingBit from typegpustd.ts	78.58 kB (➖)
float16 from typegpudata.ts	37.48 kB (➖)
float16x2 from typegpudata.ts	37.48 kB (➖)
float16x4 from typegpudata.ts	37.48 kB (➖)
float32 from typegpudata.ts	37.48 kB (➖)
float32x2 from typegpudata.ts	37.48 kB (➖)
float32x3 from typegpudata.ts	37.48 kB (➖)
float32x4 from typegpudata.ts	37.48 kB (➖)
floor from typegpustd.ts	78.58 kB (➖)
fma from typegpustd.ts	78.58 kB (➖)
formatToWGSLType from typegpudata.ts	37.47 kB (➖)
fract from typegpustd.ts	78.58 kB (➖)
frexp from typegpustd.ts	78.58 kB (➖)
fwidthCoarse from typegpustd.ts	9.96 kB (➖)
fwidthFine from typegpustd.ts	9.96 kB (➖)
fwidth from typegpustd.ts	9.96 kB (➖)
ge from typegpustd.ts	64.31 kB (➖)
gt from typegpustd.ts	64.32 kB (➖)
i32 from typegpudata.ts	10.56 kB (➖)
identity2 from typegpustd.ts	42.93 kB (➖)
identity3 from typegpustd.ts	42.93 kB (➖)
identity4 from typegpustd.ts	42.93 kB (➖)
insertBits from typegpustd.ts	78.58 kB (➖)
interpolate from typegpudata.ts	42.36 kB (➖)
invariant from typegpudata.ts	42.73 kB (➖)
inverseSqrt from typegpustd.ts	78.58 kB (➖)
isAccessor from typegpu.ts	72 B (➖)
isAlignAttrib from typegpudata.ts	696 B (➖)
isAtomic from typegpudata.ts	696 B (➖)
isBufferShorthand from typegpu.ts	1.61 kB (➖)
isBuffer from typegpu.ts	98.07 kB (➖)
isBuiltinAttrib from typegpudata.ts	698 B (➖)
isBuiltin from typegpudata.ts	40.77 kB (➖)
isCloseTo from typegpustd.ts	64.32 kB (➖)
isComparisonSampler from typegpu.ts	65.18 kB (➖)
isData from typegpudata.ts	2.32 kB (➖)
isDecorated from typegpudata.ts	699 B (➖)
isDerived from typegpu.ts	71 B (➖)
isDisarray from typegpudata.ts	1.62 kB (➖)
isInterpolateAttrib from typegpudata.ts	702 B (➖)
isLocationAttrib from typegpudata.ts	699 B (➖)
isLooseData from typegpudata.ts	1.67 kB (➖)
isLooseDecorated from typegpudata.ts	1.63 kB (➖)
isMutableAccessor from typegpu.ts	80 B (➖)
isPackedData from typegpudata.ts	37.54 kB (➖)
isPtr from typegpudata.ts	693 B (➖)
isSampler from typegpu.ts	65.17 kB (➖)
isSizeAttrib from typegpudata.ts	695 B (➖)
isSlot from typegpu.ts	68 B (➖)
isTexture from typegpu.ts	65.16 kB (➖)
isTgpuFn from typegpu.ts	706 B (➖)
isUnstruct from typegpudata.ts	1.62 kB (➖)
isUsableAsRender from typegpu.ts	62 B (➖)
isUsableAsSampled from typegpu.ts	63 B (➖)
isUsableAsStorage from typegpu.ts	63 B (➖)
isUsableAsUniform from typegpu.ts	65.15 kB (➖)
isUsableAsVertex from typegpu.ts	98.06 kB (➖)
isVariable from typegpu.ts	66.96 kB (➖)
isWgslArray from typegpudata.ts	695 B (➖)
isWgslData from typegpudata.ts	1.25 kB (➖)
isWgslStruct from typegpudata.ts	696 B (➖)
ldexp from typegpustd.ts	78.58 kB (➖)
le from typegpustd.ts	64.32 kB (➖)
length from typegpustd.ts	78.58 kB (➖)
location from typegpudata.ts	42.35 kB (➖)
log2 from typegpustd.ts	78.58 kB (➖)
log from typegpustd.ts	78.58 kB (➖)
lt from typegpustd.ts	64.31 kB (➖)
mat2x2f from typegpudata.ts	42.93 kB (➖)
mat3x3f from typegpudata.ts	42.93 kB (➖)
mat4x4f from typegpudata.ts	42.93 kB (➖)
matToArray from typegpudata.ts	43.07 kB (➖)
max from typegpustd.ts	78.58 kB (➖)
min from typegpustd.ts	78.58 kB (➖)
mix from typegpustd.ts	78.58 kB (➖)
mod from typegpustd.ts	61.91 kB (➖)
modf from typegpustd.ts	78.58 kB (➖)
mul from typegpustd.ts	61.91 kB (➖)
ne from typegpustd.ts	64.31 kB (➖)
neg from typegpustd.ts	61.91 kB (➖)
normalize from typegpustd.ts	78.58 kB (➖)
not from typegpustd.ts	64.31 kB (➖)
or from typegpustd.ts	64.31 kB (➖)
pack2x16float from typegpustd.ts	51.52 kB (➖)
pack4x8unorm from typegpustd.ts	51.52 kB (➖)
packedFormats from typegpudata.ts	37.50 kB (➖)
pow from typegpustd.ts	78.58 kB (➖)
ptrFn from typegpudata.ts	800 B (➖)
ptrHandle from typegpudata.ts	792 B (➖)
ptrPrivate from typegpudata.ts	799 B (➖)
ptrStorage from typegpudata.ts	797 B (➖)
ptrUniform from typegpudata.ts	793 B (➖)
ptrWorkgroup from typegpudata.ts	801 B (➖)
quantizeToF16 from typegpustd.ts	78.58 kB (➖)
radians from typegpustd.ts	78.58 kB (➖)
ref from typegpudata.ts	3.82 kB (➖)
reflect from typegpustd.ts	78.58 kB (➖)
refract from typegpustd.ts	78.58 kB (➖)
reverseBits from typegpustd.ts	78.58 kB (➖)
rotateX4 from typegpustd.ts	62.63 kB (➖)
rotateY4 from typegpustd.ts	62.63 kB (➖)
rotateZ4 from typegpustd.ts	62.63 kB (➖)
rotationX4 from typegpustd.ts	42.93 kB (➖)
rotationY4 from typegpustd.ts	42.93 kB (➖)
rotationZ4 from typegpustd.ts	42.93 kB (➖)
round from typegpustd.ts	78.58 kB (➖)
sampler from typegpudata.ts	683 B (➖)
saturate from typegpustd.ts	78.58 kB (➖)
scale4 from typegpustd.ts	62.63 kB (➖)
scaling4 from typegpustd.ts	42.93 kB (➖)
select from typegpustd.ts	64.32 kB (➖)
sign from typegpustd.ts	78.58 kB (➖)
sin from typegpustd.ts	78.58 kB (➖)
sinh from typegpustd.ts	78.58 kB (➖)
sint16 from typegpudata.ts	37.48 kB (➖)
sint16x2 from typegpudata.ts	37.48 kB (➖)
sint16x4 from typegpudata.ts	37.48 kB (➖)
sint32 from typegpudata.ts	37.48 kB (➖)
sint32x2 from typegpudata.ts	37.48 kB (➖)
sint32x3 from typegpudata.ts	37.48 kB (➖)
sint32x4 from typegpudata.ts	37.48 kB (➖)
sint8 from typegpudata.ts	37.48 kB (➖)
sint8x2 from typegpudata.ts	37.48 kB (➖)
sint8x4 from typegpudata.ts	37.48 kB (➖)
sizeOf from typegpudata.ts	40.68 kB (➖)
size from typegpudata.ts	42.35 kB (➖)
smoothstep from typegpustd.ts	78.58 kB (➖)
snorm16 from typegpudata.ts	37.48 kB (➖)
snorm16x2 from typegpudata.ts	37.48 kB (➖)
snorm16x4 from typegpudata.ts	37.48 kB (➖)
snorm8 from typegpudata.ts	37.48 kB (➖)
snorm8x2 from typegpudata.ts	37.48 kB (➖)
snorm8x4 from typegpudata.ts	37.48 kB (➖)
sqrt from typegpustd.ts	78.58 kB (➖)
std from typegpu.ts	112.71 kB (➖)
step from typegpustd.ts	78.58 kB (➖)
storageBarrier from typegpustd.ts	12.57 kB (➖)
struct from typegpudata.ts	3.31 kB (➖)
sub from typegpustd.ts	61.91 kB (➖)
subgroupAdd from typegpustd.ts	39.58 kB (➖)
subgroupAll from typegpustd.ts	39.59 kB (➖)
subgroupAnd from typegpustd.ts	39.59 kB (➖)
subgroupAny from typegpustd.ts	39.59 kB (➖)
subgroupBallot from typegpustd.ts	39.59 kB (➖)
subgroupBroadcastFirst from typegpustd.ts	39.59 kB (➖)
subgroupBroadcast from typegpustd.ts	39.59 kB (➖)
subgroupElect from typegpustd.ts	39.59 kB (➖)
subgroupExclusiveAdd from typegpustd.ts	39.59 kB (➖)
subgroupExclusiveMul from typegpustd.ts	39.59 kB (➖)
subgroupInclusiveAdd from typegpustd.ts	39.59 kB (➖)
subgroupInclusiveMul from typegpustd.ts	39.59 kB (➖)
subgroupMax from typegpustd.ts	39.59 kB (➖)
subgroupMin from typegpustd.ts	39.59 kB (➖)
subgroupMul from typegpustd.ts	39.59 kB (➖)
subgroupOr from typegpustd.ts	39.59 kB (➖)
subgroupShuffleDown from typegpustd.ts	39.59 kB (➖)
subgroupShuffleUp from typegpustd.ts	39.59 kB (➖)
subgroupShuffleXor from typegpustd.ts	39.59 kB (➖)
subgroupShuffle from typegpustd.ts	39.59 kB (➖)
subgroupXor from typegpustd.ts	39.59 kB (➖)
tan from typegpustd.ts	78.58 kB (➖)
tanh from typegpustd.ts	78.58 kB (➖)
texture1d from typegpudata.ts	11.02 kB (➖)
texture2dArray from typegpudata.ts	11.04 kB (➖)
texture2d from typegpudata.ts	11.02 kB (➖)
texture3d from typegpudata.ts	11.02 kB (➖)
textureBarrier from typegpustd.ts	12.56 kB (➖)
textureCubeArray from typegpudata.ts	11.04 kB (➖)
textureCube from typegpudata.ts	11.02 kB (➖)
textureDepth2dArray from typegpudata.ts	11.02 kB (➖)
textureDepth2d from typegpudata.ts	11.01 kB (➖)
textureDepthCubeArray from typegpudata.ts	11.03 kB (➖)
textureDepthCube from typegpudata.ts	11.01 kB (➖)
textureDepthMultisampled2d from typegpudata.ts	11.03 kB (➖)
textureDimensions from typegpustd.ts	40.39 kB (➖)
textureExternal from typegpudata.ts	814 B (➖)
textureLoad from typegpustd.ts	40.39 kB (➖)
textureMultisampled2d from typegpudata.ts	11.04 kB (➖)
textureSampleBaseClampToEdge from typegpustd.ts	40.39 kB (➖)
textureSampleBias from typegpustd.ts	40.39 kB (➖)
textureSampleCompareLevel from typegpustd.ts	40.39 kB (➖)
textureSampleCompare from typegpustd.ts	40.39 kB (➖)
textureSampleLevel from typegpustd.ts	40.39 kB (➖)
textureSample from typegpustd.ts	40.39 kB (➖)
textureStorage1d from typegpudata.ts	978 B (➖)
textureStorage2dArray from typegpudata.ts	996 B (➖)
textureStorage2d from typegpudata.ts	978 B (➖)
textureStorage3d from typegpudata.ts	978 B (➖)
textureStore from typegpustd.ts	40.39 kB (➖)
tgpu.bindGroupLayout from typegpu.ts	74.06 kB (➖)
tgpu.comptime from typegpu.ts	11.85 kB (➖)
tgpu.const from typegpu.ts	66.03 kB (➖)
tgpu.fn from typegpu.ts	50.88 kB (➖)
tgpu.initFromDevice from typegpu.ts	231.09 kB (➖)
tgpu.init from typegpu.ts	231.60 kB (➖)
tgpu.privateVar from typegpu.ts	66.96 kB (➖)
tgpu.resolveWithContext from typegpu.ts	179.25 kB (➖)
tgpu.resolve from typegpu.ts	179.32 kB (➖)
tgpu.slot from typegpu.ts	1.58 kB (➖)
tgpu.vertexLayout from typegpu.ts	42.69 kB (➖)
tgpu.workgroupVar from typegpu.ts	66.96 kB (➖)
tgpu from typegpu.ts	239.91 kB (➖)
translate4 from typegpustd.ts	62.63 kB (➖)
translation4 from typegpustd.ts	42.93 kB (➖)
transpose from typegpustd.ts	78.58 kB (➖)
trunc from typegpustd.ts	78.58 kB (➖)
u16 from typegpudata.ts	10.59 kB (➖)
u32 from typegpudata.ts	10.56 kB (➖)
uint16 from typegpudata.ts	37.48 kB (➖)
uint16x2 from typegpudata.ts	37.48 kB (➖)
uint16x4 from typegpudata.ts	37.48 kB (➖)
uint32 from typegpudata.ts	37.48 kB (➖)
uint32x2 from typegpudata.ts	37.48 kB (➖)
uint32x3 from typegpudata.ts	37.48 kB (➖)
uint32x4 from typegpudata.ts	37.48 kB (➖)
uint8 from typegpudata.ts	37.48 kB (➖)
uint8x2 from typegpudata.ts	37.48 kB (➖)
uint8x4 from typegpudata.ts	37.48 kB (➖)
unorm10 10 10 2 from typegpudata.ts	37.48 kB (➖)
unorm16 from typegpudata.ts	37.48 kB (➖)
unorm16x2 from typegpudata.ts	37.48 kB (➖)
unorm16x4 from typegpudata.ts	37.48 kB (➖)
unorm8 from typegpudata.ts	37.48 kB (➖)
unorm8x2 from typegpudata.ts	37.48 kB (➖)
unorm8x4 bgra from typegpudata.ts	37.48 kB (➖)
unorm8x4 from typegpudata.ts	37.48 kB (➖)
unpack2x16float from typegpustd.ts	51.52 kB (➖)
unpack4x8unorm from typegpustd.ts	51.52 kB (➖)
unstruct from typegpudata.ts	1.58 kB (➖)
vec2b from typegpudata.ts	35.99 kB (➖)
vec2f from typegpudata.ts	35.99 kB (➖)
vec2h from typegpudata.ts	35.99 kB (➖)
vec2i from typegpudata.ts	35.99 kB (➖)
vec2u from typegpudata.ts	35.99 kB (➖)
vec3b from typegpudata.ts	35.99 kB (➖)
vec3f from typegpudata.ts	35.99 kB (➖)
vec3h from typegpudata.ts	35.99 kB (➖)
vec3i from typegpudata.ts	35.99 kB (➖)
vec3u from typegpudata.ts	35.99 kB (➖)
vec4b from typegpudata.ts	35.99 kB (➖)
vec4f from typegpudata.ts	35.99 kB (➖)
vec4h from typegpudata.ts	35.99 kB (➖)
vec4i from typegpudata.ts	35.99 kB (➖)
vec4u from typegpudata.ts	35.99 kB (➖)
workgroupBarrier from typegpustd.ts	12.57 kB (➖)

If you wish to run a comparison for other, slower bundlers, run the 'Tree-shake test' from the GitHub Actions menu.

[reczkok]

I think something like 12 / d.u32(5) would be a common pattern (wrapping just the denominator and expecting integer division). I know coding agents tend to do that.