Generate example function for TypeScript models

[jonaslagoni]

Reason/Context

In Modelina for TypeScript, you can make it generate the models generate functions that return a basic instance example, this should be possible through the CLI.

To do this I suggest we add a flag called tsExampleInstance as a boolean. If true the generator should include the following options:

  presets: [
    {
      preset: TS_COMMON_PRESET,
      options: {
        example: true
      }
    }
  ]

Which should be added here:

cli/src/commands/generate/models.ts

Line 118 in 438de07

fileGenerator = new TypeScriptFileGenerator({

as the code example shows: https://github.com/asyncapi/modelina/blob/master/examples/typescript-generate-jsonbinpack/index.ts

These will be the generated results: https://github.com/asyncapi/modelina/blob/master/examples/typescript-generate-example/__snapshots__/index.spec.ts.snap

Remember to also add a test here:

cli/test/commands/generate/models.test.ts

Line 39 in 438de07

describe('for TypeScript', () => {

Related documentation: https://github.com/asyncapi/modelina/blob/master/docs/languages/TypeScript.md#generate-example-data-function

Feel free to reach out if you have any questions or get stuck!

[bhavyastar]

Hey @jonaslagoni @Souvikns I would like to work on this issue!

[chinma-yyy]

Hey @jonaslagoni , I was working on this issue and I have almost completed it but when I added the test script for the functionality it gives an error

for every toEqual it is giving this error what should I do? Earlier it used to work fine.

[jonaslagoni]

Try add the PR as a draft PR so we can see the changes @chinma-yyy 🙂

[asyncapi-bot]

🎉 This issue has been resolved in version 0.51.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