Nihilist Pocket Monsters

    jsduck2jsx

    0.1.1 • Public • Published

    jsduck2jsx

    Synopsis

    Generate JSX wrapper from JSDuck output files.

    Motivation

    It generates JSX wrapper from existing code. If your code using jsduck to generate document, you can use your module from JSX easily.

    Installation

    It needs JSDuck to generate JSON style output.

    $ gem jsduck
    $ npm install jsduck2jsx

    Usage

    Sencha Touch

    $ jsduck --export=full --output st_jsonout touch-2.3.0/src/
    $ node_modules/.bin/jsduck2jsx -o sencha-touch.jsx -f "Ext*" -i js/web.jsx -t /node_modules/jsduck2jsx/share/senchatouch_type.json st_jsonout

    You can use following shortcut. Resulting file will be in the lib folder:

    # Use pregenerated JSON 
    $ node_modules/.bin/jsduck2jsx --sencha-touch
    # Use your own JSON 
    $ node_modules/.bin/jsduck2jsx --sencha-touch st_jsonout

    Ext.js

    $ jsduck --export=full --output ej_jsonout ext-4.2.1/src/
    $ node_modules/.bin/jsduck2jsx -o ext.jsx -f "Ext*" -i js/web.jsx -t /node_modules/jsduck2jsx/share/extjs_type.json ej_jsonout

    You can use following shortcut. Resulting file will be in the lib folder:

    # Use pregenerated JSON 
    $ node_modules/.bin/jsduck2jsx --extjs
    # Use your own JSON 
    $ node_modules/.bin/jsduck2jsx --extjs st_jsonout

    Options

    • -o filepath, --output=filepath

      Output JSX file path

    • -f filter, --filter=filter

      File name filter

    • -i modulepath, --import=modulepath

      Additional needed JSX module.

    • -t jsonpath, --type=jsonpath

      Additional type information.

    • -h, --help

      Display help

    Shortcut

    • --sencha-touch
    • --extjs

    Development

    Repository

    Run Test

    $ grunt test

    Build

    # Build application or library for JS project 
    $ grunt build
     
    # Generate API reference 
    $ grunt doc
     

    Author

    License

    MIT

    Complete license is written in LICENSE.md.

    Keywords

    none

    Install

    npm i jsduck2jsx

    DownloadsWeekly Downloads

    4

    Version

    0.1.1

    License

    MIT

    Last publish

    Collaborators

    • shibu