@playcanvas/attribute-parser 1.0.0

package/test/fixtures/enum.valid.js

@@ -0,0 +1,78 @@
+import { Script, Vec3 } from 'playcanvas';
+
+/**
+ * @enum {number}
+ */
+const NumberEnum = {
+    A: 0,
+    B: 1,
+    C: 2
+};
+
+/**
+ * @enum {string}
+ */
+const StringEnum = {
+    A: 'a',
+    B: 'b',
+    C: 'c'
+}
+
+/**
+ * @enum {Vec3}
+ */
+const Vec3Enum = {
+    A: new Vec3(1, 2, 3),
+    B: new Vec3(4, 5, 6),
+    C: new Vec3(7, 8, 9)
+};
+
+/**
+ * @enum {NumberEnum}
+ */
+const NumberNumberEnum = {
+    A: NumberEnum.A,
+    B: NumberEnum.B,
+    C: NumberEnum.C
+}
+
+class Example extends Script {
+    /**
+     * @attribute
+     * @type {NumberEnum}
+     */
+    e;
+
+    /**
+     * @attribute
+     * @type {NumberEnum}
+     */
+    f = 1;
+
+    /**
+     * @attribute
+     * @type {NumberEnum[]}
+     * @size 2
+     */
+    g;
+
+    /**
+     * @attribute
+     * @type {StringEnum}
+     */
+    h;
+
+    /**
+     * @attribute
+     * @type {Vec3Enum}
+     */
+    i;
+
+    /**
+     * @attribute
+     * @type {NumberNumberEnum}
+     */
+    j = 2;
+}
+
+export { Example };

package/test/fixtures/export.import.js

@@ -0,0 +1,3 @@
+import { Script } from 'playcanvas';
+
+export class ExampleImport extends Script {}

package/test/fixtures/export.valid.js

@@ -0,0 +1,23 @@
+
+import { Script } from 'playcanvas';
+
+import { ExampleImport } from './export.import.js';
+
+class ExampleImportExtend extends ExampleImport {};
+
+export { ExampleImport as ExampleImportExportAs } from './export.import.js';
+
+class Example extends Script {};
+
+export default class ExampleDefault extends Script {};
+
+export class ExampleExport extends Script {}
+
+class ExampleNotExported extends Script {}
+
+export {
+    Example,
+    Example as ExampleExportAs,
+    ExampleImport,
+    ExampleImportExtend
+}

package/test/fixtures/inherit.valid.js

@@ -0,0 +1,52 @@
+
+import { Script } from 'playcanvas';
+
+class Example extends Script {
+    /**
+     * @attribute
+     * @type {boolean}
+     */
+    a;
+};
+
+class ExampleExtended extends Example {
+    /**
+     * @attribute
+     * @type {number}
+     */
+    b;
+};
+
+class ExampleExtendedExtended extends ExampleExtended {
+    /**
+     * @attribute
+     * @type {string}
+     */
+    c;
+}
+
+const ScriptAlias = Script;
+
+class ExampleAlias extends ScriptAlias {
+    /**
+     * @attribute
+     * @type {boolean}
+     */
+    a;
+}
+
+class ExampleNoExtend {
+    /**
+     * @attribute
+     * @type {number}
+     */
+    a;
+}
+
+export {
+    Example,
+    ExampleExtended,
+    ExampleExtendedExtended,
+    ExampleAlias,
+    ExampleNoExtend
+};

package/test/fixtures/intellisense.valid.js

@@ -0,0 +1,37 @@
+/* eslint-disable */
+import { Script, Vec3 } from 'playcanvas';
+
+/**
+ * @interface
+ */
+class Folder {
+    /**
+     * @attribute
+     */
+    a;
+
+    b = 10;
+}
+
+export class Example extends Script {
+    /**
+     * @attribute
+     */
+    a;
+
+    b = 10;
+
+    c = true;
+
+    d = 'hello';
+
+    e = {};
+
+    f = new Vec3();
+
+    /**
+     * @attribute
+     * @type {Folder}
+     */
+    g;
+}

package/test/fixtures/json.invalid.js

@@ -0,0 +1,22 @@
+import { Script } from 'playcanvas';
+
+class NoInterfaceFolder {
+    /**
+     * @attribute
+     * @type {boolean}
+     */
+    a;
+}
+
+/**
+ * @interface
+ */
+class Example extends Script {
+    /**
+     * @attribute
+     * @type {NoInterfaceFolder}
+     */
+    o;
+}
+
+export { Example };

package/test/fixtures/json.valid.js

