deanwiseman / DartSassBuilder

Sass builder (dart compiler) for .NET projects
MIT License
30 stars 11 forks source link

DartSassBuilder

A dart-compiled version of LibSassBuilder, using DartSassHost

Build NuGet Package .NET Global Tool Downloads
Build Nuget .NET Tool NuGet Downloads

Nuget Package

DartSassBuilder NuGet package adds a build task to compile Sass files to .css. It's compatible with both MSBuild (VS) and dotnet build.

No configuration is required, it will compile the files implicitly on project build.

<PropertyGroup>
  <!-- outputstyle option -->
  <DartSassOutputStyle>compressed</DartSassOutputStyle>
  <DartSassOutputStyle Condition="'$(Configuration)' == 'Debug'">expanded</DartSassOutputStyle>
  <!-- level option -->
  <DartSassOutputLevel>verbose</DartSassOutputLevel>
  <!-- msbuild output level -->
  <DartSassMessageLevel>High</DartSassMessageLevel>
</PropertyGroup>
<PropertyGroup>
  <!-- take full-control -->
  <EnableDefaultSassItems>false</EnableDefaultSassItems>
</PropertyGroup>

<ItemGroup>
  <!-- add files manually -->
  <SassFile Include="Vendor/**/*.scss" />
  <SassFile Include="Styles/**/*.scss" Exclude="Styles/unused/**" />
</ItemGroup>
<PropertyGroup>
  <!-- Take even more full-control -->
  <DartSassBuilderArgs>directory "$(MSBuildProjectDirectory)"</DartSassBuilderArgs>
  <!-- msbuild output level -->
  <DartSassMessageLevel>High</DartSassMessageLevel>
</PropertyGroup>

.NET Global Tool

Install:

dotnet tool install --global DartSassBuilder

Use:

dsb [optional-path] [options]
dsb help
dsb help directory
dsb help files

Generic options

-l, --level      Specify the level of output (silent, default, verbose)

--outputstyle    Specify the style of output (compressed, compact, nested, expanded)

Directory command (default)

Scans a directory recursively to generate .css files

-e, --exclude    (Default: bin obj logs node_modules) Specify explicit directories to exclude. Overrides the default.

--help           Display this help screen.

--version        Display version information.

value pos. 0     Directory in which to run. Defaults to current directory.

Example:

dsb directory
dsb directory sources/styles -e node_modules
dsb directory sources/styles -e node_modules -l verbose

Files in the following directories are excluded by default:

Files command (default)

Processes the files given on the commandline

--help           Display this help screen.

--version        Display version information.

value pos. 0     File(s) to process.

Example:

dsb files sources/style/a.scss sources/vendor/b.scss
dsb files sources/style/a.scss sources/vendor/b.scss -l verbose

Requirements

DartSassBuilder can be installed on any project, however the underlying build tool requires .NET 8 installed on the machine.

Support

The support is largely dependant on DartSassHost

This tool contains the following supporting packages:

Package as nuget package

./package.ps1 -PackageDir 'C:/LocalPackages' -Version '1.4.0.1'