View Source DartSass (dart_sass v0.5.1)

DartSass is a installer and runner for Sass.

Profiles

You can define multiple configuration profiles. By default, there is a profile called :default which you can configure its args, current directory and environment:

config :dart_sass,
  version: "1.54.5",
  default: [
    args: ~w(css/app.scss ../priv/static/assets/app.css),
    cd: Path.expand("../assets", __DIR__)
  ]

Dart Sass configuration

There are two global configurations for the dart_sass application:

  • :version - the expected Sass version.

  • :path - the path to the Sass executable. By default it is automatically downloaded and placed inside the _build directory of your current app. Note that if your system architecture requires a separate Dart VM executable to run, then :path should be defined as a list of absolute paths.

Overriding the :path is not recommended, as we will automatically download and manage sass for you. But in case you can't download it (for example, the GitHub releases are behind a proxy), you may want to set the :path to a configurable system location.

For instance, you can install sass globally with npm:

$ npm install -g sass

Then the executable will be at:

NPM_ROOT/sass/sass.js

Where NPM_ROOT is the result of npm root -g.

Once you find the location of the executable, you can store it in a MIX_SASS_PATH environment variable, which you can then read in your configuration file:

config :dart_sass, path: System.get_env("MIX_SASS_PATH")

Link to this section Summary

Functions

Returns the path to the sass executable.

Returns the version of the Sass executable (or snapshot).

Returns the configuration for the given profile.

Returns the configured Sass version.

Installs dart-sass with configured_version/0.

Installs, if not available, and then runs sass.

Runs the given command with args.

Link to this section Functions

Returns the path to the sass executable.

Depending on your system target architecture, the path may be preceeded by the path to the Dart VM executable.

Returns the version of the Sass executable (or snapshot).

Returns {:ok, version_string} on success or :error when the executable is not available.

Returns the configuration for the given profile.

Returns nil if the profile does not exist.

Returns the configured Sass version.

Installs dart-sass with configured_version/0.

Link to this function

install_and_run(profile, args)

View Source

Installs, if not available, and then runs sass.

Returns the same as run/2.

Link to this function

run(profile, extra_args)

View Source

Runs the given command with args.

The given args will be appended to the configured args. The task output will be streamed directly to stdio. It returns the status of the underlying call.