@playcanvas/attribute-parser 1.4.0 → 1.5.1

package/package.json

@@ -5,7 +5,7 @@
   "engines": {
     "node": ">=18.0.0"
   },
-  "version": "1.4.0",
+  "version": "1.5.1",
   "dependencies": {
     "@playcanvas/eslint-config": "^1.7.4 || ^2.0.0",
     "@typescript/vfs": "^1.6.0",

package/src/parsers/attribute-parser.js

@@ -154,7 +154,7 @@ export class AttributeParser {
 
                         // Check if the declaration is a TypeScript enum
                         if (ts.isEnumDeclaration(declaration)) {
-                            members = declaration.members.map(member => ({ [member.name.getText()]: member.initializer.text }));
+                            members = declaration.members.map(member => ({ [member.name.text]: member.initializer.text }));
                         }
 
                         // Additionally check for JSDoc enum tag
@@ -187,7 +187,8 @@ export class AttributeParser {
             node.properties.forEach((property) => {
 
                 if (ts.isPropertyAssignment(property)) {
-                    const name = property.name && ts.isIdentifier(property.name) && property.name.text;
+                    const isValidName = ts.isIdentifier(property.name) || ts.isStringLiteral(property.name);
+                    const name = isValidName && property.name.text;
                     const value = getLiteralValue(property.initializer, this.typeChecker);
                     members.push({ [name]: value });
                 }

package/src/utils/ts-utils.js

@@ -218,9 +218,19 @@ export function getJSDocTags(node, typeChecker) {
         heritageChain.forEach((classNode) => {
             // for each class iterate over it's class members
             classNode.members.forEach((member) => {
-                if (ts.isPropertyDeclaration(member) || ts.isSetAccessor(member) || ts.isPropertySignature(member)) {
+                const isSetter = ts.isSetAccessor(member);
+                if (ts.isPropertyDeclaration(member) || isSetter || ts.isPropertySignature(member)) {
                     const memberName = member.name && ts.isIdentifier(member.name) ? member.name.text : 'unnamed';
-                    const hasJsDoc = member.jsDoc?.length > 0;
+
+                    let hasJsDoc = member.jsDoc?.length > 0;
+
+                    // If we are a setter with no jsdoc block, check any associated getter
+                    if (isSetter && !hasJsDoc) {
+                        const symbol = typeChecker.getSymbolAtLocation(member.name);
+                        member = symbol.declarations.find(accessor => accessor.jsDoc?.length > 0);
+                        hasJsDoc = !!member;
+                    }
+
                     if (hasJsDoc) {
                         tags.push({
                             memberName,

package/test/fixtures/enum.valid.js

@@ -16,7 +16,8 @@ const NumberEnum = {
 const StringEnum = {
     A: 'a',
     B: 'b',
-    C: 'c'
+    C: 'c',
+    'A string key': 'd'
 };
 
 /**

package/test/fixtures/enum.valid.ts

@@ -9,7 +9,8 @@ enum NumberEnum {
 enum StringEnum {
     A = 'a',
     B = 'b',
-    C = 'c'
+    C = 'c',
+    "A string key" = 'd'
 };
 
 enum NumberNumberEnum {

package/test/fixtures/misc.valid.js

@@ -12,6 +12,8 @@ class Example extends Script {
 
     _b = 10;
 
+    _d = 10;
+
     /**
      * @attribute
      * @type {number}
@@ -28,6 +30,20 @@ class Example extends Script {
      * @type {number}
      */
     c;
+
+    /**
+     * Reverse order gett/setter accessor
+     * @attribute
+     * @type {number}
+     */
+    get d() {
+        return this._d;
+    }
+
+    // eslint-disable-next-line grouped-accessor-pairs
+    set d(v) {
+        this._d = v;
+    }
 }
 
 export { Example };

package/test/tests/valid/enum.test.js

@@ -56,10 +56,11 @@ function runTests(fileName) {
             expect(data[0].example.attributes.h.name).to.equal('h');
             expect(data[0].example.attributes.h.type).to.equal('string');
             expect(data[0].example.attributes.h.array).to.equal(false);
-            expect(data[0].example.attributes.h.enum).to.be.an('array').with.lengthOf(3);
+            expect(data[0].example.attributes.h.enum).to.be.an('array').with.lengthOf(4);
             expect(data[0].example.attributes.h.enum[0]).to.deep.equal({ A: 'a' });
             expect(data[0].example.attributes.h.enum[1]).to.deep.equal({ B: 'b' });
             expect(data[0].example.attributes.h.enum[2]).to.deep.equal({ C: 'c' });
+            expect(data[0].example.attributes.h.enum[3]).to.deep.equal({ 'A string key': 'd' });
             expect(data[0].example.attributes.h.default).to.equal('');
         });
 

package/test/tests/valid/misc.test.js

@@ -43,4 +43,12 @@ describe('VALID: Misc attribute types', function () {
         expect(data[0].example.attributes.c).to.not.exist;
     });
 
+    it('d: should be a numeric attribute with a getter and setter defined in reverse order', function () {
+        expect(data[0].example.attributes.d).to.exist;
+        expect(data[0].example.attributes.d.name).to.equal('d');
+        expect(data[0].example.attributes.d.type).to.equal('number');
+        expect(data[0].example.attributes.d.array).to.equal(false);
+        expect(data[0].example.attributes.d.default).to.equal(0);
+    });
+
 });

package/rollup.config.js

@@ -1,33 +0,0 @@
-import commonjs from '@rollup/plugin-commonjs';
-import resolve from '@rollup/plugin-node-resolve';
-import swc from '@rollup/plugin-swc';
-
-export default {
-    input: 'src/index.js',
-    treeshake: { moduleSideEffects: false },
-    // Mark 'typescript' as external, so it won’t get bundled
-    // external: ['typescript'],
-    output: {
-        dir: 'dist',
-        format: 'esm'
-    },
-    plugins: [
-        commonjs({
-            include: /node_modules/,
-            ignoreGlobal: true,
-            sourceMap: false
-        }),
-        resolve({
-            browser: true, // This instructs the plugin to resolve for the browser
-            preferBuiltins: false // Prefer the local versions of built-ins instead of Node.js versions
-        }),
-        swc({ swc: {
-            minify: true,
-            jsc: {
-                minify: {
-                    compress: true
-                }
-            }
-        } })
-    ]
-};