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

Support scaffolding scenario in vscode #5294

Merged
merged 29 commits into from
Dec 17, 2024

Conversation

RodgeFu
Copy link
Contributor

@RodgeFu RodgeFu commented Dec 7, 2024

Support scaffolding scenario in vscode whose user experience is like "tsp init". Vscode would collect information from end user and work with compiler to create new TypeSpec project underneath.

fixes: #4859

@RodgeFu RodgeFu added the ide Issues for VS, VSCode, Monaco, etc. label Dec 7, 2024
@azure-sdk
Copy link
Collaborator

azure-sdk commented Dec 7, 2024

All changed packages have been documented.

  • @typespec/compiler
  • typespec-vscode
Show changes

typespec-vscode - feature ✏️

Support "Create TypeSpec Project" in vscode command and EXPLORER when no folder opened,> Add Setting "typespec.initTemplatesUrls" where user can configure additional template to use to create TypeSpec project,> example:,> ,> {,> "typespec.initTemplatesUrls": [,> {,> "name": "displayName",,> "url": "https://urlToTheFileContainsTemplates",> }],,> },> ,> Support "Install TypeSpec Compiler/CLI globally" in vscode command to install TypeSpec compiler globally easily

@typespec/compiler - feature ✏️

Add capacities in TypeSpec Language Server to support "Scaffolding new TypeSpec project" in IDE

@azure-sdk
Copy link
Collaborator

You can try these changes here

🛝 Playground 🌐 Website 📚 Next docs

Copy link
Contributor

@chunyu3 chunyu3 left a comment

Choose a reason for hiding this comment

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

Suggestion to organize the source folder according to the feature:
Define a directory new to store all the code for creating a typespec project,
in the future, there will be another directory emit for code for emitting

@markcowl markcowl changed the title Support scaffolding scenario in vscode [DO NOT MERGE UNTIL RELEASE] Support scaffolding scenario in vscode Dec 10, 2024
@markcowl markcowl changed the title [DO NOT MERGE UNTIL RELEASE] Support scaffolding scenario in vscode Support scaffolding scenario in vscode Dec 11, 2024
@RodgeFu
Copy link
Contributor Author

RodgeFu commented Dec 11, 2024

Suggestion to organize the source folder according to the feature: Define a directory new to store all the code for creating a typespec project, in the future, there will be another directory emit for code for emitting

Usually we will organize source in area with suitable granularity, not feature which can be big, small, without clear boundary and so on. For example, if we group by feature here, you will see lots of folders with only one file in it...
Here I have put all vscode-command related files into one folder (one file supports one command now). For the emit feature you are working on, you can create one file in the folder for the emit command, or a sub-folder if you need add many files there. we can have more detail discussion in your change when it's ready. thx.

@RodgeFu RodgeFu added this pull request to the merge queue Dec 17, 2024
Merged via the queue into microsoft:main with commit 92749b7 Dec 17, 2024
23 checks passed
@RodgeFu RodgeFu deleted the vscode-scaffolding branch December 17, 2024 06:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ide Issues for VS, VSCode, Monaco, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support scaffolding typespec in vscode
4 participants