-
Notifications
You must be signed in to change notification settings - Fork 0
Test #211
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.
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
Test #211
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| name: Build Design System | ||
|
|
||
| on: | ||
| push: | ||
| paths: | ||
| - "packages/design-system/src/tokens/**" # Trigger only when files in the tokens folder change | ||
| pull_request: | ||
| paths: | ||
| - "packages/design-system/src/tokens/**" | ||
|
|
||
| jobs: | ||
| build-design-system: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| # Step 1: Checkout the repository | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v3 | ||
|
|
||
| # Step 2: Set up Bun | ||
| - name: Setup Bun | ||
| uses: oven-sh/setup-bun@v1 | ||
| with: | ||
| bun-version: latest | ||
|
|
||
| # Step 3: Navigate to the design-system package and install dependencies | ||
| - name: Install dependencies | ||
| working-directory: ./packages/design-system | ||
| run: bun install | ||
|
|
||
| # Step 4: Run the build script | ||
| - name: Run build script | ||
| working-directory: ./packages/design-system | ||
| run: bun run build |
This file was deleted.
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,8 @@ | ||
| { | ||
| "extends": [ | ||
| "development" | ||
| ] | ||
| ], | ||
| "hints": { | ||
| "typescript-config/consistent-casing": "off" | ||
| } | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| { | ||
| "name": "@repo/design-system", | ||
| "version": "1.0.0", | ||
| "scripts": { | ||
| "build": "bun run src/scripts/build.ts" | ||
| }, | ||
| "exports": { | ||
| "./styles": "./src/styles/main.scss", | ||
| "./tailwind": "./src/tailwind/config.ts" | ||
| }, | ||
| "devDependencies": { | ||
| "@repo/typescript-config": "*", | ||
| "style-dictionary": "^4.3.2" | ||
| } | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| import * as fs from "fs"; | ||
| import * as path from "path"; | ||
|
|
||
| // Paths for token files | ||
| const tokensDir = path.join(__dirname, "../tokens"); | ||
| const stylesDir = path.join(__dirname, "../styles/base"); | ||
| const resolveTokenReference = (value: string): string => { | ||
| return value.replace(/{(.+?)}/g, (_, match) => `var(--${match.replace(".", "-")})`); | ||
| }; | ||
|
|
||
| // Generate SCSS content for a given theme | ||
| const generateScssContent = ( | ||
| theme: "dark" | "light", | ||
| tokens: Record<string, any>, | ||
| ): string => { | ||
| const lines: string[] = []; | ||
|
|
||
| const selector = theme === "dark" ? ":root" : ".light"; | ||
|
|
||
| // Add the @use directive | ||
| lines.push(`@use "_palette.scss" as *;\n`); | ||
|
|
||
| // Start the layer and class | ||
| lines.push(`@layer base {`); | ||
| lines.push(` ${selector} {`); | ||
|
|
||
| // Process each token in the "color" group | ||
| const colorTokens = tokens.color; | ||
| for (const key in colorTokens) { | ||
| const value = colorTokens[key].$value; | ||
|
|
||
| // Convert token reference (e.g., {zinc.200}) to CSS variable (e.g., var(--zinc.200)) | ||
| const resolvedValue = resolveTokenReference(value); | ||
| lines.push(` --${key}: ${resolvedValue};`); | ||
| } | ||
|
|
||
| // Close the class and layer | ||
| lines.push(` }`); | ||
| lines.push(`}`); | ||
|
|
||
| return lines.join("\n"); | ||
| }; | ||
|
|
||
| // Function to build and write SCSS for a given theme | ||
| export const buildColorsScss = (theme: "dark" | "light"): void => { | ||
| // Define the input and output file paths | ||
| const partFileName = theme === "dark" ? "Default" : "Light"; | ||
| const inputFilePath = path.join( | ||
| tokensDir, | ||
| `token_Color_${partFileName}.json`, | ||
| ); | ||
| const outputFilePath = path.join(stylesDir, `_colors-${theme}.scss`); | ||
|
|
||
| // Ensure the input file exists | ||
| if (!fs.existsSync(inputFilePath)) { | ||
| console.error(`Token file not found: ${inputFilePath}`); | ||
| return; | ||
| } | ||
|
|
||
| // Read and parse the JSON file | ||
| const rawData = fs.readFileSync(inputFilePath, "utf-8"); | ||
| const tokens = JSON.parse(rawData); | ||
|
|
||
| // Generate SCSS content | ||
| const scssContent = generateScssContent(theme, tokens); | ||
|
|
||
| // Ensure the output directory exists | ||
| if (!fs.existsSync(stylesDir)) { | ||
| fs.mkdirSync(stylesDir, { recursive: true }); | ||
| } | ||
|
|
||
| // Write the SCSS content to the file | ||
| fs.writeFileSync(outputFilePath, scssContent, "utf-8"); | ||
| console.log(`SCSS file created for ${theme} theme at: ${outputFilePath}`); | ||
| }; | ||
|
|
||
| // Reusable calls for light and dark themes | ||
| buildColorsScss("light"); | ||
| buildColorsScss("dark"); | ||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,61 @@ | ||||||||||||||||||||||||||||||||||||||
| import * as fs from "fs"; | ||||||||||||||||||||||||||||||||||||||
| import * as path from "path"; | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| // Paths for token files | ||||||||||||||||||||||||||||||||||||||
| const tokensDir = path.join(__dirname, "../tokens"); | ||||||||||||||||||||||||||||||||||||||
| const outputDir = path.join(__dirname, "../tailwind"); | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| // Utility to resolve token references to match the key directly | ||||||||||||||||||||||||||||||||||||||
| const resolveTokenReference = (key: string): string => { | ||||||||||||||||||||||||||||||||||||||
| return `hsl(var(--${key}))`; | ||||||||||||||||||||||||||||||||||||||
| }; | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| // Generate TypeScript content for colors | ||||||||||||||||||||||||||||||||||||||
| const generateColorsTsContent = (tokens: Record<string, any>): string => { | ||||||||||||||||||||||||||||||||||||||
| const colorTokens = tokens.color; | ||||||||||||||||||||||||||||||||||||||
| const lines: string[] = []; | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| // Add the TypeScript export header | ||||||||||||||||||||||||||||||||||||||
| lines.push(`export const colors = {`); | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| // Process each token and use the key for the variable name | ||||||||||||||||||||||||||||||||||||||
| for (const key in colorTokens) { | ||||||||||||||||||||||||||||||||||||||
| lines.push(` "${key}": "${resolveTokenReference(key)}",`); | ||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| // Close the object | ||||||||||||||||||||||||||||||||||||||
| lines.push(`};`); | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| return lines.join("\n"); | ||||||||||||||||||||||||||||||||||||||
| }; | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| // Function to build and write colors.ts | ||||||||||||||||||||||||||||||||||||||
| export const buildColorsTailwind = (): void => { | ||||||||||||||||||||||||||||||||||||||
| const inputFilePath = path.join(tokensDir, `token_Color_Light.json`); | ||||||||||||||||||||||||||||||||||||||
| const outputFilePath = path.join(outputDir, `colors.ts`); | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| // Ensure the input file exists | ||||||||||||||||||||||||||||||||||||||
| if (!fs.existsSync(inputFilePath)) { | ||||||||||||||||||||||||||||||||||||||
| console.error(`Token file not found: ${inputFilePath}`); | ||||||||||||||||||||||||||||||||||||||
| return; | ||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| // Read and parse the JSON file | ||||||||||||||||||||||||||||||||||||||
| const rawData = fs.readFileSync(inputFilePath, "utf-8"); | ||||||||||||||||||||||||||||||||||||||
| const tokens = JSON.parse(rawData); | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+44
to
+46
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛠️ Refactor suggestion Add validation for color token structure. Validate the token structure before processing to prevent runtime errors. const rawData = fs.readFileSync(inputFilePath, "utf-8");
const tokens = JSON.parse(rawData);
+
+ // Validate token structure
+ if (!tokens.color || typeof tokens.color !== 'object') {
+ console.error('Invalid token structure: missing color group');
+ return;
+ }
+
+ // Validate each color token
+ for (const [key, value] of Object.entries(tokens.color)) {
+ if (!value || typeof value !== 'object' || !value.$type || !value.$value) {
+ console.error(`Invalid token structure for color "${key}"`);
+ return;
+ }
+ }📝 Committable suggestion
Suggested change
|
||||||||||||||||||||||||||||||||||||||
| // Generate TypeScript content | ||||||||||||||||||||||||||||||||||||||
| const tsContent = generateColorsTsContent(tokens); | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| // Ensure the output directory exists | ||||||||||||||||||||||||||||||||||||||
| if (!fs.existsSync(outputDir)) { | ||||||||||||||||||||||||||||||||||||||
| fs.mkdirSync(outputDir, { recursive: true }); | ||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| // Write the TypeScript content to the file | ||||||||||||||||||||||||||||||||||||||
| fs.writeFileSync(outputFilePath, tsContent, "utf-8"); | ||||||||||||||||||||||||||||||||||||||
| console.log(`colors.ts file created at: ${outputFilePath}`); | ||||||||||||||||||||||||||||||||||||||
| }; | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| // Build colors.ts | ||||||||||||||||||||||||||||||||||||||
| buildColorsTailwind(); | ||||||||||||||||||||||||||||||||||||||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,40 @@ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| import * as fs from "fs"; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| import * as path from "path"; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // Paths for the output file | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const outputDir = path.join(__dirname, "../tailwind"); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const outputFilePath = path.join(outputDir, "config.ts"); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // Content for the tailwindConfig.ts file | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const generateTailwindConfigContent = (): string => { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| return ` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| import { colors } from "./colors"; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| import { palette } from "./palette"; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| export const tailwindConfig = { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| theme: { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| extend: { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| colors: { ...colors, ...palette }, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| `.trim(); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+9
to
+22
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛠️ Refactor suggestion Add type safety to the configuration template. The generated configuration lacks type checking which could lead to runtime errors. -export const tailwindConfig = {
+import type { Config } from "tailwindcss";
+
+export const tailwindConfig: Partial<Config["theme"]> = {
theme: {
extend: {
colors: { ...colors, ...palette },
},
},
};📝 Committable suggestion
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // Function to create the tailwindConfig.ts file | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| export const buildTailwindConfig = (): void => { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // Generate the content | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const configContent = generateTailwindConfigContent(); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // Ensure the output directory exists | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| if (!fs.existsSync(outputDir)) { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| fs.mkdirSync(outputDir, { recursive: true }); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // Write the content to the file | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| fs.writeFileSync(outputFilePath, configContent, "utf-8"); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| console.log(`tailwindConfig.ts file created at: ${outputFilePath}`); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+25
to
+37
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add error handling for file operations. The file operations could fail for various reasons (permissions, disk space, etc.) but there's no error handling. export const buildTailwindConfig = (): void => {
- // Generate the content
- const configContent = generateTailwindConfigContent();
+ try {
+ // Generate the content
+ const configContent = generateTailwindConfigContent();
- // Ensure the output directory exists
- if (!fs.existsSync(outputDir)) {
- fs.mkdirSync(outputDir, { recursive: true });
- }
+ // Ensure the output directory exists
+ if (!fs.existsSync(outputDir)) {
+ fs.mkdirSync(outputDir, { recursive: true });
+ }
- // Write the content to the file
- fs.writeFileSync(outputFilePath, configContent, "utf-8");
- console.log(`tailwindConfig.ts file created at: ${outputFilePath}`);
+ // Write the content to the file
+ fs.writeFileSync(outputFilePath, configContent, "utf-8");
+ console.log(`tailwindConfig.ts file created at: ${outputFilePath}`);
+ } catch (error) {
+ console.error('Failed to build Tailwind config:', error);
+ process.exit(1);
+ }
};📝 Committable suggestion
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // Run the script | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| buildTailwindConfig(); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,32 @@ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| import * as fs from "fs"; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| import * as path from "path"; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // Paths for the output file | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const outputDir = path.join(__dirname, "../styles"); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const outputFilePath = path.join(outputDir, "main.scss"); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // Content for the main.scss file | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const generateMainScssContent = (): string => { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| return ` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| @use "./base/_colors-dark.scss" as *; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| @use "./base/_colors-light.scss" as *; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| `.trim(); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // Function to create the main.scss file | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| export const buildMainScss = (): void => { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // Generate the content | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const scssContent = generateMainScssContent(); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // Ensure the output directory exists | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| if (!fs.existsSync(outputDir)) { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| fs.mkdirSync(outputDir, { recursive: true }); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // Write the content to the file | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| fs.writeFileSync(outputFilePath, scssContent, "utf-8"); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| console.log(`main.scss file created at: ${outputFilePath}`); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+16
to
+29
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛠️ Refactor suggestion Use async/await for file operations and add proper error handling. The synchronous file operations could block the event loop. Also, file operations should have proper error handling. // Function to create the main.scss file
-export const buildMainScss = (): void => {
+export const buildMainScss = async (): Promise<void> => {
// Generate the content
const scssContent = generateMainScssContent();
// Ensure the output directory exists
if (!fs.existsSync(outputDir)) {
- fs.mkdirSync(outputDir, { recursive: true });
+ try {
+ await fs.promises.mkdir(outputDir, { recursive: true });
+ } catch (error) {
+ throw new Error(`Failed to create directory ${outputDir}: ${error.message}`);
+ }
}
// Write the content to the file
- fs.writeFileSync(outputFilePath, scssContent, "utf-8");
- console.log(`main.scss file created at: ${outputFilePath}`);
+ try {
+ await fs.promises.writeFile(outputFilePath, scssContent, "utf-8");
+ console.log(`main.scss file created at: ${outputFilePath}`);
+ } catch (error) {
+ throw new Error(`Failed to write file ${outputFilePath}: ${error.message}`);
+ }
};📝 Committable suggestion
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // Run the script | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| buildMainScss(); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,54 @@ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| import * as fs from 'fs'; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| import * as path from 'path'; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| import { hexToHsl } from './utills.js'; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // Paths for input and output files | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const inputFilePath = path.join(__dirname, '../tokens/token_Palette_Primitive.json'); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const outputFilePath = path.join(__dirname, '../styles/base/_palette.scss'); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // Generate SCSS content with groups separated by an empty line | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const generateScssContent = (tokens: Record<string, any>): string => { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const lines: string[] = []; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| for (const group in tokens) { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const groupTokens = tokens[group]; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| for (const key in groupTokens) { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const value = groupTokens[key]; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| if (value.$type === 'color') { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| lines.push(` --${group}-${key}: ${hexToHsl(value.$value)};`); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| lines.push(''); // Add an empty line after each group | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| return ` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| @layer base { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| :root { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ${lines.join('\n')} | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| `.trim(); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+10
to
+31
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛠️ Refactor suggestion Add type safety and input validation for tokens. The function lacks type definitions and validation for the token structure. +interface ColorToken {
+ $type: string;
+ $value: string;
+}
+
+interface TokenGroup {
+ [key: string]: ColorToken;
+}
+
+interface TokenData {
+ [group: string]: TokenGroup;
+}
+
-const generateScssContent = (tokens: Record<string, any>): string => {
+const generateScssContent = (tokens: TokenData): string => {
const lines: string[] = [];
for (const group in tokens) {
const groupTokens = tokens[group];
for (const key in groupTokens) {
const value = groupTokens[key];
+ if (!value || typeof value !== 'object') {
+ throw new Error(`Invalid token value for ${group}.${key}`);
+ }
if (value.$type === 'color') {
+ if (!/^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$/.test(value.$value)) {
+ throw new Error(`Invalid hex color value for ${group}.${key}: ${value.$value}`);
+ }
lines.push(` --${group}-${key}: ${hexToHsl(value.$value)};`);
}
}
lines.push(''); // Add an empty line after each group
}📝 Committable suggestion
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // Function to build and write SCSS content | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| export const buildPaletteScss = (): void => { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // Read and parse the JSON file | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const rawData = fs.readFileSync(inputFilePath, 'utf-8'); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const tokens = JSON.parse(rawData); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // Generate SCSS content | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const scssContent = generateScssContent(tokens); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // Ensure the output directory exists | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const outputDir = path.dirname(outputFilePath); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| if (!fs.existsSync(outputDir)) { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| fs.mkdirSync(outputDir, { recursive: true }); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // Write the SCSS content to the file | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| fs.writeFileSync(outputFilePath, scssContent, 'utf-8'); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| console.log(`SCSS file created at: ${outputFilePath}`); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+34
to
+51
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add error handling and improve performance. The function lacks error handling for file operations and could benefit from performance improvements. export const buildPaletteScss = (): void => {
+ try {
// Read and parse the JSON file
- const rawData = fs.readFileSync(inputFilePath, 'utf-8');
- const tokens = JSON.parse(rawData);
+ const tokens = JSON.parse(fs.readFileSync(inputFilePath, 'utf-8'));
// Generate SCSS content
const scssContent = generateScssContent(tokens);
// Ensure the output directory exists
const outputDir = path.dirname(outputFilePath);
if (!fs.existsSync(outputDir)) {
fs.mkdirSync(outputDir, { recursive: true });
}
// Write the SCSS content to the file
fs.writeFileSync(outputFilePath, scssContent, 'utf-8');
console.log(`SCSS file created at: ${outputFilePath}`);
+ } catch (error) {
+ if (error instanceof Error) {
+ console.error('Failed to build palette SCSS:', error.message);
+ } else {
+ console.error('An unknown error occurred while building palette SCSS');
+ }
+ process.exit(1);
+ }
};📝 Committable suggestion
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // Run the script | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| buildPaletteScss(); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
There 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.
🛠️ Refactor suggestion
Improve token reference resolution safety.
The current regex pattern might match unintended patterns. Consider using a more specific pattern and add input validation.
const resolveTokenReference = (value: string): string => { + if (typeof value !== 'string') { + throw new Error('Token value must be a string'); + } - return value.replace(/{(.+?)}/g, (_, match) => `var(--${match.replace(".", "-")})`); + // More specific pattern that only matches alphanumeric and dot characters + return value.replace(/{([a-zA-Z0-9.-]+)}/g, (_, match) => `var(--${match.replace(".", "-")})`); };📝 Committable suggestion