Yeoman generator for ASP.NET Core projects
- Dependencies:
- Node.js:
brew install nodefor Mac OS X,choco install nodejsfor Windows OS - Yeoman:
npm install -g yo - Bower
npm install -g bower
- Node.js:
- Install:
npm install -g generator-aspnet - Run:
yo aspnet
See also: Building Projects with Yeoman on docs.asp.net
NOTE: Starting from RTM release
Web ApplicationandWeb Application Basicproject templates useBundler Minifiertool instead of NPM based build systems like Gulp or Grunt. The Bundler tool is installed as part of tooling support for the project, theproject.jsoncontains relevant scripting integration and one can use that tool independently from console using itsCLIinterface. Visit Bundler tool WIKI for details.
Also see ASP NET Community Standup - June 21st, 2016 - Mads Visits for detailed information about this change introduction.
-
yo aspnetshows a wizard for generating a new ASP.NET Core app -
yo aspnet --helpshows flags and other configurable options
Full, template based projects available in generator:
- Empty Web Application
- Console Application
- Web Application
- Web Application Basic [without Membership and Authorization]
- Web API Application
- Nancy ASP.NET Application
- Class Library
- Unit Test project (xUnit.net)
The Empty Web Application, Console Application, Web Application, Web Application Basic (a.k.a. Web Application No Auth), Web API Application and Class Library are based on the templates introduced with Visual Studio 2015. They are available and maintained in the ASP.NET Templates project.
ASP.NET Templates project provides templates which are used in Visual Studio for creating ASP.NET Core applications.
NOTE: Starting from
RC2dotnetrelease the web application template project no longer ships with built-in EF migration. For this reason you should calldotnet ef database updateto scaffold database using template provided migrations!
The Nancy project is based on framework's "Hello World" template: Nancy Getting Started: Introduction
The Docker support with Dockerfile configuration files is based on the official Docker image for ASP.NET 5
The Unit test project uses xUnit: a free, open source, community-focused unit testing tool for the .NET Framework
The templates that use client side libraries are calling bower install script to install Bower managed dependencies. You can skip installation process by passign --skip-install option to generator, e.g. yo aspnet --skip-install. This should allow better experience when Development has been enabled.
The project type and application name can be specified as optional command line arguments:
yo aspnet [projecttype [applicationname] [uiframework]]
The valid project types are:
emptywebfor Empty Web Applicationconsoleappfor Console Applicationwebfor Web Applicationwebbasicfor Web Application Basicwebapifor Web API Applicationnancyfor Nancy ASP.NET Applicationclasslibraryfor Class LibraryunittestUnit Test project (xUnit.net)
The valid UI framework types are:
bootstrapfor Bootstrap (this is the default and does not have to be specified explicitly)semanticfor Semantic UI
Example:
yo aspnet webbasic "my semantic app" semanticwill create a "Web Application Basic" project called "my semantic app" using the Semantic UI framework.
Example:
yo aspnet webbasic "my bootstrap app"ORyo aspnet webbasic "my bootstrap app" bootstrapwill create a "Web Application Basic" project called "my bootstrap app" using the Bootstrap framework.
The goal of generator-aspnet is to provide an experience consistent with creating new ASP.NET Core dotnet cli projects
and files in Visual Studio 2015.
The list of related generators can be seen on our Wiki section
The alphabetic list of available sub generators (to create files after the project has been created):
- aspnet:angularcontroller
- aspnet:angularcontrolleras
- aspnet:angulardirective
- aspnet:angularfactory
- aspnet:angularmodule
- aspnet:appsettings
- aspnet:bowerjson
- aspnet:class
- aspnet:coffeescript
- aspnet:dockerfile
- aspnet:gitignore
- aspnet:gruntfile
- aspnet:gulpfile
- aspnet:htmlpage
- aspnet:interface
- aspnet:javascript
- aspnet:json
- aspnet:jsonschema
- aspnet:jsx
- aspnet:middleware
- aspnet:mvccontroller
- aspnet:mvcview
- aspnet:nuget
- aspnet:packagejson
- aspnet:program
- aspnet:readme
- aspnet:startup
- aspnet:stylesheet
- aspnet:stylesheetless
- aspnet:stylesheetscss
- aspnet:taghelper
- aspnet:textfile
- aspnet:tfignore
- aspnet:typescript
- aspnet:typescriptconfig
- aspnet:typescriptjsx
- aspnet:usersecrets
- aspnet:webapicontroller
** Note: files generated are created in the working directory, no conventions are forced **
Creates AngularJS controller file using $scope
Example:
yo aspnet:angularcontroller filename
Produces filename.js
Creates AngularJS controller file using Controller As syntax.
Example:
yo aspnet:angularcontrolleras filename
Produces filename.js
Creates AngularJS directive file.
Example:
yo aspnet:angulardirective filename
Produces filename.js
Creates AngularJS factory file.
Example:
yo aspnet:angularfactory filename
Produces filename.js
Creates AngularJS module file
Example:
yo aspnet:angularmodule filename
Produces filename.js
Creates a new appsettings.json file
Example:
yo aspnet:appsettings
Produces appsettings.json
Creates a new bower.json and configuration file.
Example:
yo aspnet:bowerjson
Produces bower.json and .bowerrc
Creates a new ASP.NET Core class
Example:
yo aspnet:class Contact
Produces /Contact.cs
Creates a new CoffeeScript file
Example:
yo aspnet:coffeescript filename
Produces filename.coffee
Creates a new Docker configuration file.
To create Docker image with SQLite support for EntityFramework use --sqlite option
Example:
yo aspnet:dockerfile
Creates a new Dockerfile
Are you curious about Docker, Linux containers and ASP.NET Core Docker image and all these buzz words?
- Docker image for ASP.NET 5 (Docker Hub)
- Running ASP.NET 5 applications in Linux Containers with Docker (MSDN)
- ASP.NET 5 : Continuous Integration with Travis-CI, Tutum, Docker, Webhooks and Azure [Advanced]
- ASP.NET 5 on Docker talk at NDC {London} by Mark Rendle
Creates a new .gitignore file
Example:
yo aspnet:gitignore
Produces .gitignore
Creates a new Grunt file
Example:
yo aspnet:gruntfile
Produces Gruntfile.js
Creates a new Gulp file
Example:
yo aspnet:gulpfile
Produces gulpfile.js
Creates a new HTML file
Example:
yo aspnet:htmlpage filename
Produces filename.html
Creates a new ASP.NET Core interface
Example:
yo aspnet:interface IContact
Produces /IContact.cs
Creates a new JavaScript file
Example:
yo aspnet:javascript filename
Produces filename.js
Creates a new JSON file
Example:
yo aspnet:json filename
Produces filename.json
Creates a new JSON schema file
Example:
yo aspnet:jsonschema filename
Produces filename.json
Creates a new React JSX file
Example:
yo aspnet:jsx filename
Produces filename.jsx
Creates a new C# middleware class file
Example:
yo aspnet:middleware filename
Produces filename.cs
Creates a new ASP.NET Core MvcController class
Example:
yo aspnet:mvccontroller ContactController
Produces /ContactController.cs
Read more about MVC Controllers on docs.asp.net
Creates a new ASP.NET Core MvcView page file
Example:
yo aspnet:mvcview ContactView
Produces /ContactView.cshtml
Read more about MVC Views on docs.asp.net
Creates a new NuGet.config file. The support for unstable development
feed is provided by --unstable option.
Example:
yo aspnet:nuget --unstable
Produces NuGet.config with unstable NuGet feed
Creates a new package.json file
Example:
yo aspnet:packagejson
Produces package.json
Creates a new Program.cs file
Example:
yo aspnet:program
Produces Program.cs
Creates a new REAMDE.md documentation file in Markdown format
You can optionally pass --txt option to use .txt extension.
Example:
yo aspnet:readme [--txt]
Produces readme.md
Creates a new Startup.cs file
Example:
yo aspnet:startup
Produces Startup.cs
Creates a new CSS file
Example:
yo aspnet:stylesheet style
Produces style.css
Creates a new Less class file
Example:
yo aspnet:stylesheetless filename
Produces filename.less
Creates a new Sass SCSS class file
Example:
yo aspnet:stylesheetscss filename
Produces filename.scss
Creates a new TagHelper class file
Example:
yo aspnet:taghelper filename
Produces filename.cs
Creates a new Text file
Example:
yo aspnet:textfile filename
Produces filename.txt
Creates a new .tfignore file
Example:
yo aspnet:tfignore
Produces .tfignore
Creates a new TypeScript file
Example:
yo aspnet:typescript filename
Produces filename.ts
Creates a new TypeScript configuration file
Example:
yo aspnet:typescriptconfig
Produces tsconfig.json
Creates a new JSX-enabled TypeScript file
Example:
yo aspnet:typescriptjsx filename
Produces filename.tsx
Adds UserSecrets information to ASP.NET Core project.json file.
The generator do not update existing keys if found and does
not create new project.json file.
Example:
yo aspnet:usersecrets
This will add following keys to project.json:
- "userSecretsId" key
- "Microsoft.Extensions.Configuration.UserSecrets" key under "dependencies"
Creates a new ASP.NET Core WebApiController class
Example:
yo aspnet:webapicontroller ValuesController
Produces /ValuesController.cs
Read more about Web API MVC concepts on docs.asp.net
Copyright 2014-2016 OmniSharp
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.