Merge pull request #37 from playcanvas/feat-script-name

Parse static scriptName field

Author: marklundin

src/index.js

@@ -143,9 +143,26 @@ export class JSDocParser {
 
         const esmScriptClass = pcTypes.statements.find(node => node.kind === ts.SyntaxKind.ClassDeclaration && node.name.text === 'Script')?.symbol;
 
+        const isScriptNameMember = member => (
+            ts.isPropertyDeclaration(member) && // Is a property declaration
+            ts.isIdentifier(member.name) &&
+            member.name.text === 'scriptName' &&
+            (ts.getCombinedModifierFlags(member) & ts.ModifierFlags.Static) !== 0 &&
+            ts.isStringLiteral(member.initializer)
+        );
+
         // Check if the file exports a class that inherits from `Script`
         nodes.forEach((node, name) => {
             if (isAliasedClassDeclaration(node, typeChecker) && inheritsFrom(node, typeChecker, esmScriptClass)) {
+
+                // Check for a static scriptName property and use that as the name if it exists
+                const scriptNameMember = node.members.find(isScriptNameMember);
+
+                // If the scriptName property exists, use that as the name
+                if (scriptNameMember) {
+                    name = scriptNameMember.initializer.text;
+                }
+
                 esmScripts.set(name, node);
             }
         });

test/fixtures/program.valid.js

@@ -6,6 +6,8 @@ import { Script } from 'playcanvas';
 export const MyEnum = { value: 0 };
 
 class Example extends Script {
+    static scriptName = 'customExample';
+
     /**
      * @attribute
      * @precision 1

test/tests/valid/program.test.js

@@ -9,10 +9,15 @@ describe('VALID: Program ', function () {
         data = await parseAttributes('./program.valid.js');
     });
 
+    it('should have a customExample script', function () {
+        expect(data[0].customExample).to.exist;
+        expect(data[0].customExample.errors).to.be.empty;
+    });
+
     it('only results should exist', function () {
         expect(data).to.exist;
         expect(data[0]).to.not.be.empty;
         expect(data[1]).to.be.empty;
-        expect(data[0].example.errors).to.be.empty;
+        expect(data[0].customExample.errors).to.be.empty;
     });
 });