Skip to content
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

Jump to bottom

feat(custom-properties): Warn in development on invalid theme keys #2080

Merged
merged 1 commit into from Jan 29, 2022
Merged

feat(custom-properties): Warn in development on invalid theme keys #2080

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions packages/custom-properties/src/index.ts
View file
Open in desktop
@@ -1,6 +1,10 @@
import pluralize from 'pluralize'
import { Theme } from '@theme-ui/css'

// Simplified validator based on spec https://www.w3.org/TR/CSS22/syndata.html#value-def-identifier
// Does not check for "cannot start with a digit, two hyphens, or a hyphen followed by a digit"
const keyValidator = /^[A-z0-9][\w-]*$/

interface CustomProperties {
[key: string]: string | number
}
Expand All @@ -12,6 +16,16 @@ export default function makeCustomProperties(theme: Theme, prefix?: string) {
Object.entries(object).forEach(([key, value]) => {
let formattedKey = pluralize(key, 1)

if (
process.env.NODE_ENV !== 'production' &&
!keyValidator.test(formattedKey)
) {
console.warn(
`[theme-ui] Theme key "${value}" found will produce an invalid CSS custom property. ` +
'Keys must only contain the following: A-Z, a-z, 0-9, hyphen, underscore.'
)
}

if (prefix && !previousKey) {
formattedKey = `${prefix}-${formattedKey}`
}
Expand Down
16 changes: 14 additions & 2 deletions packages/custom-properties/test/test.js
View file
Open in desktop
@@ -1,4 +1,5 @@
import toCustomProperties from '../src'
import mockConsole from 'jest-mock-console'

const theme = {
colors: {
Expand All @@ -18,8 +19,7 @@ const theme = {
},
},
fonts: {
body:
'system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", sans-serif',
body: 'system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", sans-serif',
heading:
'system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", sans-serif',
monospace: 'Menlo, monospace',
Expand All @@ -35,13 +35,25 @@ const theme = {
}

it('transforms a theme config to CSS custom properties', () => {
mockConsole()
const result = toCustomProperties(theme)

expect(result).toMatchSnapshot()
expect(console.warn).toHaveBeenCalledTimes(0)
})

it('transforms a theme config to CSS custom properties with prefix', () => {
const result = toCustomProperties(theme, '🍭')

expect(result).toMatchSnapshot()
})

it('warns on invalid CSS custom property key', () => {
mockConsole()
toCustomProperties({ sizes: { '1/4': 1 / 4, '1/2': 1 / 2 } })

expect(console.warn).toHaveBeenCalledTimes(2)
expect(console.warn).toHaveBeenLastCalledWith(
'[theme-ui] Theme key "0.5" found will produce an invalid CSS custom property. Keys must only contain the following: A-Z, a-z, 0-9, hyphen, underscore.'
)
})