@playcanvas/attribute-parser 1.0.0

package/test/tests/valid/vector.test.js

@@ -0,0 +1,54 @@
+/* eslint-disable no-unused-expressions */
+import { describe, it, before } from 'mocha';
+import { expect } from 'chai';
+
+import { parseAttributes } from '../../utils.js';
+
+describe('VALID: Vector attribute', function () {
+    let data;
+    before(async function () {
+        data = await parseAttributes('./vector.valid.js');
+    });
+
+    it('only results should exist', function () {
+        expect(data).to.exist;
+        expect(data[0]).to.not.be.empty;
+        expect(data[1]).to.be.empty;
+    });
+
+    it('Example: should exist without errors', function () {
+        expect(data[0]?.example).to.exist;
+        expect(data[0].example.attributes).to.not.be.empty;
+        expect(data[0].example.errors).to.be.empty;
+    });
+
+    it('a: should be a vector attribute', function () {
+        expect(data[0].example.attributes.a).to.exist;
+        expect(data[0].example.attributes.a.name).to.equal('a');
+        expect(data[0].example.attributes.a.type).to.equal('vec2');
+        expect(data[0].example.attributes.a.array).to.equal(false);
+        expect(data[0].example.attributes.a.default).to.eql([0, 0]);
+    });
+
+    it('b: should be a vector attribute with a default value', function () {
+        expect(data[0].example.attributes.b).to.exist;
+        expect(data[0].example.attributes.b.name).to.equal('b');
+        expect(data[0].example.attributes.b.type).to.equal('vec3');
+        expect(data[0].example.attributes.b.array).to.equal(false);
+        expect(data[0].example.attributes.b.default).to.eql([1, 2, 3]);
+    });
+
+    it('c: should be a vector attribute array with a size', function () {
+        expect(data[0].example.attributes.c).to.exist;
+        expect(data[0].example.attributes.c.name).to.equal('c');
+        expect(data[0].example.attributes.c.type).to.equal('vec4');
+        expect(data[0].example.attributes.c.array).to.equal(true);
+        expect(data[0].example.attributes.c.size).to.equal(2);
+        expect(data[0].example.attributes.c.default).equal(null);
+    });
+
+    it('d: should not be recognized as an attribute (extends vector and not is vector)', function () {
+        expect(data[0].example.attributes.d).to.not.exist;
+    });
+
+});

package/test/utils.js

@@ -0,0 +1,53 @@
+import fs from 'fs/promises';
+import { fileURLToPath } from 'url';
+import path, { dirname } from 'path';
+import { JSDocParser } from '../src/index.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+/**
+ * Reads the contents of a file and returns an array containing the file name and its contents.
+ * @param {string} filePath - The path to the file.
+ * @returns {Promise<[string, string]>} A promise that resolves to an array containing the file name and its contents.
+ */
+async function getFileData(filePath) {
+    try {
+        const contents = await fs.readFile(path.join(__dirname, 'fixtures', filePath), 'utf8');
+        return [path.join('/', filePath), contents];
+    } catch (error) {
+        console.error(`Error reading file ${filePath}: ${error}`);
+        return [path.basename(filePath), null]; // Return null for contents if there was an error
+    }
+}
+
+/**
+ * Fetches the contents of multiple files.
+ * @param {string[]} filePaths - An array of file paths.
+ * @returns {Promise<[string, string][]>} A promise that resolves to an array containing the file names and their contents.
+ */
+export function fetchScripts(filePaths) {
+    return Promise.all(filePaths.map(getFileData));
+}
+
+/**
+ * @param {string[]} paths - The path to the example file.
+ * @returns {Promise<[results: any,
+ * errors: import('../src/parsers/script-parser.js').ValidationError[]]>} A promise that resolves to
+ * an array of attribute data.
+ */
+export async function parseAttributes(...paths) {
+    const parser = new JSDocParser();
+    await parser.init();
+    const scriptContents = await fetchScripts([...paths, './playcanvas.d.ts']);
+    parser.updateProgram(scriptContents);
+    return parser.parseAttributes(paths[0]);
+}
+
+export async function getAttributes(...paths) {
+    const parser = new JSDocParser();
+    await parser.init();
+    const scriptContents = await fetchScripts([...paths, './playcanvas.d.ts']);
+    parser.updateProgram(scriptContents);
+    return parser.getAttributes(paths[0]);
+}