rollup-plugin-scss - npm Package Compare versions

Comparing version 3.0.0-rc1 to 3.0.0

CHANGELOG.md

@@ -7,3 +7,13 @@ # Changelog
 
+
+## [3.0.0] - 2021-06-29
+
+### Added
+
+- Add insert option @syJSdev
 - Add `sourceMap` option to enable generation of source map @astappiev
+- Add automated testing using Github Actions
+
+### Updated
+
 - A `processor` can receive map as second parameter and return `{ css: string, map?: string }`
@@ -10,0 +20,0 @@ - Remove `node-sass` from optionalDependencies @astappiev <br/>

index.cjs.js

@@ -24,3 +24,57 @@ 'use strict';
                     outFile: dest,
-                    includePaths
+                    includePaths,
+                    importer: (url, prev, done) => {
+                        /* If a path begins with `.`, then it's a local import and this
+                         * importer cannot handle it. This check covers both `.` and
+                         * `..`.
+                         *
+                         * Additionally, if an import path begins with `url` or `http`,
+                         * then it's a remote import, this importer also cannot handle
+                         * that. */
+                        if (url.startsWith('.') ||
+                            url.startsWith('url') ||
+                            url.startsWith('http')) {
+                            /* The importer returns `null` to defer processing the import
+                             * back to the sass compiler. */
+                            return null;
+                        }
+                        /* If the requested path begins with a `~`, we remove it. This
+                         * character is used by webpack-contrib's sass-loader to
+                         * indicate the import is from the node_modules folder. Since
+                         * this is so standard in the JS world, the importer supports
+                         * it, by removing it and ignoring it. */
+                        const cleanUrl = url.startsWith('~')
+                            ? url.replace('~', '')
+                            : url;
+                        /* Now, the importer uses `require.resolve()` to attempt
+                         * to resolve the path to the requested file. In the case
+                         * of a standard node_modules project, this will use Node's
+                         * `require.resolve()`. In the case of a Plug 'n Play project,
+                         * this will use the `require.resolve()` provided by the
+                         * package manager.
+                         *
+                         * This statement is surrounded by a try/catch block because
+                         * if Node or the package manager cannot resolve the requested
+                         * file, they will throw an error, so the importer needs to
+                         * defer to sass, by returning `null`.
+                         *
+                         * The paths property tells `require.resolve()` where to begin
+                         * resolution (i.e. who is requesting the file). */
+                        try {
+                            const resolved = require.resolve(cleanUrl, {
+                                paths: [prefix + scss]
+                            });
+                            /* Since `require.resolve()` will throw an error if a file
+                             * doesn't exist. It's safe to assume the file exists and
+                             * pass it off to the sass compiler. */
+                            return { file: resolved };
+                        }
+                        catch (e) {
+                            /* Just because `require.resolve()` couldn't find the file
+                             * doesn't mean it doesn't exist. It may still be a local
+                             * import that just doesn't list a relative path, so defer
+                             * processing back to sass by returning `null` */
+                            return null;
+                        }
+                    }
                 }, options));
@@ -61,6 +115,3 @@ const css = render.css.toString();
                 if (e.message.includes('sass') && e.message.includes('find module')) {
-                    console.log(green('Solution:\n\t' +
-                        'npm install --save-dev sass' +
-                        '\n\tor\n\t' +
-                        'npm install --save-dev node-sass'));
+                    console.log(green('Solution:\n\t' + 'npm install --save-dev sass'));
                 }
@@ -202,6 +253,6 @@ if (e.message.includes('node-sass') && e.message.includes('bindings')) {
     try {
-        return require('node-sass');
+        return require('sass');
     }
     catch (e) {
-        return require('sass');
+        return require('node-sass');
     }
@@ -208,0 +259,0 @@ }

index.es.js

@@ -22,3 +22,57 @@ import { writeFile, existsSync, mkdirSync } from 'fs';
                     outFile: dest,
