microsoft / typespec

https://typespec.io/
MIT License
4.36k stars 203 forks source link

Define structure for adding demo / sample projects #3702

Open m-nash opened 3 months ago

m-nash commented 3 months ago

Clear and concise description of the problem

There is a packages/samples but we might want to reorganize this a bit.

Dotnet team would like to provide a sample project which demonstrates how to extend our emitter and provide your own functionality to augment what the base generation does.

For us this would include both a custom emitter and a dotnet plugin to override the generator portion. I imagine the package structure looks similar (but much smaller) to packages/http-client-csharp.

Checklist

timotheeguerin commented 3 months ago

Yeah be good to figure out a good design here. One option is to always have a samples folder for each emitter instead but this reduce discoverability I think.

If we keep samples package as the central exmaples there is a few things to think about: