Skip to content

[babel-plugin] Allow -- prefixed keys in defineConsts to preserve user-authored names #1460

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
mellyeliu merged 1 commit into from
Jan 22, 2026
+48 −12
Merged

[babel-plugin] Allow -- prefixed keys in defineConsts to preserve user-authored names #1460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
43 changes: 43 additions & 0 deletions packages/@stylexjs/babel-plugin/__tests__/transform-stylex-defineConsts-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,49 @@ describe('@stylexjs/babel-plugin', () => {
]
`);
});

test('constant names: -- prefix preserves user-authored name', () => {
const { code, metadata } = transform(`
import * as stylex from '@stylexjs/stylex';
export const sizes = stylex.defineConsts({
'--small': '8px',
'--large': '24px',
});
`);

expect(code).toMatchInlineSnapshot(`
"import * as stylex from '@stylexjs/stylex';
export const sizes = {
"--small": "8px",
"--large": "24px"
};"
`);

expect(metadata.stylex).toMatchInlineSnapshot(`
[
[
"small",
{
"constKey": "small",
"constVal": "8px",
"ltr": "",
"rtl": null,
},
0,
],
[
"large",
{
"constKey": "large",
"constVal": "24px",
"ltr": "",
"rtl": null,
},
0,
],
]
`);
});
});

describe('[transform] stylex.defineConsts() in stylex.create() ', () => {
Expand Down
4 changes: 2 additions & 2 deletions packages/@stylexjs/babel-plugin/__tests__/validation-stylex-defineConsts-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,15 +162,15 @@ describe('@stylexjs/babel-plugin', () => {

/* Properties */

test('invalid key: starts with "--"', () => {
test('valid key: starts with "--"', () => {
expect(() =>
transform(`
import * as stylex from '@stylexjs/stylex';
export const constants = stylex.defineConsts({
'--small': '8px'
});
`),
).toThrow(messages.INVALID_CONST_KEY);
).not.toThrow();
});

test('invalid key: non-static', () => {
Expand Down
2 changes: 0 additions & 2 deletions packages/@stylexjs/babel-plugin/src/shared/messages.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,6 @@ export const ILLEGAL_PROP_VALUE =
export const ILLEGAL_PROP_ARRAY_VALUE =
'A style array value can only contain strings or numbers.';
export const ILLEGAL_NAMESPACE_VALUE = 'A StyleX namespace must be an object.';
export const INVALID_CONST_KEY =
'Keys in defineConsts() cannot start with "--".';
export const INVALID_PSEUDO = 'Invalid pseudo selector, not on the whitelist.';
export const INVALID_PSEUDO_OR_AT_RULE = 'Invalid pseudo or at-rule.';
export const INVALID_MEDIA_QUERY_SYNTAX = 'Invalid media query syntax.';
Expand Down
11 changes: 3 additions & 8 deletions packages/@stylexjs/babel-plugin/src/shared/stylex-define-consts.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ import type { InjectableConstStyle, StyleXOptions } from './common-types';
import type { ConstsConfig } from './stylex-consts-utils';

import { defaultOptions } from './utils/default-options';
import * as messages from './messages';

import createHash from './hash';

export default function styleXDefineConsts<Vars: ConstsConfig>(
Expand All @@ -31,16 +29,13 @@ export default function styleXDefineConsts<Vars: ConstsConfig>(
const injectableStyles: { [string]: InjectableConstStyle } = {};

for (const [key, value] of Object.entries(constants)) {
if (key.startsWith('--')) {
throw new Error(messages.INVALID_CONST_KEY);
}

const varSafeKey = (
key[0] >= '0' && key[0] <= '9' ? `_${key}` : key
).replace(/[^a-zA-Z0-9]/g, '_');

const constKey =
debug && enableDebugClassNames
const constKey = key.startsWith('--')
? key.slice(2)
: debug && enableDebugClassNames
? `${varSafeKey}-${classNamePrefix}${createHash(`${exportId}.${key}`)}`
: `${classNamePrefix}${createHash(`${exportId}.${key}`)}`;

Expand Down