
Security News
ECMAScript 2025 Finalized with Iterator Helpers, Set Methods, RegExp.escape, and More
ECMAScript 2025 introduces Iterator Helpers, Set methods, JSON modules, and more in its latest spec update approved by Ecma in June 2025.
@playcanvas/attribute-parser
Advanced tools
This is the official JSDoc attribute parser used in the PlayCanvas Editor.
It collects metadata from user scripts by parsing @attribute
JSDoc annotations. These attributes enable the PlayCanvas Editor to expose UI controls and contextual information for your script properties.
Example
Given a script like this:
class Rotator extends ScriptType {
/**
* @attribute
* Speed determines how fast to rotate things
*/
speed = new Vec3();
/**
* @attribute
* An array of Entities to rotate
*
* @type {Entity[]}
*/
thingsToRotate;
}
The parser outputs:
{
"rotator": {
"attributes": {
"speed": {
"type": "vec3",
"name": "speed",
"array": false,
"description": "Speed determines how fast to rotate things",
"default": [0, 0, 0]
},
"thingsToRotate": {
"type": "entity",
"name": "thingsToRotate",
"array": true,
"description": "An array of Entities to rotate",
"default": null
}
},
"errors": []
}
}
JSDocs tags are parsed and values and outputs the metadata in a serializable format.
// Initialise the parser
// Initialize the parser
const parser = new JSDocParser();
await parser.init();
// Load your source files: {[filename: string]: string}[]
const scripts = await fetchScripts([...paths, './playcanvas.d.ts']);
// Update the parser program
parser.updateProgram(scripts);
// Parse attributes from the entry point
const [attributes, errors] = parser.parseAttributes("./index.js");
See the test fixtures for examples of supported JSDoc tags and output formats.
This project includes good test coverage for all supported tag formats and edge cases.
FAQs
The PlayCanvas Attribute Parser
The npm package @playcanvas/attribute-parser receives a total of 24 weekly downloads. As such, @playcanvas/attribute-parser popularity was classified as not popular.
We found that @playcanvas/attribute-parser demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ECMAScript 2025 introduces Iterator Helpers, Set methods, JSON modules, and more in its latest spec update approved by Ecma in June 2025.
Security News
A new Node.js homepage button linking to paid support for EOL versions has sparked a heated discussion among contributors and the wider community.
Research
North Korean threat actors linked to the Contagious Interview campaign return with 35 new malicious npm packages using a stealthy multi-stage malware loader.