2022-03-09 17:22:11 +05:30
|
|
|
/*
|
|
|
|
Copyright 2021 The Matrix.org Foundation C.I.C.
|
|
|
|
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
you may not use this file except in compliance with the License.
|
|
|
|
You may obtain a copy of the License at
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
limitations under the License.
|
|
|
|
*/
|
|
|
|
|
2022-03-09 11:48:53 +05:30
|
|
|
const valueParser = require("postcss-value-parser");
|
2022-03-03 19:58:46 +05:30
|
|
|
|
2022-03-23 17:25:12 +05:30
|
|
|
/**
|
|
|
|
* This plugin derives new css variables from a given set of base variables.
|
|
|
|
* A derived css variable has the form --base--operation-argument; meaning that the derived
|
|
|
|
* variable has a value that is generated from the base variable "base" by applying "operation"
|
|
|
|
* with given "argument".
|
|
|
|
*
|
|
|
|
* eg: given the base variable --foo-color: #40E0D0, --foo-color--darker-20 is a css variable
|
|
|
|
* derived from foo-color by making it 20% more darker.
|
|
|
|
*
|
|
|
|
* All derived variables are added to the :root section.
|
|
|
|
*
|
|
|
|
* The actual derivation is done outside the plugin in a callback.
|
|
|
|
*/
|
|
|
|
|
2022-03-03 19:58:46 +05:30
|
|
|
let aliasMap;
|
|
|
|
let resolvedMap;
|
2022-03-14 23:26:37 +05:30
|
|
|
let baseVariables;
|
2022-03-03 19:58:46 +05:30
|
|
|
|
2022-03-14 23:26:37 +05:30
|
|
|
function getValueFromAlias(alias) {
|
2022-03-23 17:12:14 +05:30
|
|
|
const derivedVariable = aliasMap.get(alias);
|
2022-03-14 23:26:37 +05:30
|
|
|
return baseVariables.get(derivedVariable) ?? resolvedMap.get(derivedVariable);
|
2022-03-03 19:58:46 +05:30
|
|
|
}
|
|
|
|
|
2022-03-09 11:48:53 +05:30
|
|
|
function parseDeclarationValue(value) {
|
|
|
|
const parsed = valueParser(value);
|
|
|
|
const variables = [];
|
|
|
|
parsed.walk(node => {
|
|
|
|
if (node.type !== "function" && node.value !== "var") {
|
|
|
|
return;
|
2022-03-07 11:33:44 +05:30
|
|
|
}
|
2022-03-09 11:48:53 +05:30
|
|
|
const variable = node.nodes[0];
|
|
|
|
variables.push(variable.value);
|
|
|
|
});
|
|
|
|
return variables;
|
|
|
|
}
|
|
|
|
|
2022-03-14 23:26:37 +05:30
|
|
|
function resolveDerivedVariable(decl, derive) {
|
2022-03-23 20:39:24 +05:30
|
|
|
const RE_VARIABLE_VALUE = /--((.+)--(.+)-(.+))/;
|
2022-03-09 11:48:53 +05:30
|
|
|
const variableCollection = parseDeclarationValue(decl.value);
|
|
|
|
for (const variable of variableCollection) {
|
|
|
|
const matches = variable.match(RE_VARIABLE_VALUE);
|
|
|
|
if (matches) {
|
2022-03-23 20:39:24 +05:30
|
|
|
const [, wholeVariable, baseVariable, operation, argument] = matches;
|
2022-03-23 17:12:14 +05:30
|
|
|
const value = baseVariables.get(baseVariable) ?? getValueFromAlias(baseVariable);
|
2022-03-10 16:05:13 +05:30
|
|
|
if (!value) {
|
|
|
|
throw new Error(`Cannot derive from ${baseVariable} because it is neither defined in config nor is it an alias!`);
|
|
|
|
}
|
2022-03-09 17:20:05 +05:30
|
|
|
const derivedValue = derive(value, operation, argument);
|
|
|
|
resolvedMap.set(wholeVariable, derivedValue);
|
2022-03-07 11:33:44 +05:30
|
|
|
}
|
2022-03-03 19:58:46 +05:30
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-03-14 23:26:37 +05:30
|
|
|
function extract(decl) {
|
2022-03-10 17:24:32 +05:30
|
|
|
if (decl.variable) {
|
2022-03-14 23:26:37 +05:30
|
|
|
// see if right side is of form "var(--foo)"
|
2022-03-23 20:39:24 +05:30
|
|
|
const wholeVariable = decl.value.match(/var\(--(.+)\)/)?.[1];
|
|
|
|
// remove -- from the prop
|
|
|
|
const prop = decl.prop.substring(2);
|
2022-03-10 17:24:32 +05:30
|
|
|
if (wholeVariable) {
|
2022-03-23 20:39:24 +05:30
|
|
|
aliasMap.set(prop, wholeVariable);
|
2022-03-14 23:26:37 +05:30
|
|
|
// Since this is an alias, we shouldn't store it in baseVariables
|
|
|
|
return;
|
2022-03-10 17:24:32 +05:30
|
|
|
}
|
2022-03-23 20:39:24 +05:30
|
|
|
baseVariables.set(prop, decl.value);
|
2022-03-03 19:58:46 +05:30
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-03-14 23:26:37 +05:30
|
|
|
function addResolvedVariablesToRootSelector(root, {Rule, Declaration}) {
|
2022-03-07 11:32:30 +05:30
|
|
|
const newRule = new Rule({ selector: ":root", source: root.source });
|
|
|
|
// Add derived css variables to :root
|
|
|
|
resolvedMap.forEach((value, key) => {
|
2022-03-23 20:39:24 +05:30
|
|
|
const declaration = new Declaration({prop: `--${key}`, value});
|
2022-03-07 11:32:30 +05:30
|
|
|
newRule.append(declaration);
|
|
|
|
});
|
|
|
|
root.append(newRule);
|
|
|
|
}
|
|
|
|
|
2022-03-10 17:19:04 +05:30
|
|
|
/**
|
|
|
|
* @callback derive
|
|
|
|
* @param {string} value - The base value on which an operation is applied
|
|
|
|
* @param {string} operation - The operation to be applied (eg: darker, lighter...)
|
|
|
|
* @param {string} argument - The argument for this operation
|
|
|
|
*/
|
|
|
|
/**
|
|
|
|
*
|
|
|
|
* @param {Object} opts - Options for the plugin
|
|
|
|
* @param {derive} opts.derive - The callback which contains the logic for resolving derived variables
|
2022-03-03 19:58:46 +05:30
|
|
|
*/
|
|
|
|
module.exports = (opts = {}) => {
|
2022-03-07 11:33:44 +05:30
|
|
|
aliasMap = new Map();
|
|
|
|
resolvedMap = new Map();
|
2022-03-14 23:26:37 +05:30
|
|
|
baseVariables = new Map();
|
2022-03-07 11:33:44 +05:30
|
|
|
return {
|
|
|
|
postcssPlugin: "postcss-compile-variables",
|
2022-03-03 19:58:46 +05:30
|
|
|
|
2022-03-10 17:21:38 +05:30
|
|
|
Once(root, {Rule, Declaration}) {
|
2022-03-07 11:33:44 +05:30
|
|
|
/*
|
2022-03-14 23:26:37 +05:30
|
|
|
Go through the CSS file once to extract all aliases and base variables.
|
|
|
|
We use these when resolving derived variables later.
|
2022-03-07 11:33:44 +05:30
|
|
|
*/
|
2022-03-14 23:26:37 +05:30
|
|
|
root.walkDecls(decl => extract(decl));
|
|
|
|
root.walkDecls(decl => resolveDerivedVariable(decl, opts.derive));
|
|
|
|
addResolvedVariablesToRootSelector(root, {Rule, Declaration});
|
2022-03-07 11:33:44 +05:30
|
|
|
},
|
|
|
|
};
|
2022-03-03 19:58:46 +05:30
|
|
|
};
|
|
|
|
|
|
|
|
module.exports.postcss = true;
|