Compile TypeScript in ASP.NET 5 application using grunt-typescript

Today was a big day for entire .NET Framework community. So much amazing stuff announced on VisualStudio Connect(); even in NY: open sourcing Core .NET Framework code (including CLR, JIT, FC, BLC and more), Visual Studio 2015 Preview with free and extensible Visual Studio Community Edition, new Visual Studio Online features and more. Also quite a few announcements connected to ASP.NET 5. The new version of ASP.NET, known before as ASP.NET vNext, that will revolutionize the way people create Web Applications using .NET Framework stack. Particular feature I’d like to focus on today is great integration with Grunt – JavaScript task runner that can be used to automate routine development tasks, e.g. compiling LESS/SASS files to CSS, CoffeeScript/TypeScript to JavaScript and more.

Official ASP.NET 5 documentation contains a tutorial how to use Grunt to compile LESS files to CSS style sheets on the fly every time you build your app. I’ll should you how to use the same task runner to compile TypeScript code to JavaScript as part of your app build process.

Let’s start with new ASP.NET 5 project created in Visual Studio 2015 Preview using File > New Project > Visual C# > Web > ASP.NET Web Application and selecting “ASP.NET 5.0 Starter Web” from the list of available Web projects.

 

NewProjectAspProjectTypeAs you will probably notice when solution is created folder structure is quite different than what you should know from previous ASP.NET projects. However, I will not focus on describing what’s the role of particular folders and files. You should know that there are two files important for Grunt: gruntfile.js and package.js.

SolutionStructure

But we’ll get to them later. Let’s create TypeScript file we’d like to compile. I’m going to create new directory in the solution called Scripts. It will be place for all TypeScript files in my application. To keep things simple I will create just one file: myApp.ts which will have a simple TypeScript function. Unfortunately TypeScript is not available within New Item dialog. You have to pick different one (e.g. Text File) and manually change file extension to .ts.

AddTypeScriptFile

After doing so you could see new file in solution explorer

myAppFile

Function I’d like to compile to JavaScript is really simple

function longerThan10(value: string): boolean {
    return value.length > 10;
}

OK, back to package.json and gruntfile.js. We’re going to use package.json to import grunt packages that will perform TypeScript compilation. Packages we need are grunt-typescript and typescript and we can add them by modifying package.json file. Visual Studio editor will help you with nice intellisence suggesting correct package name and latest available versions.

PackageJson

Now we have to download the packages using context menu invoked when right clicked on NPM in Solution Explorer and selecting Restore Packages.

RestorePackages

As you’ll notice both packages added to package.json will show up on the list as (not installed). That comment should go away when you restore the packages.

So we have the packages declared and they are successfully added into the solution and restored. Now we have to declare the task that will actually perform necessary compilation. To do that we have to modify gruntfile.js content. There are two thing that needs to be added:

– Package instalation code, at the end of the file
– Package task definition within grunt.initConfig

Final gruntfile.js content should be as follows:

// This file in the main entry point for defining grunt tasks and using grunt plugins.
// Click here to learn more. http://go.microsoft.com/fwlink/?LinkID=513275&clcid=0x409

module.exports = function (grunt) {
    grunt.initConfig({
        bower: {
            install: {
                options: {
                    targetDir: "wwwroot/lib",
                    layout: "byComponent",
                    cleanTargetDir: false
                }
            }
        },
        typescript: {
            base: {
                src: ['Scripts/**/*.ts'],
                dest: 'wwwroot/app.js',
                options: {
                    module: 'amd',
                    target: 'es5'
                }
            }
        },
    });

    // This command registers the default task which will install bower packages into wwwroot/lib
    grunt.registerTask("default", ["bower:install"]);

    // The following line loads the grunt plugins.
    // This line needs to be at the end of this this file.
    grunt.loadNpmTasks("grunt-bower-task");
    grunt.loadNpmTasks("grunt-typescript");
};

Now we can run the task to make sure it does what we want it to do. There is a new window added to Visual Studio called Task Runner Explorer. You can invoke if from
View > Other Windows > Task Runner Explorer. It’s show you all tasks defined in your solution, let you ran them and set bindings to run tasks automatically pre or after build. Right click on typescript and select Run to run the task and compile your TypeScript code to JavaScript.

TaskRunnerExplorerIf you did everything right you should see run results saying  that wwwroot\app.js file was created

RunResults

and new file should show up in Solution Explorer

myAppJs

It will contain our TypeScript function compiled to JavaScript:

function longerThan10(value) {
    return value.length > 10;
}

To make it more natural you can set the task to run every time Build is performed Using BindingsAfter Build option.

PostBuildBindingTo confirm that it works you can either change source in myApp.ts and rebuild – app.js content should change as well. You can also remove app.js. Performing a build should make it appear again.

2 thoughts on “Compile TypeScript in ASP.NET 5 application using grunt-typescript”

Comments are closed.