Gathering detailed insights and metrics for sass
As of June 2024, the npm registry hosts over 2 million packages, making it one of the largest open-source software repositories in the world.
Gathering detailed insights and metrics for sass
As of June 2024, the npm registry hosts over 2 million packages, making it one of the largest open-source software repositories in the world.
npm install sass
60.4
Supply Chain
100
Quality
96.9
Maintenance
100
Vulnerability
3,967 Stars
2,580 Commits
357 Forks
74 Watching
25 Branches
75 Contributors
Updated on 13 Nov 2024
Minified
Minified + Gzipped
Dart (86.06%)
TypeScript (13.8%)
JavaScript (0.11%)
HTML (0.02%)
Shell (0.01%)
Cumulative downloads
Total Downloads
Last day
1.8%
2,895,479
Compared to previous day
Last week
6.8%
14,846,533
Compared to previous week
Last month
9.9%
64,069,448
Compared to previous month
Last year
16%
686,781,192
Compared to previous year
3
1
A Dart implementation of Sass. Sass makes CSS fun.
|
|
There are a few different ways to install and run Dart Sass, depending on your environment and your needs.
If you use the Chocolatey package manager or the Scoop package manager for Windows, you can install Dart Sass by running
1choco install sass
or
1scoop install sass
That'll give you a sass
executable on your command line that will run Dart
Sass. See the CLI docs for details.
If you use the Homebrew package manager, you can install Dart Sass by running
1brew install sass/sass/sass
That'll give you a sass
executable on your command line that will run Dart
Sass.
You can download the standalone Dart Sass archive for your operating
system—containing the Dart VM and the snapshot of the executable—from the
GitHub release page. Extract it, add the directory to your path, restart
your terminal, and the sass
executable is ready to run!
Dart Sass is available, compiled to JavaScript, as an npm package. You
can install it globally using npm install -g sass
which will provide access to
the sass
executable. You can also add it to your project using
npm install --save-dev sass
. This provides the executable as well as a
library:
1const sass = require('sass'); 2 3const result = sass.compile(scssFilename); 4 5// OR 6 7// Note that `compileAsync()` is substantially slower than `compile()`. 8const result = await sass.compileAsync(scssFilename);
See the Sass website for full API documentation.
The sass
npm package can also be run directly in the browser. It's compatible
with all major web bundlers as long as you disable renaming (such as
--keep-names
in esbuild). You can also import it directly from a browser as
an ECMAScript Module without any bundling (assuming node_modules
is served as
well):
1<script type="importmap"> 2 { 3 "imports": { 4 "immutable": "./node_modules/immutable/dist/immutable.es.js", 5 "sass": "./node_modules/sass/sass.default.js" 6 } 7 } 8</script> 9 10<!-- Support browsers like Safari 16.3 without import maps support. --> 11<script async src="https://unpkg.com/es-module-shims@^1.7.0" crossorigin="anonymous"></script> 12 13<script type="module"> 14 import * as sass from 'sass'; 15 16 console.log(sass.compileString(` 17 .box { 18 width: 10px + 15px; 19 } 20 `)); 21</script>
Or from a CDN:
1<script type="importmap"> 2 { 3 "imports": { 4 "immutable": "https://unpkg.com/immutable@^4.0.0", 5 "sass": "https://unpkg.com/sass@^1.63.0/sass.default.js" 6 } 7 } 8</script> 9 10<!-- Support browsers like Safari 16.3 without import maps support. --> 11<script async src="https://unpkg.com/es-module-shims@^1.7.0" crossorigin="anonymous"></script> 12 13<script type="module"> 14 import * as sass from 'sass'; 15 16 console.log(sass.compileString(` 17 .box { 18 width: 10px + 15px; 19 } 20 `)); 21</script>
Or even bundled with all its dependencies:
1<script type="module"> 2 import * as sass from 'https://jspm.dev/sass'; 3 4 console.log(sass.compileString(` 5 .box { 6 width: 10px + 15px; 7 } 8 `)); 9</script>
Since the browser doesn't have access to the filesystem, the compile()
and
compileAsync()
functions aren't available for it. If you want to load other
files, you'll need to pass a custom importer to compileString()
or
compileStringAsync()
. The legacy API is also not supported in the browser.
Dart Sass also supports an older JavaScript API that's fully compatible with
Node Sass (with a few exceptions listed below), with support for both the
render()
and renderSync()
functions. This API is considered deprecated
and will be removed in Dart Sass 2.0.0, so it should be avoided in new projects.
Sass's support for the legacy JavaScript API has the following limitations:
Only the "expanded"
and "compressed"
values of outputStyle
are
supported.
Dart Sass doesn't support the precision
option. Dart Sass defaults to a
sufficiently high precision for all existing browsers, and making this
customizable would make the code substantially less efficient.
Dart Sass doesn't support the sourceComments
option. Source maps are the
recommended way of locating the origin of generated selectors.
If you're using Jest to run your tests, be aware that it has a longstanding
bug where its default test environment breaks JavaScript's built-in
instanceof
operator. Dart Sass's JS package uses instanceof
fairly
heavily, so in order to avoid breaking Sass you'll need to install
jest-environment-node-single-context
and add testEnvironment: 'jest-environment-node-single-context'
to your Jest config.
If you're a Dart user, you can install Dart Sass globally using pub global activate sass
, which will provide a sass
executable. You can also add it to
your pubspec and use it as a library. We strongly recommend importing it with
the prefix sass
:
1import 'package:sass/sass.dart' as sass; 2 3void main(List<String> args) { 4 print(sass.compile(args.first)); 5}
See the Dart API docs for details.
sass_api
PackageDart users also have access to more in-depth APIs via the sass_api
package.
This provides access to the Sass AST and APIs for resolving Sass loads without
running a full compilation. It's separated out into its own package so that it
can increase its version number independently of the main sass
package.
Assuming you've already checked out this repository:
Install Dart. If you download an archive
manually rather than using an installer, make sure the SDK's bin
directory
is on your PATH
.
Install Buf. This is used to build the protocol buffers for the embedded compiler.
In this repository, run dart pub get
. This will install Dart Sass's
dependencies.
Run dart run grinder protobuf
. This will download and build the embedded
protocol definition.
Run dart bin/sass.dart path/to/file.scss
.
That's it!
You can install and run Dart Sass within Docker using the following Dockerfile commands:
1# Dart stage 2FROM bufbuild/buf AS buf 3FROM dart:stable AS dart 4 5# Add your scss files 6COPY --from=another_stage /app /app 7 8# Include Protocol Buffer binary 9COPY --from=buf /usr/local/bin/buf /usr/local/bin/ 10 11WORKDIR /dart-sass 12RUN git clone https://github.com/sass/dart-sass.git . && \ 13 dart pub get && \ 14 dart run grinder protobuf 15# This is where you run sass.dart on your scss file(s) 16RUN dart ./bin/sass.dart /app/sass/example.scss /app/public/css/example.css
Dart Sass has replaced Ruby Sass as the canonical implementation of the Sass language. We chose Dart because it presented a number of advantages:
It's fast. The Dart VM is highly optimized, and getting faster all the time
(for the latest performance numbers, see perf.md
). It's much faster
than Ruby, and close to par with C++.
It's portable. The Dart VM has no external dependencies and can compile applications into standalone snapshot files, so we can distribute Dart Sass as only three files (the VM, the snapshot, and a wrapper script). Dart can also be compiled to JavaScript, which makes it easy to distribute Sass through npm, which the majority of our users use already.
It's easy to write. Dart is a higher-level language than C++, which means it doesn't require lots of hassle with memory management and build systems. It's also statically typed, which makes it easier to confidently make large refactors than with Ruby.
It's friendlier to contributors. Dart is substantially easier to learn than Ruby, and many Sass users in Google in particular are already familiar with it. More contributors translates to faster, more consistent development.
For the most part, Dart Sass follows semantic versioning. We consider all of the following to be part of the versioned API:
Because Dart Sass has a single version that's shared across the Dart, JavaScript, and standalone distributions, this may mean that we increment the major version number when there are in fact no breaking changes for one or more distributions. However, we will attempt to limit the number of breaking changes we make and group them in as few releases as possible to minimize churn. We strongly encourage users to use the changelog for a full understanding of all the changes in each release.
There is one exception where breaking changes may be made outside of a major version revision. It is occasionally the case that CSS adds a feature that's incompatible with existing Sass syntax in some way. Because Sass is committed to full CSS compatibility, we occasionally need to break compatibility with old Sass code in order to remain compatible with CSS.
In these cases, we will first release a version of Sass that emits deprecation warnings for any stylesheets whose behavior will change. Then, at least three months after the release of a version with these deprecation warnings, we will release a minor version with the breaking change to the Sass language semantics.
In general, we consider any change to Dart Sass's CSS output that would cause that CSS to stop working in a real browser to be a breaking change. However, there are some cases where such a change would have substantial benefits and would only negatively affect a small minority of rarely-used browsers. We don't want to have to block such a change on a major version release.
As such, if a change would break compatibility with less than 2% of the global market share of browser according to StatCounter GlobalStats, we may release a minor version of Dart Sass with that change.
We consider dropping support for a given version of Node.js to be a breaking change as long as that version is still supported by Node.js. This means that releases listed as Current, Active LTS, or Maintenance LTS according to the Node.js release page. Once a Node.js version is out of LTS, Dart Sass considers itself free to break support if necessary.
Changes to the behavior of Sass stylesheets that produce invalid CSS output are not considered breaking changes. Such changes are almost always necessary when adding support for new CSS features, and delaying all such features until a new major version would be unduly burdensome for most users.
For example, when Sass began parsing calc()
expressions, the invalid
expression calc(1 +)
became a Sass error where before it was passed through
as-is. This was not considered a breaking change, because calc(1 +)
was never
valid CSS to begin with.
Dart Sass includes an implementation of the compiler side of the Embedded Sass protocol. It's designed to be embedded in a host language, which then exposes an API for users to invoke Sass and define custom functions and importers.
sass --embedded
starts the embedded compiler and listens on stdin.sass --embedded --version
prints versionResponse
with id = 0
in JSON and
exits.The --embedded
command-line flag is not available when you install Dart Sass
as an npm package. No other command-line flags are supported with
--embedded
.
There are a few intentional behavioral differences between Dart Sass and Ruby Sass. These are generally places where Ruby Sass has an undesired behavior, and it's substantially easier to implement the correct behavior than it would be to implement compatible behavior. These should all have tracking bugs against Ruby Sass to update the reference behavior.
@extend
only accepts simple selectors, as does the second argument of
selector-extend()
. See issue 1599.
Subject selectors are not supported. See issue 1126.
Pseudo selector arguments are parsed as <declaration-value>
s rather than
having a more limited custom parsing. See issue 2120.
The numeric precision is set to 10. See issue 1122.
The indented syntax parser is more flexible: it doesn't require consistent indentation across the whole document. See issue 2176.
Colors do not support channel-by-channel arithmetic. See issue 2144.
Unitless numbers aren't ==
to unit numbers with the same value. In
addition, map keys follow the same logic as ==
-equality. See
issue 1496.
rgba()
and hsla()
alpha values with percentage units are interpreted as
percentages. Other units are forbidden. See issue 1525.
Too many variable arguments passed to a function is an error. See issue 1408.
Allow @extend
to reach outside a media query if there's an identical
@extend
defined outside that query. This isn't tracked explicitly, because
it'll be irrelevant when issue 1050 is fixed.
Some selector pseudos containing placeholder selectors will be compiled where they wouldn't be in Ruby Sass. This better matches the semantics of the selectors in question, and is more efficient. See issue 2228.
The old-style :property value
syntax is not supported in the indented
syntax. See issue 2245.
The reference combinator is not supported. See issue 303.
Universal selector unification is symmetrical. See issue 2247.
@extend
doesn't produce an error if it matches but fails to unify. See
issue 2250.
Dart Sass currently only supports UTF-8 documents. We'd like to support more, but Dart currently doesn't support them. See dart-lang/sdk#11744, for example.
Disclaimer: this is not an official Google product.
No vulnerabilities found.
Reason
all changesets reviewed
Reason
30 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 10
Reason
license file detected
Details
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
branch protection not enabled on development/release branches
Details
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
Reason
project is not fuzzed
Details
Reason
security policy file not detected
Details
Reason
Project has not signed or included provenance with any releases.
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Score
Last Scanned on 2024-11-04
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn Moresass-loader
Sass loader for webpack
postcss-nested
PostCSS plugin to unwrap nested rules like how Sass does it
stylelint
A mighty CSS linter that helps you avoid errors and enforce conventions.
resolve-url-loader
Webpack loader that resolves relative paths in url() statements based on the original source file