Fixed typing and eslint for ESM scripts (#7288)

playcanvas · Jan 16, 2025 · 6143472 · 6143472
1 parent 39c1419
commit 6143472
Show file tree

Hide file tree

Showing 8 changed files with 4 additions and 7 deletions.
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -47,7 +47,8 @@ export default [
     {
         files: ['scripts/**/*.mjs'],
         rules: {
-            'jsdoc/no-defaults': 'off' // Attributes use default values
+            'jsdoc/no-defaults': 'off', // Attributes use default values
+            'import/no-unresolved': 'off' // PlayCanvas is not installed for scripts
         }
     },
     {

diff --git a/playcanvas.d.ts b/playcanvas.d.ts
@@ -0,0 +1 @@
+export * from './src/index';
diff --git a/scripts/esm/camera-controls.mjs b/scripts/esm/camera-controls.mjs
@@ -1,4 +1,3 @@
-/* eslint-disable-next-line import/no-unresolved */
 import { Vec2, Vec3, Ray, Plane, Mat4, Quat, Script, math } from 'playcanvas';
 
 /** @import { AppBase, Entity, CameraComponent } from 'playcanvas' */

diff --git a/scripts/esm/first-person-controller.mjs b/scripts/esm/first-person-controller.mjs
@@ -1,4 +1,3 @@
-/* eslint-disable-next-line import/no-unresolved */
 import { math, Script, Vec2, Vec3, Mat4 } from 'playcanvas';
 
 /** @import { AppBase, GraphicsDevice, Entity, RigidBodyComponent } from 'playcanvas' */

diff --git a/scripts/esm/grid.mjs b/scripts/esm/grid.mjs
@@ -10,7 +10,6 @@ import {
     Color,
     Script,
     Vec2
-/* eslint-disable-next-line import/no-unresolved */
 } from 'playcanvas';
 
 /** @import { AppBase, Entity } from 'playcanvas' */

diff --git a/scripts/esm/xr-controllers.mjs b/scripts/esm/xr-controllers.mjs
@@ -1,4 +1,3 @@
-/* eslint-disable-next-line import/no-unresolved */
 import { Script } from 'playcanvas';
 
 export default class XrControllers extends Script {

diff --git a/scripts/esm/xr-navigation.mjs b/scripts/esm/xr-navigation.mjs
@@ -1,4 +1,3 @@
-/* eslint-disable-next-line import/no-unresolved */
 import { Color, Script, Vec3 } from 'playcanvas';
 
 /** @import { XrInputSource } from 'playcanvas' */

diff --git a/tsconfig.json b/tsconfig.json
@@ -36,5 +36,5 @@
         ],
         "readme": "none"
     },
-    "include": ["src/**/*.js", "scripts/**/*.mjs", "rollup.config.mjs"],
+    "include": ["src/**/*.js", "scripts/**/*.mjs", "rollup.config.mjs", "playcanvas.d.ts"],
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,7 +10,6 @@ import { @@
         Color,
         Script,
         Vec2
-    /* eslint-disable-next-line import/no-unresolved */
     } from 'playcanvas';
     /** @import { AppBase, Entity } from 'playcanvas' */
@@ Expand Down @@