Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@playcanvas/attribute-parser

Package Overview
Dependencies
Maintainers
0
Versions
12
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@playcanvas/attribute-parser

This the official JSDoc attribute parser used in the PlayCanvas editor.

  • 1.0.5
  • npm
  • Socket score

Version published
Weekly downloads
4
decreased by-97.69%
Maintainers
0
Weekly downloads
 
Created
Source

PlayCanvas Attribute Parser

This the official JSDoc attribute parser used in the PlayCanvas editor.

It's used in the PlayCanvas Editor to collect metadata from jsdoc annotated users scripts. This allows special @attribute members which can surface contextual data about class members.

A quick examples

It takes 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
}

and turns it into the following data ...

{
    "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.

Usage

// Initialise the parser
const parser = new JSDocParser();
await parser.init();

// fetch your program source {[filename: string, contents: string][]}
const scripts = await fetchScripts([...paths, './playcanvas.d.ts']);

// update the progam
parser.updateProgram(scripts)

// Parse the program, starting from the first path
const [attribute, errors] parser.parseAttributes("./index.js");

Attribute structure

You can learn more about the special tags available here

Tests

We provide good coverage

FAQs

Package last updated on 16 Aug 2024

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc