Skip to content

Commit

Permalink
Update typespec-structure-guidelines.md (Azure#23527)
Browse files Browse the repository at this point in the history
Adding note to copy tspconfig.yaml from sample project. We found that user doesn't have right tspconfig.yaml in the spec PR.
  • Loading branch information
raych1 authored and JoshLove-msft committed Apr 25, 2023
1 parent ea66796 commit 838b4ad
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion documentation/typespec-structure-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Each package should have the following minimum structure:

Authors may use folders as desired for organizing tsp files.

To distinguish between folders which define a service, an SDK, or both, one can look to the `tspconfig.yaml` which should only have SDK configuration data for for projects that wish to generate SDKs.
To distinguish between folders which define a service, an SDK, or both, one can look to the `tspconfig.yaml` which should only have SDK configuration data for for projects that wish to generate SDKs. Please copy it from [sample project](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml) as a template.

- Services should **not** have a `package.json` directly in the TypeSpec project directory as they all should be using the `package.json` in the root director of the repo for installing any dependencies needed.
- The root level `package.json` will only depend on the `@azure-tools/typespec-autorest` and `@azure-tools/typespec-apiview` emitters.
Expand Down

0 comments on commit 838b4ad

Please sign in to comment.