yaml-scene-extension

A template for yaml-scene extension

How to use

Run the below command to setup project

  npm run setup

Implementation

Create a element implement IElement.
Example Translator

  import { IElement } from "yaml-scene/src/elements/IElement"

  export default class YourExtension implements IElement { 
    // Proxy object which provides some utils functions (logger...)
    proxy?: ElementProxy<any>

    // Init properties from yaml to object
    init?(props: any){}

    // Prepare data, replace data value before executing
    prepare?(){}

    // Execute main flow
    exec(){}

    // After executed done need dispose object
    dispose?(){}

    // Clone new object in loop or template...
    clone?(){}
  }

Write document

This project template support auto generate document base on comment line in code.

1. Write extension information. Learn more

   /**
     * @group
     * @name yaml-scene-extension/Translator
     * @description Translate hello text to vietnamese
     * @group Extension
     * @order 
     * @example
   - yaml-scene-extension/Translator:
       text: hello
       var: result
   - Echo: ${result}
     * @end
     */
   export class Translator implements IElement { ... }

2. Run command to generate to guideline document

  npm run doc

3. A file GUIDE.md will be generate to root folder

Test extension via jest

The project use jest to test project.

1. Write testing files to test/.
2. There are 2 options to run test
   • Only test

       npm test

   • Test & Debug

       npm run test:debug

Test extension via yaml-scene

The project allow inject extension into yaml-scene global.

1. Create a scenario file at scenes/test/your_extension.yaml
2. Register your extension to yaml-scene

   extensions:
     - ../../dist/src/Your_Extension        # Register a new extension

3. Call your extension

     - Your_Extension:
         prop1: hello
         prop2: vi
         var: yourVar

4. Run test

     yas scenes/test/your_extension.yaml