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

Use Winglang to build Wing SDK resources #4810

Open
eladb opened this issue Nov 6, 2023 · 0 comments · May be fixed by #5427
Open

Use Winglang to build Wing SDK resources #4810

eladb opened this issue Nov 6, 2023 · 0 comments · May be fixed by #5427
Labels
✨ enhancement New feature or request needs-discussion Further discussion is needed prior to impl 🎨 sdk SDK 📜 sdk-spec-impl Appears in the SDK spec roadmap

Comments

@eladb
Copy link
Contributor

eladb commented Nov 6, 2023

Feature Spec

It is now possible to add new classes to the Wing SDK written in winglang by committing them under libs/winglang/sdk or something like this (for example: libs/winglang/sdk/check.w).

These classes will be "merged" into the cloud namespace by the compiler and will seamlessly be available under the cloud builtin module when used from Winglang code. They will look and feel exactly like any other native Wing SDK class.

xxx.md files placed next to these .w files will also be included in the documentation.

NOTE: These classes may reference each other and other SDK classes but SDK classes written in TypeScript won't be able to use these classes.

Use Cases

As winglang matures, it becomes a great option to author new resources in the Wing SDK. For example, the cloud.Check resource is a great example. Another example is the cloud.Workload, which is currently implemented as an external library but should also be part of the Wing SDK.

Implementation Notes

No response

Component

Compiler, SDK

Community Notes

  • Please vote by adding a 👍 reaction to the issue to help us prioritize.
  • If you are interested to work on this issue, please leave a comment.
  • If this issue is labeled needs-discussion, it means the spec has not been finalized yet. Please reach out on the #dev channel in the Wing Slack.
@eladb eladb added ✨ enhancement New feature or request needs-discussion Further discussion is needed prior to impl labels Nov 6, 2023
@staycoolcall911 staycoolcall911 added 🎨 sdk SDK 📜 sdk-spec-impl Appears in the SDK spec roadmap labels Nov 6, 2023
@staycoolcall911 staycoolcall911 added this to the Wing Cloud 1.0 milestone Nov 6, 2023
@Chriscbr Chriscbr self-assigned this Jan 5, 2024
@Chriscbr Chriscbr linked a pull request Jan 5, 2024 that will close this issue
5 tasks
@Chriscbr Chriscbr removed their assignment Mar 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✨ enhancement New feature or request needs-discussion Further discussion is needed prior to impl 🎨 sdk SDK 📜 sdk-spec-impl Appears in the SDK spec roadmap
Projects
Status: 🤝 Backlog - handoff to owners
Development

Successfully merging a pull request may close this issue.

3 participants