Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(cli): improve scaffolding of complex model settings #2843

Merged
merged 1 commit into from
May 7, 2019

Conversation

bajtos
Copy link
Member

@bajtos bajtos commented May 7, 2019

Leverage stringify-object package to convert model settings object into well-formatted TypeScript source code.

An example of a simple settings object:

@model({settings: {strict: false}})
export class MyModel extends Entity {
  // ...
}

A more complex example:

@model({
  settings: {
    annotations: [{destinationClass: 'class1', argument: 0}],
    foreignKeys: {fk_destination: {name: 'fk_destination'}},
    strict: false
  }
})
export class MyModel extends Entity {
  // ...
}

See #2604 /cc @yanamg7

Checklist

👉 Read and sign the CLA (Contributor License Agreement) 👈

  • npm test passes on your machine
  • New tests added or existing tests modified to cover all changes
  • Code conforms with the style guide
  • API Documentation in code was updated
  • Documentation in /docs/site was updated
  • Affected artifact templates in packages/cli were updated
  • Affected example projects in examples/* were updated

👉 Check out how to submit a PR 👈

Copy link
Contributor

@nabdelgadir nabdelgadir left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for improving this 💯

@bajtos bajtos force-pushed the feat/stringify-model-settings branch from 5975e8b to bf360d6 Compare May 7, 2019 15:38
Leverage stringify-object package to convert model settings object
into well-formatted TypeScript source code.

An example of a simple settings object:

    @model({settings: {strict: false}})
    export class MyModel extends Entity {
      // ...
    }

A more complex example:

    @model({
      settings: {
        annotations: [{destinationClass: 'class1', argument: 0}],
        foreignKeys: {fk_destination: {name: 'fk_destination'}},
        strict: false
      }
    })
    export class MyModel extends Entity {
      // ...
    }

Signed-off-by: Miroslav Bajtoš <[email protected]>
Co-Authored-By: yanamg7 <[email protected]>
@bajtos bajtos force-pushed the feat/stringify-model-settings branch from bf360d6 to 68779c6 Compare May 7, 2019 15:44
@bajtos bajtos merged commit 5035c63 into master May 7, 2019
@bajtos bajtos deleted the feat/stringify-model-settings branch May 7, 2019 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants