https://github.com/koenvzeijl/AspNetCore.SassCompiler
Sass Compiler Library for .NET Core 3.1/5.x/6.x/7.x without node, using dart-sass as a compiler
https://github.com/koenvzeijl/AspNetCore.SassCompiler
asp-net-core aspnetcore blazor csharp dotnet sass scss
Last synced: 15 days ago
JSON representation
Sass Compiler Library for .NET Core 3.1/5.x/6.x/7.x without node, using dart-sass as a compiler
- Host: GitHub
- URL: https://github.com/koenvzeijl/AspNetCore.SassCompiler
- Owner: koenvzeijl
- License: mit
- Created: 2021-06-07T18:47:37.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-04T07:42:10.000Z (6 months ago)
- Last Synced: 2024-11-04T08:28:48.651Z (6 months ago)
- Topics: asp-net-core, aspnetcore, blazor, csharp, dotnet, sass, scss
- Language: C#
- Homepage: https://www.nuget.org/packages/AspNetCore.SassCompiler/
- Size: 551 MB
- Stars: 215
- Watchers: 11
- Forks: 26
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AspNetCore.SassCompiler
[](https://www.nuget.org/packages/AspNetCore.SassCompiler/)
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:
```shell
# 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
When Source is a file, the .css filepath where to save the css file |
| Arguments | "--error-css" | Arguments passed to the dart-sass executable. see [here](https://sass-lang.com/documentation/cli/dart-sass/) for available arguments. |
| 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
appsettings.json
```json
{
"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"
}
}
}
}
```
sasscompiler.json
```json
{
"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"
}
}
}
```
## Sass watcher
To use the Sass watcher in your project, you must add the following code to your startup.cs:
```csharp
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](https://github.com/koenvzeijl/AspNetCore.SassCompiler/issues/44) 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.
## Compiling SCSS at runtime
It is also possible to compile SCSS files at runtime by using the `ISassCompiler` interface. By default however, the
sass executables are not included in a Release build. To make be able to use the `ISassCompiler` interface in production
you need to add the following property to your csproj file: `true`.
If you don't want to use the hosted service to automatically compile your scss files during development, but do want to
have the `ISassCompiler` available, you can use the `AddSassCompilerCore()` method instead of the `AddSassCompiler()`
method on the `IServiceCollection`. This will register what is required to use the `ISassCompiler` interface without
registering the hosted service.
## 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](https://github.com/koenvzeijl/AspNetCore.SassCompiler/tree/master/Samples/AspNetCore.SassCompiler.Sample)
[Blazor Server](https://github.com/koenvzeijl/AspNetCore.SassCompiler/tree/master/Samples/AspNetCore.SassCompiler.BlazorSample)
[Blazor WASM](https://github.com/koenvzeijl/AspNetCore.SassCompiler/tree/master/Samples/AspNetCore.SassCompiler.BlazorWasmSample)
[Razor Class Library](https://github.com/koenvzeijl/AspNetCore.SassCompiler/tree/master/Samples/AspNetCore.SassCompiler.RazorClassLibrary)