JSPM

  • Created
  • Published
  • Downloads 10
  • Score
    100M100P100Q58945F
  • License MIT

Code generation for message, service, and database.

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@selfage/generator_cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    @seflage/generator_cli

    Install

    npm install @selfage/generator_cli

    Overview

    Written in TypeScript and compiled to ES6 with inline source map & source. See @selfage/tsconfig for full compiler options. Provides a CLI to generate TypeScript code based on definitions written in JSON. See commander if you are not sure about CLI syntax.

    It can generate messages, web/node service client and hanlder, and GCP Spanner database. Generated code would require corresponding runtime lib to run, which can be installed separately.

    CLI

    $ geneage -h
    Usage: geneage [options] <definitionFile>
    
    Generate various TypeScript codes from the definition file written in JSON.
    
    Options:
      -V, --version                 output the version number
      -i, --index-file <indexFile>  The index yaml file for Google Cloud Datastore composite index. Its file ext can be neglected and is always fixed as .yaml. Requried only if
                                    your definition file includes a datastore definition. You can also add '"datastoreIndex": "./your/index_file"' to your package.json file to
                                    save typings.
      --dry-run                     Print the generated content instead of writing it to the destination file.
      -h, --help                    display help for command

    Examples

    All code generation examples can be found under test_data/generator/ directory.