AspNetCore.SassCompiler 1.71.1.1

dotnet add package AspNetCore.SassCompiler --version 1.71.1.1
NuGet\Install-Package AspNetCore.SassCompiler -Version 1.71.1.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="AspNetCore.SassCompiler" Version="1.71.1.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add AspNetCore.SassCompiler --version 1.71.1.1
#r "nuget: AspNetCore.SassCompiler, 1.71.1.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install AspNetCore.SassCompiler as a Cake Addin
#addin nuget:?package=AspNetCore.SassCompiler&version=1.71.1.1

// Install AspNetCore.SassCompiler as a Cake Tool
#tool nuget:?package=AspNetCore.SassCompiler&version=1.71.1.1

AspNetCore.SassCompiler

NuGet Version

Sass Compiler Library for .NET 6 and above, without node.

Installation

The installation of this package is quite simple, you can install this package using NuGet with the following command:

# Package Manager
PM> Install-Package AspNetCore.SassCompiler

# .NET CLI
dotnet add package AspNetCore.SassCompiler

Configuration

After adding the package, the Sass styles from the Source (defaults to: Styles) will automatically be compiled into .css files in the TargetFolder (defaults to: wwwroot\css) on build. You can also adjust the default configuration in the appsettings.json or sasscompiler.json, do note that when using appsettings.json the configuration needs to be nested under a "SassCompiler" property, but when you're using sasscompiler.json the settings should not be nested.

Available options

Name Default value Description
Source "Styles" The folder where all the .scss files reside, or an scss file
Target "wwwroot/css" When Source is a folder, the folder to output the generated .css files to<br/>When Source is a file, the .css filepath where to save the css file
Arguments "--error-css" Arguments passed to the dart-sass executable
GenerateScopedCss true Enable/disable support for scoped scss
ScopedCssFolders ["Views", "Pages", "Shared", "Components"] The folders in which .scss files are considered for scoped css
IncludePaths [] Add folders to search in when importing modules
Compilations [] A list of source/target pairs that should be compiled. These will be added to the default Source and Target configured above.
Configurations {} Add configuration to override specific options based on the build conifguration (e.g. Debug/Release)

Examples

<details open> <summary>appsettings.json</summary>

{
  "SassCompiler": {
    "Source": "Styles",
    "Target": "wwwroot/css",
    "Arguments": "--style=compressed",
    "GenerateScopedCss": true,
    "ScopedCssFolders": ["Views", "Pages", "Shared", "Components"],
    "IncludePaths": [],
    
    "Compilations": [
      // Specify a specific file source/target in addition to the "Styles" -> "wwwroot/css" Source/Target above
      { "Source":  "wwwroot/scss/site.scss", "Target":  "wwwroot/css/site.min.css" },
      // Or an extra directory to a different target directory
      { "Source":  "Lib/Styles", "Target":  "wwwroot/lib/css" }
    ],

    // You can override specific options based on the build configuration
    "Configurations": {
      "Debug": { // These options apply only to Debug builds
        "Arguments": "--style=expanded"
      }
    }
  }
}

</details>

<details> <summary>sasscompiler.json</summary>

{
  "Source": "Styles",
  "Target": "wwwroot/css",
  "Arguments": "--style=compressed",
  "GenerateScopedCss": true,
  "ScopedCssFolders": ["Views", "Pages", "Shared", "Components"],
  "IncludePaths": [],

  "Compilations": [
    // Specify a specific file source/target in addition to the "Styles" -> "wwwroot/css" Source/Target above
    { "Source":  "wwwroot/scss/site.scss", "Target":  "wwwroot/css/site.min.css" },
    // Or an extra directory to a different target directory
    { "Source":  "Lib/Styles", "Target":  "wwwroot/lib/css" }
  ],
  
  // You can override specific options based on the build configuration
  "Configurations": {
    "Debug": { // These options apply only to Debug builds
      "Arguments": "--style=expanded"
    }
  }
}

</details>

Sass watcher

To use the Sass watcher in your project, you must add the following code to your startup.cs:

public void ConfigureServices(IServiceCollection services) 
{
  
#if DEBUG
  services.AddSassCompiler();
#endif

}

We recommend adding the #if DEBUG statement to only use a watcher during debug mode.

Note: The Sass watcher is currently not supported inside of a docker container. This should only be an issue when you're developing inside of a docker container, running the published application in docker is supported as the compiler is automatically run during the MSBuild publish step. See this issue for the progress.

Blazor WASM

If you use this with Blazor WebAssembly and want to customize the settings you need to use the sasscompiler.json, using appsettings.json is not supported. The sass watcher is currently not supported for Blazor WebAssembly projects, the MSBuild task is still available and will compile your scss during build and publish.

Publish