-                    includePaths
+                    includePaths,
+                    importer: (url, prev, done) => {
+                        /* If a path begins with `.`, then it's a local import and this
+                         * importer cannot handle it. This check covers both `.` and
+                         * `..`.
+                         *
+                         * Additionally, if an import path begins with `url` or `http`,
+                         * then it's a remote import, this importer also cannot handle
+                         * that. */
+                        if (url.startsWith('.') ||
+                            url.startsWith('url') ||
+                            url.startsWith('http')) {
+                            /* The importer returns `null` to defer processing the import
+                             * back to the sass compiler. */
+                            return null;
+                        }
+                        /* If the requested path begins with a `~`, we remove it. This
+                         * character is used by webpack-contrib's sass-loader to
+                         * indicate the import is from the node_modules folder. Since
+                         * this is so standard in the JS world, the importer supports
+                         * it, by removing it and ignoring it. */
+                        const cleanUrl = url.startsWith('~')
+                            ? url.replace('~', '')
+                            : url;
+                        /* Now, the importer uses `require.resolve()` to attempt
+                         * to resolve the path to the requested file. In the case
+                         * of a standard node_modules project, this will use Node's
+                         * `require.resolve()`. In the case of a Plug 'n Play project,
+                         * this will use the `require.resolve()` provided by the
+                         * package manager.
+                         *
+                         * This statement is surrounded by a try/catch block because
+                         * if Node or the package manager cannot resolve the requested
+                         * file, they will throw an error, so the importer needs to
+                         * defer to sass, by returning `null`.
+                         *
+                         * The paths property tells `require.resolve()` where to begin
+                         * resolution (i.e. who is requesting the file). */
+                        try {
+                            const resolved = require.resolve(cleanUrl, {
+                                paths: [prefix + scss]
+                            });
+                            /* Since `require.resolve()` will throw an error if a file
+                             * doesn't exist. It's safe to assume the file exists and
+                             * pass it off to the sass compiler. */
+                            return { file: resolved };
+                        }
+                        catch (e) {
+                            /* Just because `require.resolve()` couldn't find the file
+                             * doesn't mean it doesn't exist. It may still be a local
+                             * import that just doesn't list a relative path, so defer
+                             * processing back to sass by returning `null` */
+                            return null;
+                        }
+                    }
                 }, options));
@@ -59,6 +113,3 @@ const css = render.css.toString();
                 if (e.message.includes('sass') && e.message.includes('find module')) {
-                    console.log(green('Solution:\n\t' +
-                        'npm install --save-dev sass' +
-                        '\n\tor\n\t' +
-                        'npm install --save-dev node-sass'));
+                    console.log(green('Solution:\n\t' + 'npm install --save-dev sass'));
                 }
@@ -200,6 +251,6 @@ if (e.message.includes('node-sass') && e.message.includes('bindings')) {
     try {
-        return require('node-sass');
+        return require('sass');
     }
     catch (e) {
-        return require('sass');
+        return require('node-sass');
     }
@@ -206,0 +257,0 @@ }

package.json

 {
   "name": "rollup-plugin-scss",
-  "version": "3.0.0-rc1",
+  "version": "3.0.0",
   "description": "Rollup multiple .scss, .sass and .css imports",
@@ -41,2 +41,3 @@ "main": "index.cjs.js",
     "index.cjs.js",
+    "index.d.ts",
     "index.es.js"
@@ -59,3 +60,2 @@ ],
     "sass": "^1.26.3",
-    "tslib": "^2.1.0",
     "typescript": "^4.1.5"
@@ -62,0 +62,0 @@ },

README.md

@@ -22,13 +22,10 @@ # Rollup multiple .scss, .sass and .css imports
 ```
-# v3 needs sass installed seperately
+# v3 needs sass installed seperately (or node-sass)
 npm install --save-dev rollup-plugin-scss@3 sass
 
-# v3 also supports node-sass [(deprecated since Oct. 2020)](https://sass-lang.com/blog/libsass-is-deprecated)
-npm install --save-dev rollup-plugin-scss@3 node-sass
-
-# v2 has node-sass included
+# v2 has node-sass included (with option to use sass)
 npm install --save-dev rollup-plugin-scss@2
 ```
 
-If any of them is installed, it will be used automatically, if both installed `node-sass` will be used.
+If any of them is installed, it will be used automatically, if both installed `sass` will be used.
 
@@ -98,6 +95,6 @@ ## Usage
 
-  // A Sass (node-sass compatible) compiler to use
-  // - node-sass and sass packages are picked up automatically
+  // A Sass (sass compatible) compiler to use
+  // - sass and node-sass packages are picked up automatically
   // - you can use this option to specify custom package (e.g. a fork of one of them)
-  sass: require('sass'),
+  sass: require('node-sass'),
 
@@ -104,0 +101,0 @@ // Run postcss processor before output

New alerts

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

36594

27.17%

Dev dependency count

12

-7.69%

Number of package files

7

16.67%

Lines of code

614

30.92%

Number of low quality alerts

0

-100%

Number of medium supply chain risk alerts

0

-100%

Worsened metrics

Number of lines in readme file

189

-1.56%

Number of low supply chain risk alerts

4

100%

No dependency changes