Feat(variables-scss): Add debug option for exporter #DS-1505

exporters/variables-scss/README.md

@@ -40,5 +40,13 @@ Tokens are sorted alphabetically by origin (Figma) name or by name (Supernova).
 
 The index file contains SCSS forwards of all other outputs.
 
+## Development
+
+To generate the original unformatted data from Supernova, enable the `generateOriginalDataFiles` option in the `config.local.json` file.
+Once activated, the original data will be generated alongside other outputs and stored in the `original-data` folder.
+
+- \_original-tokens.json
+- \_original-groups.json
+
 [supernova-studio]: https://github.com/Supernova-Studio
 [alma-career]: https://github.com/lmc-eu

exporters/variables-scss/config.json

@@ -1,9 +1,9 @@
 [
   {
-    "key": "generateDisclaimer",
+    "key": "generateOriginalDataFiles",
     "type": "boolean",
     "default": false,
-    "title": "Show Generated File Disclaimer",
-    "description": "When enabled, a disclaimer showing the fact that the file was generated automatically and should not be changed manually will appear in all style styles"
+    "title": "Generate Original Data Files",
+    "description": "When enabled, the original data files will be generated in the output directory"
   }
 ]

exporters/variables-scss/config.local.json

@@ -1,3 +1,3 @@
 {
-  "generateDisclaimer": true
+  "generateOriginalDataFiles": false
 }

exporters/variables-scss/config.ts

@@ -10,5 +10,5 @@ export type ExporterConfiguration = {
    * that the file was generated automatically
    * and should not be changed manually will appear in all files
    */
-  generateDisclaimer: boolean;
+  generateOriginalDataFiles: boolean;
 };

exporters/variables-scss/src/helpers/__tests__/safeStringify.test.ts

@@ -0,0 +1,42 @@
+import { safeStringify } from '../safeStringify';
+
+type CircularObject = { [key: string]: CircularObject | unknown };
+
+describe('safeStringify', () => {
+  it('should stringify a simple object', () => {
+    const obj = { key: 'value', number: 42 };
+    const result = safeStringify(obj);
+
+    expect(result).toBe(JSON.stringify(obj, null, 2));
+  });
+
+  it('should handle circular references in objects', () => {
+    const obj: CircularObject = { key: 'value' };
+    obj.self = obj; // Introduce circular reference
+
+    const result = safeStringify(obj);
+
+    expect(result).toContain('"self": "CIRCULAR_REFERENCE"');
+  });
+
+  it('should handle nested objects with no circular references', () => {
+    const obj = { outer: { inner: { key: 'value' } } };
+    const result = safeStringify(obj);
+
+    expect(result).toBe(JSON.stringify(obj, null, 2));
+  });
+
+  it('should handle arrays within objects', () => {
+    const obj = { list: [1, 2, 3] };
+    const result = safeStringify(obj);
+
+    expect(result).toBe(JSON.stringify(obj, null, 2));
+  });
+
+  it('should handle null values', () => {
+    const obj = { key: null };
+    const result = safeStringify(obj);
+
+    expect(result).toBe(JSON.stringify(obj, null, 2));
+  });
+});

exporters/variables-scss/src/helpers/safeStringify.ts

@@ -0,0 +1,20 @@
+export const safeStringify = (obj: object) => {
+  let cache: string[] | null = [];
+  const str = JSON.stringify(
+    obj,
+    (key, value) => {
+      if (typeof value === 'object' && value !== null) {
+        if (cache?.includes(value)) {
+          return 'CIRCULAR_REFERENCE';
+        }
+        cache?.push(value);
+      }
+
+      return value;
+    },
+    2,
+  );
+  cache = null;
+
+  return str;
+};

exporters/variables-scss/src/index.ts

@@ -1,13 +1,16 @@
 import { FileHelper } from '@supernovaio/export-helpers';
 import {
   AnyOutputFile,
+  OutputTextFile,
   PulsarContext,
   RemoteVersionIdentifier,
   Supernova,
-  OutputTextFile,
 } from '@supernovaio/sdk-exporters';
 import { ExporterConfiguration } from '../config';
 import { generateOutputFilesByThemes } from './generators/fileGenerator';
+import { safeStringify } from './helpers/safeStringify';
+
+export const exportConfiguration = Pulsar.exportConfig<ExporterConfiguration>();
 
 // https://github.com/Supernova-Studio/exporters/issues/4
 // @ts-ignore-next-line
@@ -46,35 +49,13 @@ Pulsar.export(async (sdk: Supernova, context: PulsarContext): Promise<Array<AnyO
     return createTextFile(file.path, file.fileName, file.content);
   });
 
-  // TODO: Only for debugging purposes, remove for production!
-  const safeStringify = (obj: object) => {
-    let cache: string[] | null = [];
-    const str = JSON.stringify(
-      obj,
-      (key, value) => {
-        if (typeof value === 'object' && value !== null) {
-          if (cache?.includes(value)) {
-            return 'CIRCULAR_REFERENCE';
-          }
-          cache?.push(value);
-        }
-
-        return value;
-      },
-      2,
+  // Export the original data only if 'generateOriginalDataFiles' is set to true in config.local.json
+  if (exportConfiguration.generateOriginalDataFiles) {
+    textFiles.push(
+      createTextFile('./original-data/', '_original-tokens.json', safeStringify(tokens)),
+      createTextFile('./original-data/', '_original-groups.json', JSON.stringify(tokenGroups, null, 2)),
     );
-    cache = null;
-
-    return str;
-  };
-
-  // TODO: Only for debugging purposes - remove for production!
-  textFiles.push(
-    createTextFile('./original-data/', '_original-tokens.json', safeStringify(tokens)),
-    createTextFile('./original-data/', '_original-groups.json', JSON.stringify(tokenGroups, null, 2)),
-  );
+  }
 
   return textFiles;
 });
-
-export const exportConfiguration = Pulsar.exportConfig<ExporterConfiguration>();