-
Notifications
You must be signed in to change notification settings - Fork 503
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(module): smart safelisting (#268)
Co-authored-by: Sébastien Chopin <seb@nuxtjs.com>
- Loading branch information
1 parent
e12e974
commit 20fa4d2
Showing
11 changed files
with
250 additions
and
120 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| const colorsToExclude = [ | ||
| 'inherit', | ||
| 'transparent', | ||
| 'current', | ||
| 'white', | ||
| 'black', | ||
| 'slate', | ||
| 'gray', | ||
| 'zinc', | ||
| 'neutral', | ||
| 'stone', | ||
| 'cool' | ||
| ] | ||
|
|
||
| const omit = (obj: object, keys: string[]) => { | ||
| return Object.fromEntries( | ||
| Object.entries(obj).filter(([key]) => !keys.includes(key)) | ||
| ) | ||
| } | ||
|
|
||
| const kebabCase = (str: string) => { | ||
| return str | ||
| ?.match(/[A-Z]{2,}(?=[A-Z][a-z]+[0-9]*|\b)|[A-Z]?[a-z]+[0-9]*|[A-Z]|[0-9]+/g) | ||
| ?.map(x => x.toLowerCase()) | ||
| ?.join('-') | ||
| } | ||
|
|
||
| const safelistByComponent = { | ||
| avatar: (colorsAsRegex) => [{ | ||
| pattern: new RegExp(`bg-(${colorsAsRegex}|gray)-500`) | ||
| }, { | ||
| pattern: new RegExp(`bg-(${colorsAsRegex}|gray)-400`), | ||
| variants: ['dark'] | ||
| }], | ||
| badge: (colorsAsRegex) => [{ | ||
| pattern: new RegExp(`bg-(${colorsAsRegex})-50`) | ||
| }, { | ||
| pattern: new RegExp(`bg-(${colorsAsRegex})-400`), | ||
| variants: ['dark'] | ||
| }, { | ||
| pattern: new RegExp(`text-(${colorsAsRegex})-500`) | ||
| }, { | ||
| pattern: new RegExp(`text-(${colorsAsRegex})-400`), | ||
| variants: ['dark'] | ||
| }, { | ||
| pattern: new RegExp(`ring-(${colorsAsRegex})-500`) | ||
| }, { | ||
| pattern: new RegExp(`ring-(${colorsAsRegex})-400`), | ||
| variants: ['dark'] | ||
| }], | ||
| button: (colorsAsRegex) => [{ | ||
| pattern: new RegExp(`bg-(${colorsAsRegex})-50`), | ||
| variants: ['hover'] | ||
| }, { | ||
| pattern: new RegExp(`bg-(${colorsAsRegex})-100`), | ||
| variants: ['hover'] | ||
| }, { | ||
| pattern: new RegExp(`bg-(${colorsAsRegex})-400`), | ||
| variants: ['dark', 'dark:disabled'] | ||
| }, { | ||
| pattern: new RegExp(`bg-(${colorsAsRegex})-500`), | ||
| variants: ['disabled', 'dark:hover'] | ||
| }, { | ||
| pattern: new RegExp(`bg-(${colorsAsRegex})-600`), | ||
| variants: ['hover'] | ||
| }, { | ||
| pattern: new RegExp(`bg-(${colorsAsRegex})-900`), | ||
| variants: ['dark:hover'] | ||
| }, { | ||
| pattern: new RegExp(`bg-(${colorsAsRegex})-950`), | ||
| variants: ['dark', 'dark:hover'] | ||
| }, { | ||
| pattern: new RegExp(`text-(${colorsAsRegex})-400`), | ||
| variants: ['dark'] | ||
| }, { | ||
| pattern: new RegExp(`text-(${colorsAsRegex})-500`), | ||
| variants: ['dark:hover'] | ||
| }, { | ||
| pattern: new RegExp(`text-(${colorsAsRegex})-600`), | ||
| variants: ['hover'] | ||
| }, { | ||
| pattern: new RegExp(`outline-(${colorsAsRegex})-400`), | ||
| variants: ['dark:focus-visible'] | ||
| }, { | ||
| pattern: new RegExp(`outline-(${colorsAsRegex})-500`), | ||
| variants: ['focus-visible'] | ||
| }, { | ||
| pattern: new RegExp(`ring-(${colorsAsRegex})-400`), | ||
| variants: ['dark:focus-visible'] | ||
| }, { | ||
| pattern: new RegExp(`ring-(${colorsAsRegex})-500`), | ||
| variants: ['focus-visible'] | ||
| }], | ||
| input: (colorsAsRegex) => [{ | ||
| pattern: new RegExp(`ring-(${colorsAsRegex})-400`), | ||
| variants: ['dark', 'dark:focus'] | ||
| }, { | ||
| pattern: new RegExp(`ring-(${colorsAsRegex})-500`), | ||
| variants: ['focus'] | ||
| }], | ||
| notification: (colorsAsRegex) => [{ | ||
| pattern: new RegExp(`bg-(${colorsAsRegex}|gray)-500`) | ||
| }, { | ||
| pattern: new RegExp(`bg-(${colorsAsRegex}|gray)-400`), | ||
| variants: ['dark'] | ||
| }, { | ||
| pattern: new RegExp(`text-(${colorsAsRegex}|gray)-500`) | ||
| }, { | ||
| pattern: new RegExp(`text-(${colorsAsRegex}|gray)-400`), | ||
| variants: ['dark'] | ||
| }] | ||
| } | ||
|
|
||
| const colorsAsRegex = (colors: string[]): string => colors.join('|') | ||
|
|
||
| export const excludeColors = (colors: object) => Object.keys(omit(colors, colorsToExclude)).map(color => kebabCase(color)) as string[] | ||
|
|
||
| export const generateSafelist = (colors: string[]) => ['avatar', 'badge', 'button', 'input', 'notification'].flatMap(component => safelistByComponent[component](colorsAsRegex(colors))) | ||
|
|
||
| export const customSafelistExtractor = (prefix, content: string) => { | ||
| const classes = [] | ||
| const regex = /<(\w+)\s+[^>]*color=["']([^"']+)["'][^>]*>/gs | ||
| const matches = [...content.matchAll(regex)] | ||
|
|
||
| for (const match of matches) { | ||
| const [, component, color] = match | ||
|
|
||
| if (colorsToExclude.includes(color)) { | ||
| continue | ||
| } | ||
|
|
||
| if (Object.keys(safelistByComponent).map(component => `${prefix}${component.charAt(0).toUpperCase() + component.slice(1)}`).includes(component)) { | ||
| const name = component.replace(prefix, '').toLowerCase() | ||
|
|
||
| const matchClasses = safelistByComponent[name](color).flatMap(group => { | ||
| return ['', ...(group.variants || [])].flatMap(variant => { | ||
| const matches = group.pattern.source.match(/\(([^)]+)\)/g) | ||
|
|
||
| return matches.map(match => { | ||
| const colorOptions = match.substring(1, match.length - 1).split('|') | ||
| return colorOptions.map(color => `${variant ? variant + ':' : ''}` + group.pattern.source.replace(match, color)) | ||
| }).flat() | ||
| }) | ||
| }) | ||
|
|
||
| classes.push(...matchClasses) | ||
| } | ||
| } | ||
|
|
||
| return classes | ||
| } |
Oops, something went wrong.
20fa4d2There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
ui – ./
ui.nuxtlabs.com
ui-git-dev-nuxtlabs.vercel.app
ui-nuxtlabs.vercel.app