Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 | import { SLDS_GLOBAL_STYLING_HOOKS_RAW_JSON, SLDS_PLUS_GLOBAL_STYLING_HOOKS_RAW_JSON, GLOBAL_STYLING_HOOKS_FILENAME, SLDS_PLUS_SHARED_STYLING_HOOKS_RAW_JSON, SLDS_SHARED_STYLING_HOOKS_RAW_JSON, VALUE_TO_SLDS_STYLING_HOOKS_FILENAME, VALUE_TO_SLDS_PLUS_STYLING_HOOKS_FILENAME, SLDS_COMPONENT_STYLING_HOOKS_RAW_JSON, SLDS_PLUS_COMPONENT_STYLING_HOOKS_RAW_JSON } from '../constants.js';
import { StylingHookRawData, StylingHookMetadata, StylingHooksJsonByTheme, ValueToStyleHookMap, SupportedFileFormat } from '../types.js';
import { readJSON, writeData } from '../services/file-service.js';
import { resolveReferenceOnlyForPivotValue } from '../utils/value-resolver.js';
interface RawStylingHooksData {
props: Record<string, StylingHookRawData>;
}
function extractAliase(value: string): string{
try {
// if the value matches this format {!PALETTE_BLUE_10} extract PALETTE_BLUE_10 as alias
return value?.replace(/\{!([A-Z0-9_]+)\}/g, '$1') || '';
} catch (error) {
console.error(`Error extracting alias from value: ${value}`);
return value || '';
}
}
function tranformTokenName(tokenName: string, scope: string, theme: string='slds'): string{
let scopePrefix = '';
if(scope == 'shared'){
scopePrefix = 's';
} else if(scope == 'global'){
scopePrefix = 'g';
} else if(scope == 'component'){
scopePrefix = 'c';
} else if(scope == 'reference'){
scopePrefix = 'r';
} else {
scopePrefix = 'unknown';
}
return `--${theme}-${scopePrefix}-${tokenName}`;
}
function transformStylingHook(hook: StylingHookRawData, theme: string): StylingHookMetadata{
return {
category: hook.category,
external: true,
group: hook.group,
scope: hook.scope,
properties: hook.cssProperties,
values: {
[theme]: hook.value,
},
aliases: {
[theme]: extractAliase(hook.originalValue),
}
}
}
function mergeHookMetadata(existing: StylingHookMetadata, newValue: StylingHookMetadata){
let {values, aliases} = existing;
values = Object.assign(values, newValue.values);
aliases = Object.assign(aliases, newValue.aliases);
return {
...existing,
values,
aliases
}
}
function groupByScopeAndUpdateTokenNames(allStylingHooks: Map<string, StylingHookMetadata>){
const groupedByScope = new Map<string, Map<string, StylingHookMetadata>>();
allStylingHooks.forEach((hook, key)=>{
const scope = hook.scope;
if(!groupedByScope.has(scope)){
groupedByScope.set(scope, new Map());
}
groupedByScope.get(scope)?.set(key, hook);
});
return groupedByScope;
}
/**
* This function parses the raw styling hooks data from @salesforce-ux/slds-plus package
* and generates the metadata for the styling hooks.
*
* The metadata is generated in the following files:
* - global-styling-hooks.json
* - value-to-styling-hook-slds.json
* - value-to-styling-hook-slds-plus.json
* @param outputDir - Custom output directory for generated files. Defaults to current working directory
*/
export async function generateStyleHooksMetadata(outputDir: string = process.cwd(), format: SupportedFileFormat = 'json') {
const {
sldsStylingHooks,
sldsPlusStylingHooks
} = await Promise.all([
readJSON<RawStylingHooksData>(SLDS_GLOBAL_STYLING_HOOKS_RAW_JSON),
readJSON<RawStylingHooksData>(SLDS_PLUS_GLOBAL_STYLING_HOOKS_RAW_JSON),
readJSON<RawStylingHooksData>(SLDS_COMPONENT_STYLING_HOOKS_RAW_JSON),
readJSON<RawStylingHooksData>(SLDS_PLUS_COMPONENT_STYLING_HOOKS_RAW_JSON),
readJSON<RawStylingHooksData>(SLDS_SHARED_STYLING_HOOKS_RAW_JSON),
readJSON<RawStylingHooksData>(SLDS_PLUS_SHARED_STYLING_HOOKS_RAW_JSON)
]).then(([sldsStylingHooks, sldsPlusStylingHooks, sldsComponentStylingHooks, sldsPlusComponentStylingHooks, sldsSharedStylingHooks, sldsPlusSharedStylingHooks]) => ({
sldsStylingHooks: Object.assign(sldsStylingHooks.props, sldsComponentStylingHooks.props, sldsSharedStylingHooks.props),
sldsPlusStylingHooks: Object.assign(sldsPlusStylingHooks.props, sldsPlusComponentStylingHooks.props, sldsPlusSharedStylingHooks.props)
}));
const hooksByTheme: StylingHooksJsonByTheme = {
cosmos: sldsPlusStylingHooks,
slds: sldsStylingHooks
};
const allStylingHooks = new Map<string, StylingHookMetadata>();
type HooksJsonEntry = [string, StylingHookRawData];
Object.entries(hooksByTheme).forEach(([theme, hooksJson]) => {
Object.entries(hooksJson).forEach((entry) => {
const [key, hookRawData] = <HooksJsonEntry>entry;
const tokenName = tranformTokenName(key, hookRawData.scope);
const existingHookMeta = allStylingHooks.get(tokenName);
const hookMetadata = transformStylingHook(hookRawData, theme);
if(existingHookMeta){
allStylingHooks.set(tokenName, mergeHookMetadata(existingHookMeta, hookMetadata));
} else {
allStylingHooks.set(tokenName, hookMetadata);
}
});
});
const globalStylingHooksMapByScope = groupByScopeAndUpdateTokenNames(allStylingHooks);
//Nested map to nested json object
const globalStylingHooksMapByScopeJSON = Object.fromEntries(
Array.from(globalStylingHooksMapByScope.entries()).map(
([scope, hooks]) => [
scope,
Object.fromEntries(
Array.from(hooks.entries()).map(([key, hook]) => [key, hook])
),
]
)
);
// pivote hooks information by value per theme
const onlyGlobalHooks = globalStylingHooksMapByScopeJSON.global ?? {};
const referenceHooks = globalStylingHooksMapByScopeJSON.reference ?? {};
const valueToStyleHookSldsMap:ValueToStyleHookMap = new Map();
const valueToStyleHookSldsPlusMap:ValueToStyleHookMap = new Map();
Object.entries(onlyGlobalHooks).forEach(([tokenName, hookData]) => {
const {values, category} = hookData;
if(category === 'shadow'){
// shadows are not supported yet
return;
}
Object.entries(values).forEach(([theme, rawValue]) => {
const entry = {
name: tokenName,
properties: hookData.properties,
group: hookData.group || hookData.category || 'unknown'
};
const value = resolveReferenceOnlyForPivotValue(rawValue, theme as 'slds' | 'cosmos', referenceHooks);
if(!value || value.startsWith('var(') || value.startsWith('--slds-') || value.startsWith('--lwc-')){
// skip var() references, proxy tokens and lwc tokens
return;
}
const mapObj = theme === 'slds' ? valueToStyleHookSldsMap : valueToStyleHookSldsPlusMap;
if(mapObj.has(value)){
mapObj.get(value)?.push(entry);
} else {
mapObj.set(value, [entry]);
}
});
});
// Write all the generated data to files
await Promise.all([
writeData(GLOBAL_STYLING_HOOKS_FILENAME, globalStylingHooksMapByScopeJSON, outputDir, format),
writeData(VALUE_TO_SLDS_STYLING_HOOKS_FILENAME, Object.fromEntries(valueToStyleHookSldsMap.entries()), outputDir, format),
writeData(VALUE_TO_SLDS_PLUS_STYLING_HOOKS_FILENAME, Object.fromEntries(valueToStyleHookSldsPlusMap.entries()), outputDir, format)
]);
} |