Skip to content

[eslint-plugin] Add gap auto-fix for legacy-expand-shorthands and skip single-value gap in valid-shorthands #1668

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
May 15, 2026
Merged

[eslint-plugin] Add gap auto-fix for legacy-expand-shorthands and skip single-value gap in valid-shorthands #1668

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
185 changes: 55 additions & 130 deletions packages/@stylexjs/eslint-plugin/__tests__/stylex-valid-shorthands-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -498,6 +498,61 @@ eslintTester.run('stylex-valid-shorthands', rule.default, {
})
`,
},
// gap: single value is not a shorthand, no expansion needed
{
code: `
import * as stylex from '@stylexjs/stylex';
const styles = stylex.create({
main: {
gap: '10px',
},
});
`,
},
// gap: single numeric value is not a shorthand
{
code: `
import * as stylex from '@stylexjs/stylex';
const styles = stylex.create({
main: {
gap: 10,
},
});
`,
},
// gap: numeric zero is not a shorthand
{
code: `
import * as stylex from '@stylexjs/stylex';
const styles = stylex.create({
main: {
gap: 0,
},
});
`,
},
// gap: var() single value is not a shorthand
{
code: `
import * as stylex from '@stylexjs/stylex';
const styles = stylex.create({
main: {
gap: 'var(--spacing)',
},
});
`,
},
// gap: calc() single value is not a shorthand
{
code: `
import * as stylex from '@stylexjs/stylex';
const styles = stylex.create({
main: {
gap: 'calc(10px + 1rem)',
},
});
`,
},
],
invalid: [
{
Expand Down Expand Up @@ -2420,136 +2475,6 @@ eslintTester.run('stylex-valid-shorthands', rule.default, {
},
],
},
// gap: single value expands to rowGap + columnGap
{
code: `
import * as stylex from '@stylexjs/stylex';
const styles = stylex.create({
main: {
gap: '10px',
},
});
`,
output: `
import * as stylex from '@stylexjs/stylex';
const styles = stylex.create({
main: {
rowGap: '10px',
columnGap: '10px',
},
});
`,
errors: [
{
message:
'Property shorthands using multiple values like "gap: 10px" are not supported in StyleX. Separate into individual properties.',
},
],
},
// gap: single numeric value expands to rowGap + columnGap
{
code: `
import * as stylex from '@stylexjs/stylex';
const styles = stylex.create({
main: {
gap: 10,
},
});
`,
output: `
import * as stylex from '@stylexjs/stylex';
const styles = stylex.create({
main: {
rowGap: 10,
columnGap: 10,
},
});
`,
errors: [
{
message:
'Property shorthands using multiple values like "gap: 10" are not supported in StyleX. Separate into individual properties.',
},
],
},
// gap: numeric zero expands to rowGap + columnGap
{
code: `
import * as stylex from '@stylexjs/stylex';
const styles = stylex.create({
main: {
gap: 0,
},
});
`,
output: `
import * as stylex from '@stylexjs/stylex';
const styles = stylex.create({
main: {
rowGap: 0,
columnGap: 0,
},
});
`,
errors: [
{
message:
'Property shorthands using multiple values like "gap: 0" are not supported in StyleX. Separate into individual properties.',
},
],
},
// gap: var() value expands to rowGap + columnGap
{
code: `
import * as stylex from '@stylexjs/stylex';
const styles = stylex.create({
main: {
gap: 'var(--spacing)',
},
});
`,
output: `
import * as stylex from '@stylexjs/stylex';
const styles = stylex.create({
main: {
rowGap: 'var(--spacing)',
columnGap: 'var(--spacing)',
},
});
`,
errors: [
{
message:
'Property shorthands using multiple values like "gap: var(--spacing)" are not supported in StyleX. Separate into individual properties.',
},
],
},
// gap: calc() value expands to rowGap + columnGap
{
code: `
import * as stylex from '@stylexjs/stylex';
const styles = stylex.create({
main: {
gap: 'calc(10px + 1rem)',
},
});
`,
output: `
import * as stylex from '@stylexjs/stylex';
const styles = stylex.create({
main: {
rowGap: 'calc(10px + 1rem)',
columnGap: 'calc(10px + 1rem)',
},
});
`,
errors: [
{
message:
'Property shorthands using multiple values like "gap: calc(10px + 1rem)" are not supported in StyleX. Separate into individual properties.',
},
],
},
// gap: two values splits to rowGap + columnGap
{
code: `
Expand Down
12 changes: 12 additions & 0 deletions packages/@stylexjs/eslint-plugin/src/stylex-valid-shorthands.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,18 @@ const stylexValidShorthands = {
return;
}

if (
key === 'gap' &&
newValues.length === 2 &&
newValues.every(
([, val]) =>
val === property.value.value ||
val === Number(property.value.value),
)
) {
return;
}

context.report({
node: property,
message: `Property shorthands using multiple values like "${key}: ${String(property.value.value)}" are not supported in StyleX. Separate into individual properties.`,
Expand Down
1 change: 1 addition & 0 deletions packages/@stylexjs/eslint-plugin/src/stylex-valid-styles.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ const showError =
const shorthandExpansionMap: { [string]: string } = {
animation: 'animation',
font: 'font',
gap: 'gap',
gridArea: 'grid-area',
gridColumn: 'grid-column',
gridRow: 'grid-row',
Expand Down
Loading