Gathering detailed insights and metrics for gulp-dart-scss
Installations
npm install gulp-dart-scssDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Min. Node Version
>=7
Node Version
12.18.4
NPM Version
6.14.6
Score
60.9
Supply Chain
96.9
Quality
73.8
Maintenance
100
Vulnerability
99.6
License
Releases
2
Contributors
1
Unable to fetch Contributors
Languages
1
JavaScript
JavaScript (100%)
Developer
kasperhesthaven
Download Statistics
Total Downloads
75,050
Last Day
48
Last Week
186
Last Month
652
Last Year
10,011
GitHub Statistics
3 Stars
27 Commits
2 Watching
5 Branches
1 Contributors
Bundle Size
3.00 MB
Minified
668.70 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
1.1.0
Package Id
gulp-dart-scss@1.1.0
Unpacked Size
12.52 kB
Size
5.09 kB
File Count
4
NPM Version
6.14.6
Node Version
12.18.4
Total Downloads
Cumulative downloads
Total Downloads
75,050
Last day
152.6%
48
Compared to previous day
Last week
33.8%
186
Compared to previous week
Last month
29.6%
652
Compared to previous month
Last year
-34.9%
10,011
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
3
Versions
gulp-dart-scss
Gulp plugin to compile Sass (.scss) to CSS using the Dart Sass compiler.
Made to work with latest version of the JavaScript based compiler.
Install
npm i gulp-dart-scss
Usage
1const gulp = require("gulp"); 2const scss = require("gulp-dart-scss"); 3 4export function compileScss() { 5 return gulp 6 .src("./src/main.scss") 7 .pipe( 8 scss({ 9 // Optional option object - See below or sass for API 10 }) 11 ) 12 .pipe(gulp.dest("./dist/css")); 13}
Options
From node-sass
file
- Type:
String - Default:
null
Special: file or data must be specified
Path to a file for [LibSass] to compile.
data
- Type:
String - Default:
null
Special: file or data must be specified
A string to pass to [LibSass] to compile. It is recommended that you use includePaths in conjunction with this so that [LibSass] can find files when using the @import directive.
importer (>= v2.0.0) - experimental
This is an experimental LibSass feature. Use with caution.
- Type:
Function | Function[]signaturefunction(url, prev, done) - Default:
undefined
Function Parameters and Information:
url (String)- the path in import as-is, which [LibSass] encounteredprev (String)- the previously resolved pathdone (Function)- a callback function to invoke on async completion, takes an object literal containingfile (String)- an alternate path for [LibSass] to use ORcontents (String)- the imported contents (for example, read from memory or the file system)
Handles when [LibSass] encounters the @import directive. A custom importer allows extension of the [LibSass] engine in both a synchronous and asynchronous manner. In both cases, the goal is to either return or call done() with an object literal. Depending on the value of the object literal, one of two things will happen.
When returning or calling done() with { file: "String" }, the new file path will be assumed for the @import. It's recommended to be mindful of the value of prev in instances where relative path resolution may be required.
When returning or calling done() with { contents: "String" }, the string value will be used as if the file was read in through an external source.
Starting from v3.0.0:
-
thisrefers to a contextual scope for the immediate run ofsass.renderorsass.renderSync -
importers can return error and LibSass will emit that error in response. For instance:
1done(new Error("doesn't exist!")); 2// or return synchronously 3return new Error("nothing to do here"); -
importer can be an array of functions, which will be called by LibSass in the order of their occurrence in array. This helps user specify special importer for particular kind of path (filesystem, http). If an importer does not want to handle a particular path, it should return
null. See functions section for more details on Sass types.
functions (>= v3.0.0) - experimental
This is an experimental LibSass feature. Use with caution.
functions is an Object that holds a collection of custom functions that may be invoked by the sass files being compiled. They may take zero or more input parameters and must return a value either synchronously (return ...;) or asynchronously (done();). Those parameters will be instances of one of the constructors contained in the require('node-sass').types hash. The return value must be of one of these types as well. See the list of available types below:
types.Number(value [, unit = ""])
getValue()/setValue(value): gets / sets the numerical portion of the numbergetUnit()/setUnit(unit): gets / sets the unit portion of the number
types.String(value)
getValue()/setValue(value): gets / sets the enclosed string
types.Color(r, g, b [, a = 1.0]) or types.Color(argb)
getR()/setR(value): red component (integer from0to255)getG()/setG(value): green component (integer from0to255)getB()/setB(value): blue component (integer from0to255)getA()/setA(value): alpha component (number from0to1.0)
Example:
1var Color = require("node-sass").types.Color, 2 c1 = new Color(255, 0, 0), 3 c2 = new Color(0xff0088cc);
types.Boolean(value)
getValue(): gets the enclosed booleantypes.Boolean.TRUE: Singleton instance oftypes.Booleanthat holds "true"types.Boolean.FALSE: Singleton instance oftypes.Booleanthat holds "false"
types.List(length [, commaSeparator = true])
getValue(index)/setValue(index, value):valuemust itself be an instance of one of the constructors insass.types.getSeparator()/setSeparator(isComma): whether to use commas as a separatorgetLength()
types.Map(length)
getKey(index)/setKey(index, value)getValue(index)/setValue(index, value)getLength()
types.Null()
types.Null.NULL: Singleton instance oftypes.Null.
Example
1sass.renderSync({ 2 data: "#{headings(2,5)} { color: #08c; }", 3 functions: { 4 "headings($from: 0, $to: 6)": function (from, to) { 5 var i, 6 f = from.getValue(), 7 t = to.getValue(), 8 list = new sass.types.List(t - f + 1); 9 10 for (i = f; i <= t; i++) { 11 list.setValue(i - f, new sass.types.String("h" + i)); 12 } 13 14 return list; 15 }, 16 }, 17});
includePaths
- Type:
Array<String> - Default:
[]
An array of paths that [LibSass] can look in to attempt to resolve your @import declarations. When using data, it is recommended that you use this.
indentedSyntax
- Type:
Boolean - Default:
false
true values enable Sass Indented Syntax for parsing the data string or file.
Note: node-sass/libsass will compile a mixed library of scss and indented syntax (.sass) files with the Default setting (false) as long as .sass and .scss extensions are used in filenames.
indentType (>= v3.0.0)
- Type:
String - Default:
space
Used to determine whether to use space or tab character for indentation.
indentWidth (>= v3.0.0)
- Type:
Number - Default:
2 - Maximum:
10
Used to determine the number of spaces or tabs to be used for indentation.
linefeed (>= v3.0.0)
- Type:
String - Default:
lf
Used to determine whether to use cr, crlf, lf or lfcr sequence for line break.
omitSourceMapUrl
- Type:
Boolean - Default:
false
Special: When using this, you should also specify outFile to avoid unexpected behavior.
true values disable the inclusion of source map information in the output file.
outFile
- Type:
String | null - Default:
null
Special: Required when sourceMap is a truthy value
Specify the intended location of the output file. Strongly recommended when outputting source maps so that they can properly refer back to their intended files.
Attention enabling this option will not write the file on disk for you, it's for internal reference purpose only (to generate the map for example).
Example on how to write it on the disk
1sass.render({ 2 ... 3 outFile: yourPathTotheFile, 4 }, function(error, result) { // node-style callback from v3.0.0 onwards 5 if(!error){ 6 // No errors during the compilation, write this result on the disk 7 fs.writeFile(yourPathTotheFile, result.css, function(err){ 8 if(!err){ 9 //file written on disk 10 } 11 }); 12 } 13 }); 14});
outputStyle
- Type:
String - Default:
nested - Values:
nested,expanded,compact,compressed
Determines the output format of the final CSS style.
precision
- Type:
Integer - Default:
5
Used to determine how many digits after the decimal will be allowed. For instance, if you had a decimal number of 1.23456789 and a precision of 5, the result will be 1.23457 in the final CSS.
sourceComments
- Type:
Boolean - Default:
false
true Enables the line number and file where a selector is defined to be emitted into the compiled CSS as a comment. Useful for debugging, especially when using imports and mixins.
sourceMap
- Type:
Boolean | String | undefined - Default:
undefined
Enables source map generation during render and renderSync.
When sourceMap === true, the value of outFile is used as the target output location for the source map with the suffix .map appended. If no outFile is set, sourceMap parameter is ignored.
When typeof sourceMap === "string", the value of sourceMap will be used as the writing location for the file.
sourceMapContents
- Type:
Boolean - Default:
false
true includes the contents in the source map information
sourceMapEmbed
- Type:
Boolean - Default:
false
true embeds the source map as a data URI
sourceMapRoot
- Type:
String - Default:
undefined
the value will be emitted as sourceRoot in the source map information
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
1 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Reason
dependency not pinned by hash detected -- score normalized to 3
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-cd.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/kasperhesthaven/gulp-dart-scss/npm-cd.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-cd.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/kasperhesthaven/gulp-dart-scss/npm-cd.yml/master?enable=pin
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 1 out of 1 npmCommand dependencies pinned
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
Found 0/15 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/npm-cd.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 12 are checked with a SAST tool
Score
3.5
/10
Last Scanned on 2025-01-27
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 More