Merge pull request #5 from playcanvas/fix-imports-strict

Relaxes Type Validation
playcanvas · Aug 16, 2024 · 9847d35 · 9847d35
2 parents c6b0e98 + d9f00ba
commit 9847d35
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 28 deletions.
diff --git a/src/global.types.js b/src/global.types.js
diff --git a/src/index.js b/src/index.js
@@ -1,19 +1,17 @@
 import * as ts from 'typescript';
 import { createSystem, createDefaultMapFromNodeModules, createVirtualTypeScriptEnvironment } from '@typescript/vfs';
-import globalTypes from './global.types.js';
 import { ScriptParser } from './parsers/script-parser.js';
 import { createDefaultMapFromCDN, flatMapAnyNodes, getExportedNodes, getType, inheritsFrom, isAliasedClassDeclaration } from './utils/ts-utils.js';
 
 const toLowerCamelCase = str => str[0].toLowerCase() + str.substring(1);
 
 const COMPILER_OPTIONS = {
-    strictPropertyInitialization: false, // Allow uninitialized properties
+    strict: false,
     skipLibCheck: true, // Skip type checking of declaration files
     target: ts.ScriptTarget.ES2022, // If this version changes, the types must be updated in the /rollup.config.mjs
     module: ts.ModuleKind.CommonJS,
     checkJs: true, // Enable JSDoc parsing
     allowJs: true,
-    noImplicitAny: false, // Allow implicit any
     baseUrl: './',
     paths: {
         "playcanvas": ["/playcanvas.js"]
@@ -55,9 +53,6 @@ export class JSDocParser {
         const system = createSystem(fsMap);
         this._env = createVirtualTypeScriptEnvironment(system, Array.from(fsMap.keys()), ts, COMPILER_OPTIONS);
 
-        // Add global types to the parser
-        this._env.createFile('/global.d.ts', globalTypes);
-
         return this;
     }
 
@@ -205,7 +200,7 @@ export class JSDocParser {
                 }
 
                 // Extract JSDoc tags
-                const tags = member.jsDoc.map(jsdoc => jsdoc.tags?.map(tag => tag.tagName.getText()) ?? []).flat();
+                const tags = member.jsDoc? member.jsDoc.map(jsdoc => jsdoc.tags?.map(tag => tag.tagName.getText()) ?? []).flat() : []
 
                 const name = member.name.getText();
                 const type = getType(member, typeChecker);

diff --git a/src/parsers/script-parser.js b/src/parsers/script-parser.js
@@ -260,7 +260,8 @@ export class ScriptParser {
     validateProgram(errors = []) {
 
         // Report any compiler errors
-        const compilerDiagnostics = this.program.getSemanticDiagnostics();
+        const compilerDiagnostics = this.program.getSyntacticDiagnostics();
+
         if (compilerDiagnostics.length > 0) {
             for (const diagnostic of compilerDiagnostics) {
                 const message = ts.flattenDiagnosticMessageText(diagnostic.messageText, '\n');

diff --git a/test/fixtures/program.invalid.js b/test/fixtures/program.invalid.js
@@ -1,6 +1,7 @@
 import { Script } from 'playcanvas';
 
-class Example extends Script {
+// @ts-ignore
+Class Intentionally extends Invalid {
     /**
      * @attribute
      * @type {boolean}

diff --git a/test/fixtures/program.valid.js b/test/fixtures/program.valid.js
@@ -2,6 +2,7 @@ import { Script } from 'playcanvas';
 
 // The parser should ignore https imports and not throw an error
 import confetti from "https://esm.sh/canvas-confetti@1.6.0"
+import * as TWEEN from 'https://cdnjs.cloudflare.com/ajax/libs/tween.js/23.1.2/tween.esm.js'
 
 class Example extends Script {
     /**
@@ -12,7 +13,9 @@ class Example extends Script {
 
     initialize() {
         confetti();
+        new TWEEN.Tween({ x: 0 }).to({ x: 100 }, 1000).start();
     }
 }
 
 export { Example };
+
diff --git a/test/tests/invalid/program.test.js b/test/tests/invalid/program.test.js
@@ -13,6 +13,6 @@ describe('INVALID: Program ', function () {
     it('only errors should exist (1)', function () {
         expect(data).to.exist;
         expect(data[0]).to.be.empty;
-        expect(data[1].length).to.equal(1);
+        expect(data[1].length).to.equal(4);
     });
 });