pehadavid/AspNetCore.ClassicBundles

Bring back bundles to ASP.NET Core

AspNetCore.ClassicBundles - Home

This repository host the source code for AspNetCore.ClassicBundles

Introduction

If you are new to ASP.Net core, you should know that JS & CSS bundles are no more handled by ASP.NET. Instead, you have to use some post-build tasks to create your bundles. Theses NuGet packages allow to create bundles directly in your C# code, like you used to do in MVC 5.x.

What you need to know

AspNetCore.ClassicBundles basically works the same way as MVC 5.x bundles, but there is some differences.

• Unlike System.Web.Optimization, it creates physically files. When you are declaring "~/bundles/my-little-bundle.js", it will create the file on your disk.
• Some functions are not yet implemented, or do not look like the original. You may only use .Include("~/js/my-bundle-without-any-wildcard.js"). Keep an eye on my TODO List to see what features will be backported.

Getting started

You should look at the demo project, but here is the first steps to get it working.

Install NuGet package(s) :

• The first one is mandatory : AspNetCore.ClassicBundles
• The second one is optional : AspNetCore.ClassicBundle.TagHelpers. It will allow you to use some tag helpers instead of @Scripts.Render and @Styles.Render.

Note : latest version support ASP.NET core 3.1 and later.

Configure your BundleCollection on your Startup.cs

 
 public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
{
	...
	app.UseBundles(env,  bundles =>
            {
               

                //If you want to handle min mode manually you can set IsMinMode to true. 
		//By default, resources are minified and bundled when environment is set to production
                bundles.IsMinMode = true;
		//use DontThrowOnMissingFile if you want to ignore missing resources and avoid Exceptions.
		bundles.DontThrowOnMissingFile = true;
                var b1 = bundles.AddAsync(new ScriptBundle("~/js/my-little-bundle.js")
                    .Include("~/lib/jquery/dist/jquery.js")
                    .Include("~/lib/bootstrap/dist/js/bootstrap.js")
                    .Include("~/js/site.js"));

                var b2 = bundles.AddAsync(new StyleBundle("~/css/my-css-bundle.css")
                    .Include("~/lib/bootstrap/dist/css/bootstrap.css"
                        , "~/css/site.css"));

                Task.WaitAll(b1, b2);


            });
	...
}

Now, you can use

@Styles.Render("~/css/my-css-bundle.css") 

and

 @Scripts.Render("~/js/my-little-bundle.js")

If you want to use Asp.Net Core Tag Helpers, you can use

 <vc:script-renderer bundle-path="~/js/my-little-bundle.js" />

And

 <vc:style-renderer bundle-path="~/css/my-css-bundle.css" /> 

TODO

• Linux Hosting Support (fixed in 2.0.1)
• Bundle live update (when a source file is modified on disk, available since 2.0.2)
• Performances improvements
• IncludeDirectory Full Support