Skip to content

fix: prefix S1 style macro class names #7365

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
reidbarber merged 2 commits into from
Nov 15, 2024
Merged

fix: prefix S1 style macro class names #7365

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8b4f9a1
prefix s1 style macro class names
reidbarber Nov 14, 2024
b4f0089
lint
reidbarber Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 12 additions & 13 deletions packages/@react-spectrum/style-macro-s1/src/style-macro.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@
*/
import type {Condition, CSSProperties, CSSValue, CustomValue, PropertyFunction, PropertyValueDefinition, PropertyValueMap, StyleFunction, StyleValue, Theme, ThemeProperties, Value} from './types';

// Prefix Spectrum 1 style macro classes to avoid name collisions with S2 style macro.
const PREFIX = 's1-';

export function createArbitraryProperty<T extends Value>(fn: (value: T, property: string) => CSSProperties): PropertyFunction<T> {
return (value, property) => {
let selector = Array.isArray(value) ? value.map(v => generateArbitraryValueSelector(String(v))).join('') : generateArbitraryValueSelector(String(value));
Expand Down Expand Up @@ -67,11 +70,11 @@ function mapConditionalValue<T, U>(value: PropertyValueDefinition<T>, fn: (value
}
}

function createValueLookup(values: Array<CSSValue>, atStart = false) {
function createValueLookup(values: Array<CSSValue>) {
let map = new Map<CSSValue, string>();
for (let value of values) {
if (!map.has(value)) {
map.set(value, generateName(map.size, atStart));
map.set(value, `${PREFIX}${generateName(map.size)}`);
}
}
return map;
Expand All @@ -91,8 +94,8 @@ interface MacroContext {
}

export function createTheme<T extends Theme>(theme: T): StyleFunction<ThemeProperties<T>, 'default' | Extract<keyof T['conditions'], string>> {
let themePropertyMap = createValueLookup(Object.keys(theme.properties), true);
let themeConditionMap = createValueLookup(Object.keys(theme.conditions), true);
let themePropertyMap = createValueLookup(Object.keys(theme.properties));
let themeConditionMap = createValueLookup(Object.keys(theme.conditions));
let propertyFunctions = new Map(Object.entries(theme.properties).map(([k, v]) => {
if (typeof v === 'function') {
return [k, v];
Expand Down Expand Up @@ -159,7 +162,7 @@ export function createTheme<T extends Theme>(theme: T): StyleFunction<ThemePrope
} else {
css += ', ';
}
css += generateName(i, true);
css += `${PREFIX}${generateName(i)}`;
}
css += ';\n\n';

Expand Down Expand Up @@ -267,7 +270,7 @@ export function createTheme<T extends Theme>(theme: T): StyleFunction<ThemePrope
let prelude = theme.conditions[condition] || condition;
if (prelude.startsWith(':')) {
return [{
prelude: `@layer ${generateName(priority, true)}`,
prelude: `@layer ${PREFIX}${generateName(priority)}`,
body: rules.map(rule => ({prelude: rule.prelude, body: [{...rule, prelude: '&' + prelude}], condition: ''})),
condition: ''
}];
Expand All @@ -277,7 +280,7 @@ export function createTheme<T extends Theme>(theme: T): StyleFunction<ThemePrope
return [{
// Top level layer is based on the priority of the rule, not the condition.
// Also group in a sub-layer based on the condition so that lightningcss can more effectively deduplicate rules.
prelude: `@layer ${generateName(priority, true)}.${themeConditionMap.get(condition) || generateArbitraryValueSelector(condition, true)}`,
prelude: `@layer ${PREFIX}${generateName(priority)}.${themeConditionMap.get(condition) || generateArbitraryValueSelector(condition, true)}`,
body: [{prelude, body: rules, condition: ''}],
condition: ''
}];
Expand Down Expand Up @@ -367,7 +370,7 @@ interface Rule {
// This maps to an alphabet containing lower case letters, upper case letters, and numbers.
// For numbers larger than 62, an underscore is prepended.
// This encoding allows easy parsing to enable runtime merging by property.
function generateName(index: number, atStart = false): string {
Copy link
Copy Markdown
Member Author

@reidbarber reidbarber Nov 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

atStart no longer needed since it was being used to avoid class names starting with numbers, which can't happen anymore due to prefix.

function generateName(index: number): string {
if (index < 26) {
// lower case letters
return String.fromCharCode(index + 97);
Expand All @@ -380,11 +383,7 @@ function generateName(index: number, atStart = false): string {

if (index < 62) {
// numbers
let res = String.fromCharCode((index - 52) + 48);
if (atStart) {
res = '_' + res;
}
return res;
return String.fromCharCode((index - 52) + 48);
}

return '_' + generateName(index - 62);
Expand Down