refactor customFileHeader

- migrate to style-dictionary v4.x format - change customFileHeader directory structure - declare FileHeader type from style-dictionary in global scope Signed-off-by: Tobias Kuppens Groot <[email protected]>
flock-community · Jan 31, 2025 · a0f6ed2 · a0f6ed2
1 parent 08e0477
commit a0f6ed2
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 14 deletions.
diff --git a/src/config.js b/src/config.js
@@ -3,7 +3,7 @@ import {
 	BUILD_PATH_JS,
 	TOKENS_FILE_PATH,
 } from "../config.js";
-import { fileHeader } from "./formats/file-headers/register.js";
+import { fileHeader } from "./formats/file-headers/customFileHeader.js";
 
 export default {
 	source: [TOKENS_FILE_PATH],

diff --git a/src/formats/file-headers/customFileHeader.js b/src/formats/file-headers/customFileHeader.js
@@ -0,0 +1,11 @@
+/** @type {FileHeader} */
+function fileHeader() {
+	return ["Do not edit directly. File has been generated"];
+}
+
+const customFileHeader = {
+	name: "customFileHeader",
+	fileHeader,
+};
+
+export { customFileHeader, fileHeader };
diff --git a/src/formats/file-headers/index.js b/src/formats/file-headers/index.js
@@ -0,0 +1 @@
+export { customFileHeader } from "./customFileHeader.js";
diff --git a/src/formats/file-headers/register.js b/src/formats/file-headers/register.js
diff --git a/types/style-dictionary.d.ts b/types/style-dictionary.d.ts
@@ -0,0 +1,5 @@
+import type { FileHeader as _FileHeader } from "style-dictionary/types";
+
+declare global {
+	export { _FileHeader as FileHeader };
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		export { customFileHeader } from "./customFileHeader.js";