refactor: destructure and dedupe repeated enum members

Update import enum paths for examples
amzn · Oct 29, 2024 · bea5162 · bea5162
1 parent 87cb861
commit bea5162
Show file tree

Hide file tree

Showing 78 changed files with 808 additions and 638 deletions.
diff --git a/README.md b/README.md
@@ -91,6 +91,8 @@ StyleDictionary.buildAllPlatforms();
 The `.extend()` method is an overloaded method that can also take an object with the configuration in the same format as a config.json file.
 
 ```javascript
+import { fileFormats, transformGroups } from 'style-dictionary/enums';
+
 const StyleDictionary = require('style-dictionary').extend({
   source: ['tokens/**/*.json'],
   platforms: {
@@ -294,6 +296,7 @@ The style dictionary build system is made to be extended. We don't know exactly
 
 ```javascript
 const StyleDictionary = require('style-dictionary').extend('config.json');
+import { transforms, transformTypes } from 'style-dictionary/enums';
 
 StyleDictionary.registerTransform({
   name: transforms.timeSeconds,

diff --git a/__integration__/async.test.js b/__integration__/async.test.js
@@ -22,7 +22,7 @@ import { transforms, propertyFormatNames, transformTypes } from '../lib/enums/in
 const sleep = async (time) => {
   await new Promise((resolve) => setTimeout(resolve, time));
 };
-
+const { attributeCti, nameKebab, timeSeconds, htmlIcon, sizeRem, colorCss } = transforms;
 const textFile = resolve(`${buildPath}text.txt`);
 
 // Tests all hooks async, into a single config
@@ -101,12 +101,12 @@ describe('integration', async function () {
       platforms: {
         css: {
           transforms: [
-            transforms.attributeCti,
-            transforms.nameKebab,
-            transforms.timeSeconds,
-            transforms.htmlIcon,
-            transforms.sizeRem,
-            transforms.colorCss,
+            attributeCti,
+            nameKebab,
+            timeSeconds,
+            htmlIcon,
+            sizeRem,
+            colorCss,
             'foo-value-transform',
           ],
           buildPath,

diff --git a/__integration__/compose.test.js b/__integration__/compose.test.js
@@ -18,6 +18,8 @@ import { buildPath } from './_constants.js';
 import { clearOutput } from '../__tests__/__helpers.js';
 import { fileFormats } from '../lib/enums/index.js';
 
+const { composeObject } = fileFormats;
+
 describe('integration', async () => {
   before(async () => {
     const sd = new StyleDictionary({
@@ -29,15 +31,15 @@ describe('integration', async () => {
           files: [
             {
               destination: 'StyleDictionary.kt',
-              format: fileFormats.composeObject,
+              format: composeObject,
               options: {
                 className: 'StyleDictionary',
                 packageName: 'com.example.tokens',
               },
             },
             {
               destination: 'StyleDictionaryWithReferences.kt',
-              format: fileFormats.composeObject,
+              format: composeObject,
               options: {
                 outputReferences: true,
                 className: 'StyleDictionary',

diff --git a/__integration__/css.test.js b/__integration__/css.test.js
@@ -18,6 +18,8 @@ import { buildPath } from './_constants.js';
 import { clearOutput } from '../__tests__/__helpers.js';
 import { fileFormats, transformGroups } from '../lib/enums/index.js';
 
+const { cssVariables } = fileFormats;
+
 describe('integration', async () => {
   before(async () => {
     const sd = new StyleDictionary({
@@ -39,30 +41,30 @@ describe('integration', async () => {
           files: [
             {
               destination: 'variables.css',
-              format: fileFormats.cssVariables,
+              format: cssVariables,
               options: {
                 formatting: { indentation: '    ' },
               },
             },
             {
               destination: 'variablesWithReferences.css',
-              format: fileFormats.cssVariables,
+              format: cssVariables,
               options: {
                 outputReferences: true,
                 outputReferenceFallbacks: false,
               },
             },
             {
               destination: 'variablesWithReferenceFallbacks.css',
-              format: fileFormats.cssVariables,
+              format: cssVariables,
               options: {
                 outputReferences: true,
                 outputReferenceFallbacks: true,
               },
             },
             {
               destination: 'variablesWithSelector.css',
-              format: fileFormats.cssVariables,
+              format: cssVariables,
               options: {
                 selector: '.test',
               },
@@ -79,7 +81,7 @@ describe('integration', async () => {
   });
 
   describe('css', async () => {
-    describe(fileFormats.cssVariables, async () => {
+    describe(cssVariables, async () => {
       it(`should match snapshot`, async () => {
         const output = fs.readFileSync(resolve(`${buildPath}variables.css`), {
           encoding: 'UTF-8',

diff --git a/__integration__/customFormats.test.js b/__integration__/customFormats.test.js
@@ -18,6 +18,8 @@ import { buildPath } from './_constants.js';
 import { clearOutput } from '../__tests__/__helpers.js';
 import { transformGroups } from '../lib/enums/index.js';
 
+const { js } = transformGroups;
+
 describe('integration', async () => {
   before(async () => {
     const sd = new StyleDictionary({
@@ -35,7 +37,7 @@ describe('integration', async () => {
       },
       platforms: {
         inlineCustomFormats: {
-          transformGroup: transformGroups.js,
+          transformGroup: js,
           buildPath,
           options: {
             otherOption: `platform option`,
@@ -60,7 +62,7 @@ describe('integration', async () => {
           ],
         },
         customFormats: {
-          transformGroup: transformGroups.js,
+          transformGroup: js,
           buildPath,
           options: {
             otherOption: `platform option`,

diff --git a/__integration__/flutter.test.js b/__integration__/flutter.test.js
@@ -18,6 +18,8 @@ import { buildPath } from './_constants.js';
 import { clearOutput } from '../__tests__/__helpers.js';
 import { fileFormats } from '../lib/enums/index.js';
 
+const { flutterClassDart } = fileFormats;
+
 describe('integration', async () => {
   before(async () => {
     const sd = new StyleDictionary({
@@ -29,14 +31,14 @@ describe('integration', async () => {
           files: [
             {
               destination: 'style_dictionary.dart',
-              format: fileFormats.flutterClassDart,
+              format: flutterClassDart,
               options: {
                 className: 'StyleDictionary',
               },
             },
             {
               destination: 'style_dictionary_with_references.dart',
-              format: fileFormats.flutterClassDart,
+              format: flutterClassDart,
               options: {
                 outputReferences: true,
                 className: 'StyleDictionary',
@@ -50,7 +52,7 @@ describe('integration', async () => {
           files: [
             {
               destination: 'style_dictionary_color.dart',
-              format: fileFormats.flutterClassDart,
+              format: flutterClassDart,
               options: {
                 className: 'StyleDictionaryColor',
                 type: 'color',
@@ -61,7 +63,7 @@ describe('integration', async () => {
             },
             {
               destination: 'style_dictionary_sizes.dart',
-              format: fileFormats.flutterClassDart,
+              format: flutterClassDart,
               options: {
                 className: 'StyleDictionarySize',
                 type: 'float',

diff --git a/__integration__/iOSObjectiveC.test.js b/__integration__/iOSObjectiveC.test.js
@@ -18,6 +18,9 @@ import { buildPath } from './_constants.js';
 import { clearOutput } from '../__tests__/__helpers.js';
 import { fileFormats } from '../lib/enums/index.js';
 
+const { iosColorsH, iosColorsM, iosMacros, iosSingletonH, iosSingletonM, iosStaticH, iosStaticM } =
+  fileFormats;
+
 describe('integration', async () => {
   before(async () => {
     const sd = new StyleDictionary({
@@ -29,21 +32,21 @@ describe('integration', async () => {
           files: [
             {
               destination: 'singleton.m',
-              format: fileFormats.iosSingletonM,
+              format: iosSingletonM,
               options: {
                 className: 'StyleDictionary',
               },
             },
             {
               destination: 'singleton.h',
-              format: fileFormats.iosSingletonH,
+              format: iosSingletonH,
               options: {
                 className: 'StyleDictionary',
               },
             },
             {
               destination: 'color.h',
-              format: fileFormats.iosColorsH,
+              format: iosColorsH,
               options: {
                 className: 'StyleDictionaryColor',
                 type: 'StyleDictionaryColorName',
@@ -52,7 +55,7 @@ describe('integration', async () => {
             },
             {
               destination: 'color.m',
-              format: fileFormats.iosColorsM,
+              format: iosColorsM,
               options: {
                 className: 'StyleDictionaryColor',
                 type: 'StyleDictionaryColorName',
@@ -61,11 +64,11 @@ describe('integration', async () => {
             },
             {
               destination: 'macros.h',
-              format: fileFormats.iosMacros,
+              format: iosMacros,
             },
             {
               destination: 'static.h',
-              format: fileFormats.iosStaticH,
+              format: iosStaticH,
               options: {
                 className: 'StyleDictionaryStatic',
                 type: 'CGFloat',
@@ -74,7 +77,7 @@ describe('integration', async () => {
             },
             {
               destination: 'static.m',
-              format: fileFormats.iosStaticM,
+              format: iosStaticM,
               options: {
                 className: 'StyleDictionaryStatic',
                 type: 'CGFloat',

diff --git a/__integration__/logging/config.test.js b/__integration__/logging/config.test.js
@@ -17,6 +17,8 @@ import { buildPath, cleanConsoleOutput } from '../_constants.js';
 import { clearOutput } from '../../__tests__/__helpers.js';
 import { logWarningLevels, logVerbosityLevels } from '../../lib/enums/index.js';
 
+const { error: errorLog, disabled } = logWarningLevels;
+
 /**
  * These integration tests will verify the behavior and logging at the *config*
  * level. These messages happen when `.extend()` is called to verify
@@ -71,7 +73,7 @@ describe(`integration >`, () => {
         it(`should not log anything if the log warnings is set to disabled`, async () => {
           const sd = new StyleDictionary({
             log: {
-              warnings: logWarningLevels.disabled,
+              warnings: disabled,
             },
             source: [
               // including a specific file twice will throw value collision warnings
@@ -87,7 +89,7 @@ describe(`integration >`, () => {
         it(`should not show warnings if given higher log level`, async () => {
           const sd = new StyleDictionary(
             {
-              log: { warnings: logWarningLevels.error },
+              log: { warnings: errorLog },
               source: [
                 // including a specific file twice will throw value collision warnings
                 `__integration__/tokens/size/padding.json`,