Back to Sass

Breaking Change: Default Exports

source/documentation/breaking-changes/default-export.md

latest1.1 KB
Original Source

Historically, Dart Sass was only available as a CommonJS module. This meant that anyone using it from a project that used Node.js's native ECMAScript module support was able to load it as though it provided a default export:

js
import sass from 'sass'; // Don't do this anymore

This was never intended by the Sass team, and it didn't match the type declarations provided with the package, but it did work. We have decided to remove this support in Dart Sass 2.0.0 and require that ECMAScript module users only use the package's named exports:

js
import * as sass from 'sass'; // Do this

Transition Period

{% compatibility 'dart: "1.54.0"', 'libsass: false', 'ruby: false' %}{% endcompatibility %}

Until Dart Sass 2.0.0, we will continue to support users loading Sass's default export. The first time any properties on the default export are accessed, it will emit a deprecation warning to console.error(). To avoid this error, use import * as sass from 'sass' instead.