This library also includes an MSBuild task that runs during the publish of your application. Because of this you don't need to include the Sass Watcher in your release builds and you can safely add the generated .css files to the .gitignore file as they are regenerated during publish.

Alpine linux

If you're publishing your application inside an alpine linux container, you will need to install gcompat (using apk add gcompat) before running dotnet build or dotnet publish. This is needed because the dart runtime which is what the sass compiler uses requires this package on alpine linux.

Examples

Take a look at one of our examples on how it can be integrated in your project. We've created example projects for ASP.NET Core MVC, Blazor Server/Wasm and RazorClassLibrary projects.

MVC

Blazor Server

Blazor WASM

Razor Class Library

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (15)

Showing the top 5 NuGet packages that depend on AspNetCore.SassCompiler:

Package Downloads
Enter.Ui

Package Description

ThePensionsRegulator.GovUk.Frontend

Based on the GOV.UK Design System and GovUk.Frontend.AspNetCore. Adds extra features and components.

ThePensionsRegulator.GovUk.Frontend.Umbraco

GOV.UK Design System components implemented using the block list editor in Umbraco, and classes used to build applications based on these components.

Nowy.BlazorUI.Layout

Package Description

LR.BlazorUI.Layout

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.71.1.1 383 3/1/2024
1.71.1 1,635 2/24/2024
1.71.0 1,660 2/16/2024
1.70.0 9,532 1/18/2024
1.69.7 6,085 1/3/2024
1.69.5 35,257 10/26/2023
1.69.3 8,744 10/12/2023
1.69.2 645 10/11/2023
1.69.1 897 10/10/2023
1.68.0 11,377 9/21/2023
1.67.0 2,249 9/15/2023
1.66.0 17,872 8/18/2023
1.64.2 6,061 8/1/2023
1.64.1 2,268 7/22/2023
1.64.0 2,459 7/20/2023
1.63.6 36,838 6/22/2023
1.63.5 4,009 6/21/2023
1.63.3 6,182 6/12/2023
1.63.2 542 6/8/2023
1.62.1 34,253 4/26/2023
1.61.0 12,732 4/7/2023
1.60.0 3,694 3/25/2023
1.59.3 3,075 3/16/2023
1.58.1 22,141 2/15/2023
1.58.0 5,945 2/1/2023
1.57.1 16,508 12/20/2022
1.56.2 1,657 12/9/2022
1.56.1 7,231 11/21/2022
1.55.0 14,808 9/22/2022
1.54.9 2,659 9/8/2022
1.54.8 1,877 9/1/2022
1.54.6 642 8/30/2022
1.54.5.1 3,426 8/22/2022
1.54.5 1,531 8/21/2022
1.54.4.1 2,512 8/16/2022
1.54.4 1,047 8/11/2022
1.54.3 2,050 8/5/2022
1.54.1 879 8/3/2022
1.54.0 6,042 7/23/2022
1.53.0 8,490 7/1/2022
1.52.3 2,855 6/9/2022
1.52.2 1,434 6/3/2022
1.52.1.2 2,278 5/26/2022
1.52.1.1 1,151 5/23/2022
1.52.1 1,872 5/21/2022
1.52.0 509 5/20/2022
1.51.0.4 1,402 5/9/2022
1.51.0.3 643 5/5/2022
1.51.0.2 716 5/3/2022
1.51.0.1 6,140 5/2/2022
1.51.0 11,614 4/26/2022
1.50.1 869 4/19/2022
1.50.0.1 1,264 4/11/2022
1.50.0 1,535 4/7/2022
1.49.11 501 4/6/2022
1.49.9 4,837 2/25/2022
1.49.8 885 2/19/2022
1.49.7 2,441 2/3/2022
1.49.4 1,056 2/1/2022
1.49.0 1,048 1/19/2022
1.48.0 604 1/13/2022
1.47.0 876 1/10/2022
1.45.2 2,820 12/31/2021
1.45.1 1,046 12/21/2021
1.45.0.1 313 12/19/2021
1.45.0 809 12/11/2021
1.44.0.1 342 12/10/2021
1.43.5 2,990 11/25/2021
1.43.4 1,074 10/27/2021
1.43.3 465 10/22/2021
1.43.2 578 10/14/2021
1.43.1 533 10/6/2021
1.42.1.1 509 9/29/2021
1.42.1 406 9/22/2021
1.42.0 357 9/21/2021
1.41.1 378 9/17/2021
1.41.0 350 9/15/2021
1.40.0 337 9/14/2021
1.39.2 431 9/10/2021
1.39.0 393 9/9/2021
1.0.4 2,126 8/12/2021
1.0.3 424 6/22/2021
1.0.2 451 6/17/2021
1.0.1 363 6/15/2021
1.0.0 348 6/14/2021
0.1.0 511 6/10/2021