Inline sass-extract-js plugin (#1590)

* Inline sass-extract-js plugin

Remove camelcasing
Preserve hex values over rgb where possible

* Bump yarn lock file

* Add MIT license and derived note

Author: sorenlouv

package.json

@@ -152,7 +152,6 @@
     "resolve": "^1.5.0",
     "rimraf": "^2.6.2",
     "sass-extract": "^2.1.0",
-    "sass-extract-js": "^0.3.0",
     "sass-lint": "^1.12.1",
     "sass-lint-auto-fix": "^0.15.0",
     "sass-loader": "^6.0.6",

scripts/compile-scss.js

@@ -6,6 +6,7 @@ const globModule = require('glob');
 const chalk = require('chalk');
 const postcss = require('postcss');
 const sassExtract = require('sass-extract');
+const sassExtractJsPlugin = require('./sass-extract-js-plugin');
 
 const postcssConfiguration = require('../src-docs/postcss.config.js');
 
@@ -65,7 +66,7 @@ async function compileScssFile(inputFilename, outputCssFilename, outputVarsFilen
       outFile: outputCssFilename,
     },
     {
-      plugins: [{ plugin: 'sass-extract-js' }],
+      plugins: [sassExtractJsPlugin],
     }
   );
 

scripts/sass-extract-js-plugin.js

@@ -0,0 +1,99 @@
+// The contents of this file is derived from https://github.com/adamgruber/sass-extract-js by Adam Gruber
+// MIT License
+// Copyright (c) 2017 Adam Gruber
+// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+/*
+ * Add escaped quotes around font names other than the generic CSS font families
+ * While quotes are not required, they are recommended by the spec
+ * https://www.w3.org/TR/css-fonts-3/#generic-font-families
+ *
+ * @param {string} str Font family name
+ *
+ * @return {string}
+ */
+function quoteFontName(str) {
+  const genericFonts = [
+    'serif',
+    'sans-serif',
+    'cursive',
+    'fantasy',
+    'monospace',
+  ];
+  return genericFonts.includes(str.toLowerCase()) ? str : `'${str}'`;
+}
+
+/*
+ * Get the CSS value from a sass-extract data structure
+ * https://github.com/jgranstrom/sass-extract#general-variable-value-structure
+ *
+ * @param {object} sassVar Abstract data structure for SASS variable
+ *
+ * @return {string|int} CSS value
+ */
+function getSassValue(sassVar) {
+  const { type, value } = sassVar;
+  switch (type) {
+    case 'SassNumber':
+      return sassVar.unit ? `${value}${sassVar.unit}` : value;
+
+    case 'SassColor': {
+      const { r, g, b, a, hex } = value;
+      const hasAlpha = a !== 1;
+      return hasAlpha
+        ? `rgba(${r.toFixed()}, ${g.toFixed()}, ${b.toFixed()}, ${a})`
+        : hex;
+    }
+
+    case 'SassList': {
+      const isStringList = value.every(item => item.type === 'SassString');
+      const newList = value.map(getSassValue);
+      return isStringList
+        ? newList.map(quoteFontName).join(', ')
+        : newList.join(' ');
+    }
+
+    case 'SassMap':
+      return transformVars(value);
+
+    default:
+      return value;
+  }
+}
+
+/*
+ * Transform style object key
+ * - Strip leading '$'
+ *
+ * @param {string} key Style object key
+ *
+ * @return {string} Converted key
+ */
+function transformKey(key) {
+  return key.replace('$', '');
+}
+
+/*
+ * Reduce SASS-compiled variables object into theme object
+ *
+ * @param {object} varsObj Output from `sass-extract` render
+ *
+ * @return {object} Transformed variables object
+ */
+function transformVars(varsObj) {
+  return Object.keys(varsObj).reduce((acc, key) => {
+    const newKey = transformKey(key);
+    const newVal = getSassValue(varsObj[key]);
+    acc[newKey] = newVal;
+    return acc;
+  }, {});
+}
+
+module.exports = {
+  run: () => ({
+    postExtract: extractedVariables =>
+      transformVars(extractedVariables.global),
+  }),
+};

yarn.lock

@@ -2398,7 +2398,7 @@ callsites@^3.0.0:
   resolved "https://registry.yarnpkg.com/callsites/-/callsites-3.0.0.tgz#fb7eb569b72ad7a45812f93fd9430a3e410b3dd3"
   integrity sha512-tWnkwu9YEq2uzlBDI4RcLn8jrFvF9AOi8PxDNU3hZZjJcjkcRAq3vCI+vZcg1SuxISDYe86k9VZFwAxDiJGoAw==
 
-camel-case@3.0.x, camel-case@^3.0.0:
+camel-case@3.0.x:
   version "3.0.0"
   resolved "https://registry.yarnpkg.com/camel-case/-/camel-case-3.0.0.tgz#ca3c3688a4e9cf3a4cda777dc4dcbc713249cf73"
   integrity sha1-yjw2iKTpzzpM2nd9xNy8cTJJz3M=
@@ -12395,13 +12395,6 @@ sane@^3.0.0:
   optionalDependencies:
     fsevents "^1.2.3"
 
-sass-extract-js@^0.3.0:
-  version "0.3.0"
-  resolved "https://registry.yarnpkg.com/sass-extract-js/-/sass-extract-js-0.3.0.tgz#3fc5be20d84ce55c29a8b089a49254fbfb69a2a3"
-  integrity sha512-JYyx28EgoPjduSRu/Xyv7+ec/D3CrWiLujNOawYea1YQCBPcgNk12sKxMYkgHeoRGhsIOfu1MXsY6zGcm02mrA==
-  dependencies:
-    camel-case "^3.0.0"
-
 sass-extract@^2.1.0:
   version "2.1.0"
   resolved "https://registry.yarnpkg.com/sass-extract/-/sass-extract-2.1.0.tgz#c65e6ca3103cbcf2fca0dcd81b07e4e49a6cc583"