Merge pull request #50 from lukasoppermann/v4.15

V4.15

__tests__/build.test.md → __tests__/build.test.js

@@ -1,5 +1,5 @@
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const StyleDictionary = require("../dist");
+import StyleDictionary from "../dist-cjs/index.js";
 
 describe('index.js', () => {  
   it("all formats are attached", () => {

__tests__/format/javascript-commonJs.test.ts

@@ -23,7 +23,7 @@ describe('Format: CommonJs', () => {
     }
   }
 
-  it('Formats tokens adding prefix', () => {
+  it('Formats tokens adding prefix', async () => {
     const output = `exports.default = {
   test: {
     colors: {
@@ -32,24 +32,24 @@ describe('Format: CommonJs', () => {
   },
 };
 `
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore: fake values to test formatter
-    expect(javascriptCommonJs({dictionary, file, options: undefined, platform})).toStrictEqual(output)
+    // @ts-expect-error: fake values to test formatter
+    const result = await javascriptCommonJs({ dictionary, file, options: undefined, platform })
+    expect(result).toStrictEqual(output)
   })
 
-  it('Formats tokens without prefix', () => {
+  it('Formats tokens without prefix', async () => {
     const output = `exports.default = {
   colors: {
     red: "#FF0000",
   },
 };
 `
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore: fake values to test formatter
-    expect(javascriptCommonJs({dictionary, file, options: undefined, undefined})).toStrictEqual(output)
+    // @ts-expect-error: fake values to test formatter
+    const result = await javascriptCommonJs({ dictionary, file, options: undefined, undefined })
+    expect(result).toStrictEqual(output)
   })
 
-  it('Formats tokens accepting a custom prettier configuration', () => {
+  it('Formats tokens accepting a custom prettier configuration', async () => {
     const output = `exports.default = {
   colors: {
     red: '#FF0000',
@@ -60,9 +60,9 @@ describe('Format: CommonJs', () => {
       singleQuote: true
     }
 
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore: fake values to test formatter
-    expect(javascriptCommonJs({dictionary, file, options: {prettier}, undefined})).toStrictEqual(output)
+    // @ts-expect-error: fake values to test formatter
+    const result = await javascriptCommonJs({ dictionary, file, options: { prettier }, undefined })
+    expect(result).toStrictEqual(output)
   })
 
 })

__tests__/format/javascript-esm.test.ts

@@ -23,7 +23,7 @@ describe('Format: ESM', () => {
     }
   }
 
-  it('Formats tokens adding prefix', () => {
+  it('Formats tokens adding prefix', async () => {
     const output = `export default {
   test: {
     colors: {
@@ -32,24 +32,24 @@ describe('Format: ESM', () => {
   },
 };
 `
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore: fake values to test formatter
-    expect(javascriptEsm({dictionary, file, options: undefined, platform})).toStrictEqual(output)
+    // @ts-expect-error: fake values to test formatter
+    const result = await javascriptEsm({ dictionary, file, options: undefined, platform })
+    expect(result).toStrictEqual(output)
   })
 
-  it('Formats tokens without prefix', () => {
+  it('Formats tokens without prefix', async () => {
     const output = `export default {
   colors: {
     red: "#FF0000",
   },
 };
 `
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore: fake values to test formatter
-    expect(javascriptEsm({dictionary, file, options: undefined, undefined})).toStrictEqual(output)
+    // @ts-expect-error: fake values to test formatter
+    const result = await javascriptEsm({ dictionary, file, options: undefined, undefined })
+    expect(result).toStrictEqual(output)
   })
 
-  it('Formats tokens accepting a custom prettier configuration', () => {
+  it('Formats tokens accepting a custom prettier configuration', async () => {
     const output = `export default {
   colors: {
     red: '#FF0000',
@@ -59,10 +59,9 @@ describe('Format: ESM', () => {
     const prettier = {
       singleQuote: true
     }
-
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore: fake values to test formatter
-    expect(javascriptEsm({dictionary, file, options: {prettier}, undefined})).toStrictEqual(output)
+    // @ts-expect-error: fake values to test formatter
+    const result = await javascriptEsm({ dictionary, file, options: { prettier }, undefined })
+    expect(result).toStrictEqual(output)
   })
 
 })

package.json

@@ -33,7 +33,7 @@
     "test": "NODE_OPTIONS=--experimental-vm-modules npx jest && npm run lint && tsc --noEmit",
     "lint": "npx eslint . --ext .ts",
     "fix": "npx eslint . --ext .ts --fix",
-    "clean:dist": "rm -rf dist/",
+    "clean:dist": "rm -rf dist/ && rm -rf dist-cjs/",
     "prebuild": "npm run clean:dist",
     "build": "tsc && tsc -p tsconfig-esm.json",
     "preversion": "npm run build && npm run test",
@@ -65,6 +65,6 @@
     "typescript": "^5.1.6"
   },
   "peerDependencies": {
-    "style-dictionary": "4.0.0-prerelease.14"
+    "style-dictionary": "4.0.0-prerelease.15"
   }
 }

src/format/javascript-commonJs.ts

@@ -6,11 +6,11 @@ import { jsonToNestedValue } from '../utilities/jsonToNestedValue.js'
 
 const { fileHeader } = StyleDictionary.formatHelpers
 
-export const javascriptCommonJs: Format['formatter'] = ({ dictionary, file, options, platform = {} }) => {
+export const javascriptCommonJs: Format['formatter'] = async ({ dictionary, file, options, platform = {} }) => {
   const { prefix } = platform
   const tokens = prefix ? { [prefix]: dictionary.tokens } : dictionary.tokens
   //
-  const output = fileHeader({ file }) +
+  const output = await fileHeader({ file }) +
     `exports.default = ${JSON.stringify(jsonToNestedValue(tokens), null, 2)}\n`
   // return prettified
   return syncPrettier.format(output, { parser: 'typescript', printWidth: 500, ...options?.prettier })

src/format/javascript-esm.ts

@@ -6,11 +6,11 @@ import { jsonToNestedValue } from '../utilities/jsonToNestedValue.js'
 
 const { fileHeader } = StyleDictionary.formatHelpers
 
-export const javascriptEsm: Format['formatter'] = ({ dictionary, file, options, platform = {} }) => {
+export const javascriptEsm: Format['formatter'] = async ({ dictionary, file, options, platform = {} }) => {
   const { prefix } = platform
   const tokens = prefix ? { [prefix]: dictionary.tokens } : dictionary.tokens
   //
-  const output = fileHeader({ file }) +
+  const output = await fileHeader({ file }) +
     `export default \n${JSON.stringify(jsonToNestedValue(tokens), null, 2)}\n`
   // return prettified
   return syncPrettier.format(output, { parser: 'typescript', printWidth: 500, ...options?.prettier })