feat: the sourceMap default value depends on the devtool option (#444)

BREAKING CHANGE: the `sourceMap` default value depends on the `compiler.devtool` option

Author: cap-Bernardito

README.md

@@ -75,6 +75,8 @@
     "postcss-nested": "^4.2.3",
     "postcss-short": "^5.0.0",
     "prettier": "^2.0.5",
+    "sass": "^1.26.10",
+    "sass-loader": "^9.0.3",
     "standard": "^14.3.4",
     "standard-version": "^8.0.2",
     "strip-ansi": "^6.0.0",

package-lock.json

@@ -98,9 +98,14 @@ export default async function loader(content, sourceMap, meta = {}) {
 
   const { parser, syntax, stringifier } = mergedOptions;
 
+  const useSourceMap =
+    typeof options.sourceMap !== 'undefined'
+      ? options.sourceMap
+      : this.sourceMap;
+
   const postcssOptions = {
     from: file,
-    map: options.sourceMap
+    map: useSourceMap
       ? options.sourceMap === 'inline'
         ? { inline: true, annotation: false }
         : { inline: false, annotation: false }
@@ -110,6 +115,11 @@ export default async function loader(content, sourceMap, meta = {}) {
     stringifier,
   };
 
+  if (postcssOptions.map && sourceMap) {
+    postcssOptions.map.prev =
+      typeof sourceMap === 'string' ? JSON.parse(sourceMap) : sourceMap;
+  }
+
   // Loader Exec (Deprecated)
   // https://webpack.js.org/api/loaders/#deprecated-context-properties
   if (postcssOptions.parser === 'postcss-js') {
@@ -157,15 +167,6 @@ export default async function loader(content, sourceMap, meta = {}) {
     content = exec(content, this);
   }
 
-  if (options.sourceMap && typeof sourceMap === 'string') {
-    // eslint-disable-next-line no-param-reassign
-    sourceMap = JSON.parse(sourceMap);
-  }
-
-  if (options.sourceMap && sourceMap) {
-    postcssOptions.map.prev = sourceMap;
-  }
-
   let result;
 
   try {

package.json

@@ -0,0 +1,3 @@
+import style from './style.scss'
+
+export default style

src/index.js

@@ -0,0 +1 @@
+a { color: coral }

test/fixtures/scss/index.js

@@ -34,3 +34,42 @@ exports[`Options Sourcemap should work Sourcemap - {String}: css 1`] = `
 exports[`Options Sourcemap should work Sourcemap - {String}: errors 1`] = `Array []`;
 
 exports[`Options Sourcemap should work Sourcemap - {String}: warnings 1`] = `Array []`;
+
+exports[`Options Sourcemap should work disable Sourcemap - {Boolean}: css 1`] = `
+"a { color: rgba(255, 0, 0, 1.0) }
+"
+`;
+
+exports[`Options Sourcemap should work disable Sourcemap - {Boolean}: errors 1`] = `Array []`;
+
+exports[`Options Sourcemap should work disable Sourcemap - {Boolean}: warnings 1`] = `Array []`;
+
+exports[`Options Sourcemap should work with prev sourceMap: css 1`] = `
+"a {
+  color: coral;
+}"
+`;
+
+exports[`Options Sourcemap should work with prev sourceMap: errors 1`] = `Array []`;
+
+exports[`Options Sourcemap should work with prev sourceMap: map 1`] = `
+Object {
+  "file": "x",
+  "mappings": "AAAA;EAAI,YAAA;ACEJ",
+  "names": Array [],
+  "sources": Array [
+    "xxx",
+    "xxx",
+  ],
+  "sourcesContent": Array [
+    "a { color: coral }
+",
+    "a {
+  color: coral;
+}",
+  ],
+  "version": 3,
+}
+`;
+
+exports[`Options Sourcemap should work with prev sourceMap: warnings 1`] = `Array []`;

test/fixtures/scss/style.scss

@@ -1,3 +1,5 @@
+import path from 'path';
+
 import {
   compile,
   getCompiler,
@@ -23,6 +25,22 @@ describe('Options Sourcemap', () => {
     expect(getErrors(stats)).toMatchSnapshot('errors');
   });
 
+  it('should work disable Sourcemap - {Boolean}', async () => {
+    const compiler = getCompiler(
+      './css/index.js',
+      { sourceMap: false },
+      { devtool: 'source-map' }
+    );
+    const stats = await compile(compiler);
+
+    const codeFromBundle = getCodeFromBundle('style.css', stats);
+
+    expect(codeFromBundle.css).toMatchSnapshot('css');
+    expect(codeFromBundle.map).toBeUndefined();
+    expect(getWarnings(stats)).toMatchSnapshot('warnings');
+    expect(getErrors(stats)).toMatchSnapshot('errors');
+  });
+
   it('should work Sourcemap - {String}', async () => {
     const compiler = getCompiler('./css/index.js', { sourceMap: 'inline' });
     const stats = await compile(compiler);
@@ -34,4 +52,50 @@ describe('Options Sourcemap', () => {
     expect(getWarnings(stats)).toMatchSnapshot('warnings');
     expect(getErrors(stats)).toMatchSnapshot('errors');
   });
+
+  it('should work with prev sourceMap', async () => {
+    const compiler = getCompiler(
+      './scss/index.js',
+      {
+        config: false,
+      },
+      {
+        devtool: 'source-map',
+        module: {
+          rules: [
+            {
+              test: /\.scss$/i,
+              use: [
+                {
+                  loader: require.resolve('../helpers/testLoader'),
+                  options: {},
+                },
+                {
+                  loader: path.resolve(__dirname, '../../src'),
+                  options: {
+                    config: false,
+                  },
+                },
+                {
+                  loader: 'sass-loader',
+                  options: {
+                    // eslint-disable-next-line global-require
+                    implementation: require('sass'),
+                  },
+                },
+              ],
+            },
+          ],
+        },
+      }
+    );
+    const stats = await compile(compiler);
+
+    const codeFromBundle = getCodeFromBundle('style.scss', stats);
+
+    expect(codeFromBundle.css).toMatchSnapshot('css');
+    expect(codeFromBundle.map).toMatchSnapshot('map');
+    expect(getWarnings(stats)).toMatchSnapshot('warnings');
+    expect(getErrors(stats)).toMatchSnapshot('errors');
+  });
 });