Skip to content
This repository has been archived by the owner on Feb 13, 2019. It is now read-only.

goals and related generators

Jump to bottom
Seth Reid edited this page Oct 11, 2016 · 5 revisions

High level goals of generator-aspnet

  • Provide a first class experience to command line users to get started with new projects and files for ASP.NET 5
  • Ship a new version on the same day as ASP.NET Core runtime builds are released
  • Enable the community to drive changes in ASP.NET Core Visual Studio templates

We believe that the generator-aspnet generators should provide the equivalent experience as to what is available in Visual Studio 2015. That way users can be sure that when they start with generator-aspnet that they are getting high quality templates and can share with Visual Studio users in a seamless fashion. Also users of both Visual Studio and yo aspnet should be able to follow the same tutorials.

Since the goal of generator-aspnet is to be equivalent to Visual Studio we should not try and shove in additional generators that strays far beyond what Visual Studio offers out of the box. Instead of this we believe that we should enable the creation of additional generators which can bring in such behavior. What we can do is to create a "family of generators" which users can discover and use to get the desired content. I believe that yeoman has been designed in this way as well. There is no reason to try and have one uber generator with all the options under the sky. I'm proposing that we create generators using the naming convention generator-aspnet-<name> for ASP.NET generators to make it easy to discover related generators. We can also promote related generators in this repository and potentially on omnisharp.net. There is plenty of precendent here as well, just take a look at the search results on npm for generator-angular

Related generators can live anywhere. In some cases it will make sense to add them to the OmniSharp organization and in other cases in other repositories. If you've developed a related generator and you feel that it should be in the OmniSharp org please contact me and we can discuss it.

We have already added a section, related generators to the wiki home page. The only generator listed there is currently generator-csharp. generator-csharp doesn't meet the naming convention described above because they are not specific to ASP.NET. The goals for generator-csharp will be similar to generator-aspnet and have related generators with the naming convention generator-csharp-*.

If you are interested in creating a new related generator but you do not know where to start please reach out to Sayed Ibrahim Hashimi and he will help you get started.

Clone this wiki locally