Added test plan for TypeSpec extension #5552
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
xiaohua899
requested review from
RodgeFu,
bterlson,
markcowl,
allenjzhang and
timotheeguerin
as code owners
microsoft-github-policy-service
bot
added
the
ide
xiaohua899
force-pushed
the
patch-1
branch
2 times, most recently
from
deb90af to
f01671f
Compare
Create image Add files via upload Update create-typespec-project-test-plan.md Create generate-client-code-from-typespec-test-plan.md Add files via upload Update generate-client-code-from-typespec-test-plan.md Create generate-openapi3-from-typespec-test-plan.md Add files via upload Update generate-openapi3-from-typespec-test-plan.md Update generate-openapi3-from-typespec-test-plan.md Create generate-server-stub-from-typespec-test-plan.md Add files via upload Update generate-server-stub-from-typespec-test-plan.md Add files via upload Create import-typespec-from-openapi3-test-plan.md
Update generate-server-stub-from-typespec-test-plan.md Update create-typespec-project-test-plan.md Create typespec-extension-basic-features-test-plan.md Add files via upload Update typespec-extension-basic-features-test-plan.md Update typespec-extension-basic-features-test-plan.md Add files via upload Update create-typespec-project-test-plan.md Update generate-client-code-from-typespec-test-plan.md Update generate-openapi3-from-typespec-test-plan.md Add files via upload Update generate-server-stub-from-typespec-test-plan.md Update import-typespec-from-openapi3-test-plan.md Update create-typespec-project-test-plan.md Update generate-client-code-from-typespec-test-plan.md Update generate-openapi3-from-typespec-test-plan.md Add files via upload Update generate-client-code-from-typespec-test-plan.md Add files via upload Update typespec-extension-basic-features-test-plan.md Update typespec-extension-basic-features-test-plan.md Update generate-client-code-from-typespec-test-plan.md Update generate-openapi3-from-typespec-test-plan.md Update create-typespec-project-test-plan.md Add files via upload Update generate-openapi3-from-typespec-test-plan.md
|
@microsoft-github-policy-service agree company="Microsoft" |
RodgeFu
reviewed
Jan 13, 2025
| * Empty Project | ||
| * Generic REST API | ||
| * TypeSpec Library (with TypeScript) | ||
| * TypeSpec Emitter (with TypeScript) |
There was a problem hiding this comment.
the templates are loaded from compiler which may change when compiler changes. Please run 'tsp init' to get the latest templates as baseline.
RodgeFu
reviewed
Jan 13, 2025
|
|
||
|  | ||
|
|
||
| ### Step 3. Select an empty folder as the root folder for the new TypeSpec project. |
There was a problem hiding this comment.
please also try an non-empty folder which will trigger a confirmation step to confirm with end user about the selected folder
RodgeFu
reviewed
Jan 13, 2025
|
|
||
|  | ||
|
|
||
| ### Step 4. Check if TypeSpec Compiler CLI is install. (optional) |
There was a problem hiding this comment.
There are three path here,
- The compiler has been installed locally (and the local one should be used even when compiler is also installed globally)
- The compiler has been installed globally
- not-installed (which will trigger the compiler installation step).
Please make sure these three path are covered.
RodgeFu
reviewed
Jan 13, 2025
|
|
||
| - For `TypeSpec Emitter (With TypeScript)`, the folder structure. | ||
|
|
||
|  |
There was a problem hiding this comment.
More init template can be configured. Please add one test case for that
- config settings 'initTemplatesUrls' as below
"typespec.initTemplatesUrls": [
{
"name": "Azure",
"url": "https://aka.ms/typespec/azure-init"
}
] - More templates will be loaded from the url and shown in the list like below
RodgeFu
reviewed
Jan 13, 2025
|
|
||
| - #### For Code completion: | ||
|
|
||
| Start typing keywords in the file. |
There was a problem hiding this comment.
please test completion for both tsp file and tspconfig.yaml file.
RodgeFu
reviewed
Jan 13, 2025
|
|
||
| ## Test Steps | ||
|
|
||
| ### Step 1: Install the typespec extension. |
There was a problem hiding this comment.
the user scenario in the spec is out-of-date. You can check the latest UI/User experience at #5451
RodgeFu
reviewed
Jan 13, 2025
|
|
||
|  | ||
|
|
||
| ### Step 4: Select an Emitter Type. |
There was a problem hiding this comment.
the UI will be a little different after Compiler can provide template for default emitters. Will keep you updated.
RodgeFu
reviewed
Jan 13, 2025
| @@ -0,0 +1,102 @@ | |||
| # Generate OpenAPI 3.x from TypeSpec Test Scenario | |||
There was a problem hiding this comment.
I think we can merge the client, server stub and openapi3 user scenario into one, they are basically the same except choosing different emitters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Added six test scenarios test plan to TypeSpec Extension:
@msyyc for notification.