@blok-codes/fame-ts

Convert typescript metamodel from json to an api

• Usage
• Commands

Usage

$ git clone https://github.com/blok-codes/-blok-codes-fame-ts.git
$ cd path/to/-blok-codes-fame-ts
$ yarn install && yarn build

$ node ./bin/run COMMAND
running command...

$ node ./bin/run (--version)
@blok-codes/fame-ts/1.0.0 linux-x64 node-v16.7.0

$ node ./bin/run --help [COMMAND]
USAGE
  $ fame-ts COMMAND
...

Alternative usage

$ npm install -g @blok-codes/fame-ts

$ fame-ts COMMAND
running command...

$ fame-ts (--version)
@blok-codes/fame-ts/1.0.0 linux-x64 node-v16.7.0

$ fame-ts --help [COMMAND]
USAGE
  $ fame-ts COMMAND
...

Commands

• fame-ts generate [OPTIONS]
• fame-ts update [OPTIONS]
• fame-ts autocomplete [SHELL]
• fame-ts help [COMMAND]

fame-ts generate [OPTIONS]

update the typescript metamodel interface

USAGE
  $ node ./bin/run generate [OPTIONS]
  $ fame-ts generate [OPTIONS]

ARGUMENTS
  OPTIONS  (api) which option to generate (the generation will use the last updated metamodel)

DESCRIPTION
  Generate an api from the typescript metamodel interface

EXAMPLES
  $ node ./bin/run update generate api
  $ fame-ts update generate api

See code: generate command

fame-ts update [OPTIONS]

update the typescript metamodel interface

Updating the metamodel and the interface only have an effect if the application is rebuilt.
Consider pulling the latest version from the repository to do so.

USAGE
  $ node ./bin/run update [OPTIONS] -s <value>
  $ fame-ts update [OPTIONS] -s <value>

ARGUMENTS
  OPTIONS  (interface|metamodel) which option to update (updating the metamodel will update the interface as well)

FLAGS
  -s, --source=<value>  (required) path to the typescript metamodel from metamodel json file

DESCRIPTION
  Update the typescript metamodel interface

EXAMPLES
  $ node ./bin/run update metamodel -s path/to/(metamodel).json
  $ fame-ts update metamodel -s path/to/(metamodel).json

  $ node ./bin/run update metamodel --source path/to/(metamodel).json
  $ fame-ts update metamodel --source path/to/(metamodel).json

  $ node ./bin/run update interface
  $ fame-ts update interface

See code: update command

fame-ts autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ node ./bin/run autocomplete [SHELL] [-r]
  $ fame-ts autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  shell type

FLAGS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

DESCRIPTION
  display autocomplete installation instructions

EXAMPLES
  $ node ./bin/run autocomplete
  $ fame-ts autocomplete

  $ node ./bin/run autocomplete bash
  $ fame-ts autocomplete bash

  $ node ./bin/run autocomplete zsh
  $ fame-ts autocomplete zsh

  $ node ./bin/run autocomplete --refresh-cache
  $ fame-ts autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

fame-ts help [COMMAND]

Display help for fame-ts.

USAGE
  $ node ./bin/run help [COMMAND] [-n]
  $ fame-ts help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for fame-ts.

See code: @oclif/plugin-help

Known Issues

See issues