@@ -0,0 +1,103 @@
+import { Script, Vec3 } from 'playcanvas';
+
+/**
+ * @interface
+ */
+class Folder {
+    /**
+     * @attribute
+     * @type {boolean}
+     */
+    a;
+
+    /**
+     * @attribute
+     */
+    b = 10;
+
+    c = 'hello';
+
+    /**
+     * @attribute
+     * @type {Vec3[]}
+     */
+    d;
+}
+
+/**
+ * @interface
+ */
+class NestedFolder {
+    /**
+     * @attribute
+     * @type {Folder}
+     */
+    x;
+}
+
+/**
+ * @interface
+ */
+class Example extends Script {
+    /**
+     * @attribute
+     * @type {Folder}
+     */
+    f;
+
+    /**
+     * @attribute
+     * @type {Folder[]}
+     * @size 2
+     */
+    g;
+
+    /**
+     * @attribute
+     * @type {NestedFolder}
+     */
+    h;
+
+    /**
+     * @attribute
+     */
+    i = { a: true, b: 10, c: 'hello', d: [new Vec3(1, 2, 3)] };
+
+    /**
+     * @typedef {object} TypeDefFolder
+     * @property {number} x - The x component
+     * @property {number} y - The y component
+     */
+
+    /**
+     * @attribute
+     * @type {TypeDefFolder}
+     */
+    j;
+
+    /**
+     * @typedef {{ x: number, y: number }} InlineTypeDefFolder
+     */
+
+    /**
+     * @attribute
+     * @type {InlineTypeDefFolder}
+     */
+    k;
+
+    /**
+     * @attribute
+     * @type {{ x: number, y: number }}
+     */
+    l;
+
+    /**
+     * @attribute
+     * @type {Example}
+     */
+    m;
+
+    n = 10;
+}
+
+export { Example };

package/test/fixtures/misc.invalid.js

@@ -0,0 +1,25 @@
+import { Script } from 'playcanvas';
+import { GraphNode } from './playcanvas';
+
+class Vec3 {};
+
+class Example extends Script {
+    /**
+     * @attribute
+     */
+    e = new GraphNode();
+
+    /**
+     * @attribute
+     */
+    f = new Vec3(); // Vec3 is not from playcanvas. It's type cannot be inferred
+
+    /**
+     * @attribute
+     * @type {number[]}
+     * @size a
+     */
+    g;
+}
+
+export { Example };

package/test/fixtures/misc.valid.js

@@ -0,0 +1,33 @@
+import { Script } from 'playcanvas';
+
+class Example extends Script {
+    /**
+     * This is a description of the attribute.
+     * 
+     * @attribute
+     * @type {number}
+     * @title A number
+     */
+    a;
+
+    _b = 10;
+
+    /**
+     * @attribute
+     * @type {number}
+     */
+    set b(v) {
+        this._b = v;
+    }
+
+    get b() {
+        return this._b;
+    }
+
+    /**
+     * @type {number}
+     */
+    c;
+}
+
+export { Example };

package/test/fixtures/numeric.invalid.js

@@ -0,0 +1,38 @@
+import { Script } from 'playcanvas';
+
+class Example extends Script {
+    /**
+     * @attribute
+     * @range ['a', 'b']
+     */
+    a = 0;
+
+    /**
+     * @attribute
+     * @step 0.1
+     */
+    b;
+
+    /**
+     * @attribute
+     * @precision 2
+     */
+    c;
+
+    /**
+     * @attribute
+     * @type {number}
+     * @step a
+     * @precision b
+     */
+    d;
+
+    /**
+     * @attribute
+     * @type {number}
+     * @step
+     */
+    e;
+}
+
+export { Example };

package/test/fixtures/numeric.valid.js

@@ -0,0 +1,63 @@
+import { Script } from 'playcanvas';
+
+class Example extends Script {
+    /**
+     * @attribute
+     * @type {number}
+     */
+    a;
+
+    /**
+     * @attribute
+     */
+    b = 1;
+
+    /**
+     * @attribute
+     * @type {number}
+     * @precision 2
+     * @step 0.01
+     */
+    c;
+
+    /**
+     * @attribute
+     * @type {number}
+     * @range [0, 1]
+     * @precision 2
+     * @step 0.01
+     */
+    d;
+
+    /**
+     * @attribute
+     * @type {number[]}
+     * @size 2
+     */
+    e;
+
+    /**
+     * @attribute
+     * @type {number}
+     * @range [       -  0xFF, 0o0        ]
+     * @precision 0b10
+     * @step 1e-2
+     */
+    f;
+
+    /**
+     * @attribute
+     * @type {number}
+     * @range [1]
+     */
+    g;
+
+    /**
+     * @attribute
+     * @type {number}
+     * @range []
+     */
+    h;
+}
+
+export { Example };