Citizen17.DartSass
2.2.0
See the version list below for details.
dotnet add package Citizen17.DartSass --version 2.2.0
NuGet\Install-Package Citizen17.DartSass -Version 2.2.0
<PackageReference Include="Citizen17.DartSass" Version="2.2.0" />
paket add Citizen17.DartSass --version 2.2.0
#r "nuget: Citizen17.DartSass, 2.2.0"
// Install Citizen17.DartSass as a Cake Addin #addin nuget:?package=Citizen17.DartSass&version=2.2.0 // Install Citizen17.DartSass as a Cake Tool #tool nuget:?package=Citizen17.DartSass&version=2.2.0
Citizen17.DartSass
Library for compiling SASS using Dart Sass runtime.
Install
Install package using NuGet.
Runtime
By default package doesn't contain Dart Sass runtime. It can use installed in system Dart Sass or you can one of packages with runtime:
- DartSass.Native.win-x64
- DartSass.Native.win-x86
- DartSass.Native.linux-x64
- DartSass.Native.linux-arm64
- DartSass.Native.linux-arm
- DartSass.Native.linux-x86
- DartSass.Native.linux-musl-x64
- DartSass.Native.linux-musl-arm64
- DartSass.Native.linux-musl-arm
- DartSass.Native.linux-musl-x86
- DartSass.Native.macos-x64
- DartSass.Native.macos-arm64
- DartSass.Native.android-x64
- DartSass.Native.android-arm64
- DartSass.Native.android-arm
- DartSass.Native.android-x86
Note: My library cannot detect is android device or linux musl. You must provide path to compiller for these platforms. Example:
var compiler = new DartSassCompiller(Path.Combine(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location), "./dart-sass.android-x64/sass"));
Usage
Create DartSassCompiller
instance.
using Citizen17.DartSass;
var compiler = new DartSassCompiller();
When instance creates it try find Dart Sass runtime. First it search in project. If not found it try search in system using environmen variable PATH
.
If you have dedicated Dart Sass runtime you can pass it as parameter to constructor.
var compiler = new DartSassCompiller("/path/to/sass/executable");
Options
You can set default options that will be used on evert compile.
compiler.CompileOptions = new SassCompileOptions
{
StyleType = StyleType.Expanded,
EmitCharset = true,
Update = false,
ImportPaths = new List<string>
{
"/path/to/imports1",
"/path/to/imports2"
},
GenerateSourceMap = true,
SourceMapUrlType = SourceMapUrlType.Relative,
EmbedSources = false,
EmbedSourceMap = false,
Quiet = false,
QuietDeps = false
};
Also every compile method can accept options. If options passed they override defaults.
Compile from file
Use CompileAsync
method to get compiled code from file source.
SassCodeCompilationResult result = await compiler.CompileAsync("/path/to/source.scss");
string code = result.Code;
Compile from code
Use CompileCodeAsync
method to get compiled code from string source.
var sourceSassCode = ".some-class { color: red; }";
SassCodeCompilationResult result = await compiler.CompileCodeAsync(sourceSassCode);
string code = result.Code;
Compile from file to file
Use CompileToFileAsync
method to compile source SASS file to CSS.
SassFilesCompilationResult result = await compiler.CompileToFileAsync("/path/to/source/source.scss");
IEnumerable<string> files = result.Files;
Result file: /path/to/source/source.css
and /path/to/source/source.css.map
if Source maps enabled.
Also you can pass custom name for output file.
SassFilesCompilationResult result = await compiler.CompileToFileAsync("/path/to/source/source.scss", "dest.css");
IEnumerable<string> files = result.Files;
Result file: /path/to/source/dest.css
and /path/to/source/dest.css.map
if Source maps enabled.
SassFilesCompilationResult result = await compiler.CompileToFileAsync("/path/to/source/source.scss", "/path/to/dest/dest.css");
IEnumerable<string> files = result.Files;
Result file: /path/to/dest/dest.css
and /path/to/dest/dest.css.map
if Source maps enabled.
Compile multiple files
Use CompileToFilesAsync
method to compile multiple files.
It has 2 overload.
First accept list of strings with source files.
var sourceFiles = new string[]
{
"path/to/source1.sass",
"path/to/source2.sass"
};
SassFilesCompilationResult result = await compiler.CompileToFilesAsync(sourceFiles);
IEnumerable<string> files = result.Files;
All output files will be placed near it source file. Or you can pass additional parameter to specify output directory.
SassFilesCompilationResult result = await compiler.CompileToFilesAsync(sourceFiles, "/path/to/dest");
IEnumerable<string> files = result.Files;
Second accept dictionary where key is source file and value is output file.
var sourceFiles = new Dictionaty<string, string>
{
{ "path/to/source.sass", "dest.css" }, // Will be placed near source file
{ "path/to/source2.sass", "path/to/dest2.css" },
{ "path/to/source3.sass", null } // Will be generated source3.css file and placed near source file
{ "path/to/source4.sass", "path/to/dest/" } // Will be generated source4.css file and placed in path/to/dest/
}
SassFilesCompilationResult result = await compiler.CompileToFilesAsync(sourceFiles);
IEnumerable<string> files = result.Files;
Also you can pass as second parameter output directory and all files without reletive or ablsolute path will be placed in that directory
Messages
If output contains some Warnings, Deprecation Warnings or Debug messages they are will be presented in result.
SassCodeCompilationResult result = await compiler.CompileAsync("/path/to/source.scss");
string code = result.Code;
// Warnings
IEnumerable<SassMessage> warnings = result.Warnings;
foreach (var warning in warnings) {
string message = warning.Message;
string stackTrace = warning.StackTrace;
string rawMessage = warning.RawMessage;
}
// Deprecation warnings
IEnumerable<SassDeprecationWarning> deprecationWarnings = result.DeprecationWarnings;
foreach (var deprecationWarning in deprecationWarnings) {
string message = deprecationWarning.Message;
// Recomendation from Sass
string recomendation = deprecationWarning.Recommendation;
string stackTrace = deprecationWarning.StackTrace;
string rawMessage = deprecationWarning.RawMessage;
}
// Debug
IEnumerable<SassMessage> debugMessages = result.Debug;
foreach (var debugMessage in debugMessages) {
string message = debugMessage.Message;
string stackTrace = debugMessage.StackTrace;
string rawMessage = debugMessage.RawMessage;
}
Errors
If compilation fails with errors it throws SassCompileException
. It contains next properties:
string RawOutput
IEnumerable<SassMessage> Errors
IEnumerable<SassMessage> Warnings
IEnumerable<SassDeprecationWarning> DeprecationWarnings
IEnumerable<SassMessage> Debug
Version
Also you can get version of used Dart Sass runtime.
var version = await compiler.GetVersionAsync();
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 is compatible. 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 is compatible. 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. |
-
net5.0
- No dependencies.
-
net6.0
- No dependencies.
-
net8.0
- No dependencies.
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Citizen17.DartSass:
Package | Downloads |
---|---|
BootstrapEmail.Net
Bootstrap stylesheet, compiler, and inliner for responsive and consistent emails with the Bootstrap syntax you know and love. |
GitHub repositories
This package is not used by any popular GitHub repositories.
v 1.1.0:
* Added support of Linux Arm64 and MacOS arm64
* Added support of -q flag
v 2.0.0:
* Fixed problem with incorrect output when compiling to code
* Changed result of all methods. See Readme
* Added parsing warnings, deprecation warnings, debug messages
* Fixed parsing errors
v 2.1.0
* Added support for 32-bit ARM Linux package
v 2.2.0
* Now Dart Sass compiler searches in directories relative to execution assembly
* Added .NET 8 target