@playcanvas/attribute-parser 1.6.1 → 1.7.0

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

@@ -1,54 +0,0 @@
-import { expect } from 'chai';
-import { describe, it, before } from 'mocha';
-
-import { parseAttributes } from '../../utils.js';
-
-describe('VALID: Misc attribute types', function () {
-    let data;
-    before(async function () {
-        data = await parseAttributes('./misc.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 numeric attribute with a title and description', 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('number');
-        expect(data[0].example.attributes.a.array).to.equal(false);
-        expect(data[0].example.attributes.a.default).to.equal(0);
-        expect(data[0].example.attributes.a.title).to.equal('A number');
-        expect(data[0].example.attributes.a.description).to.equal('This is a description of the attribute. It can be multi-sentence.\n\nAnd multi-line too');
-    });
-
-    it('b: should be a numeric attribute with a getter and setter', 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('number');
-        expect(data[0].example.attributes.b.array).to.equal(false);
-        expect(data[0].example.attributes.b.default).to.equal(0);
-    });
-
-    it('c: should not be recognised as an attribute (no attribute tag)', 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/test/tests/valid/numeric.test.js

@@ -1,103 +0,0 @@
-import { expect } from 'chai';
-import { describe, it, before } from 'mocha';
-
-import { parseAttributes } from '../../utils.js';
-
-describe('VALID: Numeric attribute', function () {
-    let data;
-    before(async function () {
-        data = await parseAttributes('./numeric.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 numeric 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('number');
-        expect(data[0].example.attributes.a.array).to.equal(false);
-        expect(data[0].example.attributes.a.default).to.equal(0);
-    });
-
-    it('b: should be a numeric 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('number');
-        expect(data[0].example.attributes.b.array).to.equal(false);
-        expect(data[0].example.attributes.b.default).to.equal(1);
-    });
-
-    it('c: should be a numeric attribute with a precision and step', 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('number');
-        expect(data[0].example.attributes.c.array).to.equal(false);
-        expect(data[0].example.attributes.c.default).to.equal(0);
-        expect(data[0].example.attributes.c.precision).to.equal(2);
-        expect(data[0].example.attributes.c.step).to.equal(0.01);
-    });
-
-    it('d: should be a numeric attribute with a range, precision and step', 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);
-        expect(data[0].example.attributes.d.min).to.equal(0);
-        expect(data[0].example.attributes.d.max).to.equal(1);
-        expect(data[0].example.attributes.d.precision).to.equal(2);
-        expect(data[0].example.attributes.d.step).to.equal(0.01);
-    });
-
-    it('e: should be a numeric attribute array with a size', function () {
-        expect(data[0].example.attributes.e).to.exist;
-        expect(data[0].example.attributes.e.name).to.equal('e');
-        expect(data[0].example.attributes.e.type).to.equal('number');
-        expect(data[0].example.attributes.e.array).to.equal(true);
-        expect(data[0].example.attributes.e.size).to.equal(2);
-        expect(data[0].example.attributes.e.default).equal(null);
-    });
-
-    it('f: should be a numeric attribute in an unusual format', function () {
-        expect(data[0].example.attributes.f).to.exist;
-        expect(data[0].example.attributes.f.name).to.equal('f');
-        expect(data[0].example.attributes.f.type).to.equal('number');
-        expect(data[0].example.attributes.f.array).to.equal(false);
-        expect(data[0].example.attributes.f.default).to.equal(0);
-        expect(data[0].example.attributes.f.min).to.equal(-255);
-        expect(data[0].example.attributes.f.max).to.equal(0);
-        expect(data[0].example.attributes.f.precision).to.equal(2);
-        expect(data[0].example.attributes.f.step).to.equal(0.01);
-    });
-
-    it('g: should be a numeric attribute with single value in range', function () {
-        expect(data[0].example.attributes.g).to.exist;
-        expect(data[0].example.attributes.g.name).to.equal('g');
-        expect(data[0].example.attributes.g.type).to.equal('number');
-        expect(data[0].example.attributes.g.array).to.equal(false);
-        expect(data[0].example.attributes.g.default).to.equal(0);
-        expect(data[0].example.attributes.g.min).to.equal(1);
-        expect(data[0].example.attributes.g.max).to.not.exist;
-    });
-
-    it('h: should be a numeric attribute with empty range', function () {
-        expect(data[0].example.attributes.h).to.exist;
-        expect(data[0].example.attributes.h.name).to.equal('h');
-        expect(data[0].example.attributes.h.type).to.equal('number');
-        expect(data[0].example.attributes.h.array).to.equal(false);
-        expect(data[0].example.attributes.h.default).to.equal(0);
-        expect(data[0].example.attributes.h.min).to.not.exist;
-        expect(data[0].example.attributes.h.max).to.not.exist;
-    });
-
-});

package/test/tests/valid/program.test.js

@@ -1,23 +0,0 @@
-import { expect } from 'chai';
-import { describe, it, before } from 'mocha';
-
-import { parseAttributes } from '../../utils.js';
-
-describe('VALID: Program ', function () {
-    let data;
-    before(async 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].customExample.errors).to.be.empty;
-    });
-});

package/test/tests/valid/text.test.js

@@ -1,58 +0,0 @@
-import { expect } from 'chai';
-import { describe, it, before } from 'mocha';
-
-import { parseAttributes } from '../../utils.js';
-
-describe('VALID: Text attribute', function () {
-    let data;
-    before(async function () {
-        data = await parseAttributes('./text.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 string 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('string');
-        expect(data[0].example.attributes.a.array).to.equal(false);
-        expect(data[0].example.attributes.a.default).to.equal('');
-    });
-
-    it('b: should be a string 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('string');
-        expect(data[0].example.attributes.b.array).to.equal(false);
-        expect(data[0].example.attributes.b.default).to.equal('example');
-    });
-
-    it('c: should be a string attribute with a placeholder', 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('string');
-        expect(data[0].example.attributes.c.array).to.equal(false);
-        expect(data[0].example.attributes.c.default).to.equal('');
-        expect(data[0].example.attributes.c.placeholder).to.equal('Example text');
-    });
-
-    it('d: should be a string attribute array with a size', 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('string');
-        expect(data[0].example.attributes.d.array).to.equal(true);
-        expect(data[0].example.attributes.d.size).to.equal(2);
-        expect(data[0].example.attributes.d.default).equal(null);
-    });
-
-});

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

@@ -1,53 +0,0 @@
-import { expect } from 'chai';
-import { describe, it, before } from 'mocha';
-
-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

@@ -1,54 +0,0 @@
-import fs from 'fs/promises';
-import path, { dirname } from 'path';
-import { fileURLToPath } from 'url';
-
-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]);
-}