Add comment to not-obvious things in sass-build

Shopify · Nov 20, 2018 · 7f89ff4 · 7f89ff4
1 parent 4076145
commit 7f89ff4
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/scripts/sass-build.js b/scripts/sass-build.js
@@ -46,6 +46,10 @@ export default function generateSassBuild(destinationDir) {
     const regex = /:global\s*\(([^)]+)\)|:global\s*{\s*([^}]+)\s*}\s*/;
 
     glob.sync(join(srcDir, '/**/*.scss')).forEach((srcFile) => {
+      // On Windows `srcFile` contains forwardslashes as path separators (as it
+      // came from glob) while `srcDir` contains backslashes as path separators
+      // (as it came from path.join). Replace backslashes with forward-slashes
+      // to ensure the sassFile gets generated correctly
       const sassFile = srcFile.replace(srcDir.replace(/\\/g, '/'), '');
       let file = readFileSync(srcFile, 'utf8');
       file = file.replace(new RegExp(regex, 'g'), '$1$2');