sass-site/source/dart-sass.md
Jonny Gerig Meyer 653009b9e6
Merge branch 'main' of github.com:sass/sass-site
* 'main' of github.com:sass/sass-site:
  Properly include code examples in bullet points (#721)
  Freshen Dart Sass page (#720)
  Cut a release for a new Dart Sass version
  Document the deprecation of multiple variable flags (#716)
2023-04-14 10:38:20 -04:00

3.2 KiB

layout title no_container introduction
has_no_sidebars Dart Sass true Dart Sass is the primary implementation of Sass, which means it gets new features before any other implementation. It's fast, easy to install, and it compiles to pure JavaScript which makes it easy to integrate into modern web development workflows. Find out more or help out with its development on [GitHub](https://github.com/sass/dart-sass).

Command Line

Dart Sass's stand-alone command-line executable uses the blazing-fast Dart VM to compile your stylesheets. To install Dart Sass on the command line, check out the installation instructions. Once you've got it running, you can use it compile files:

sass source/index.scss css/index.css

See sass --help for additional information on the command-line interface.

Dart Library

You can also use Dart Sass as a Dart library to get the speed of the Dart VM plus the ability to define your own functions and importers. To add it to an existing project:

  1. Install the Dart SDK. Make sure its bin directory is on your PATH.

  2. Create a pubspec.yaml file like this:

name: my_project
dev_dependencies:
  sass: ^{{ releases['dart-sass'].version }}
  1. Run dart pub get.

  2. Create a compile-sass.dart file like this:

import 'dart:io';
import 'package:sass/sass.dart' as sass;

void main(List<String> arguments) {
  var result = sass.compileToResult(arguments[0]);
  new File(arguments[1]).writeAsStringSync(result.css);
}
  1. You can now use this to compile files:
dart compile-sass.dart styles.scss styles.css
  1. Learn more about writing Dart code (it's easy!) and about Sass's Dart API.

JavaScript Library

Dart Sass is also distributed as the pure JavaScript sass package on npm. The pure JS version is slower than the stand-alone executable, but it's easy to integrate into existing workflows and it allows you to define custom functions and importers in JavaScript. You can add it to your project using npm install --save-dev sass and require() it as a library:

const sass = require('sass');

const result = sass.compile('style.scss');
console.log(result.css);

// OR

const result = await sass.compileAsync('style.scss');
console.log(result.css);

When installed via npm, Dart Sass supports a brand new JavaScript API, as well as a legacy API that's fully compatible with the old Node Sass API. Note that when using the sass asdf package, the synchronous API functions are more than twice as fast as the asynchronous API, due to the overhead of asynchronous callbacks.