Merge pull request #1254 from basics/feature/type-generation-font-options

refactor(types): use font option for type generation

Author: ThornWalli

src/module.ts

@@ -169,7 +169,7 @@ async function addBuildTemplates(nuxt: Nuxt, options: ModuleOptions) {
 
   addTypeTemplate({
     filename: 'types/booster.d.ts',
-    getContents: () => getTypesContent(fontConfig),
+    getContents: () => getTypesContent(options.fonts || []),
     write: true
   });
 }

src/utils/types.ts

@@ -1,5 +1,4 @@
-import type FontConfig from '../classes/FontConfig';
-import type { FontOptionVariance } from '../types';
+import type { FontOption, FontOptionVariance } from '../types';
 
 /* eslint-disable security/detect-object-injection */
 interface TextProperties {
@@ -10,14 +9,14 @@ interface TextProperties {
 }
 
 function getFromVariances<T>(
-  fontConfig: FontConfig,
+  fonts: FontOption[],
   key: keyof FontOptionVariance
 ): T[] {
   const uniqueStyles = new Set<T>();
-  const fontCount = fontConfig.fonts.length;
+  const fontCount = fonts.length;
 
   for (let i = 0; i < fontCount; i++) {
-    const values = fontConfig.fonts[i].variances;
+    const values = fonts[i].variances;
     for (let j = 0, valueCount = values.length; j < valueCount; j++) {
       uniqueStyles.add(values[j][key] as T);
     }
@@ -50,19 +49,22 @@ function generateAliases(textProperties: TextProperties): string {
       // Merge all values into a union (|) type value.
       const values: string[] = new Array(valueCount);
       for (let j = 0; j < valueCount; j++) {
-        values[j] = `'${propValues[j]}'`;
+        if (/\d+/.test(String(propValues[j]))) {
+          values[j] = String(propValues[j]);
+        } else {
+          values[j] = `'${propValues[j]}'`;
+        }
       }
       output[i] = `${line}${values.join(' | ')};`;
     }
   }
   return output.join('\n');
 }
 
-export function getTypesContent(fontConfig: FontConfig): string {
+export function getTypesContent(fonts: FontOption[]): string {
   return generateAliases({
-    family: unique(fontConfig.fonts.map(font => font.family)),
-    weight: getFromVariances(fontConfig, 'weight'),
-    style: getFromVariances(fontConfig, 'style')
+    family: unique(fonts.map(font => font.family)),
+    weight: getFromVariances(fonts, 'weight'),
+    style: getFromVariances(fonts, 'style')
   });
 }
-/* eslint-enable security/detect-object-injection */

test/tests/utils/getTypesContent.test.ts

@@ -4,48 +4,46 @@ import { getTypesContent } from '../../../src/utils/types';
 describe('getTypesContent', () => {
   it('generates generic types on empty font config', () => {
     expect(
-      getTypesContent({
-        fonts: [
-          {
-            family: '',
-            variances: [
-              {
-                style: '',
-                weight: 0,
-                sources: []
-              }
-            ]
-          }
-        ]
-      })
+      getTypesContent([
+        {
+          family: '',
+          fallback: [],
+          variances: [
+            {
+              style: '',
+              weight: 0,
+              sources: []
+            }
+          ]
+        }
+      ])
     ).toBe(
       "export type FontFamily = 'string';\nexport type FontWeight = 'string';\nexport type FontStyle = 'string';"
     );
   });
 
   it('generates proper types on valid font config', () => {
     expect(
-      getTypesContent({
-        fonts: [
-          {
-            family: 'Roboto',
-            variances: [
-              {
-                style: 'italic',
-                weight: 400,
-                sources: []
-              },
-              {
-                style: 'normal',
-                weight: 'bold',
-                sources: []
-              }
-            ]
-          }
-        ]
-      })
+      getTypesContent([
+        {
+          family: 'Roboto',
+          fallback: [],
+          variances: [
+            {
+              style: 'italic',
+              weight: 400,
+              sources: []
+            },
+            {
+              style: 'normal',
+              weight: 'bold',
+              sources: []
+            }
+          ]
+        }
+      ])
     ).toBe(
-      "export type FontFamily = 'Roboto';\nexport type FontWeight = '400' | 'bold';\nexport type FontStyle = 'italic' | 'normal';"
+      "export type FontFamily = 'Roboto';\nexport type FontWeight = 400 | 'bold';\nexport type FontStyle = 'italic' | 'normal';"
     );
   });
 });