chore: re-organize project structure.

README.md

@@ -4,9 +4,11 @@ Radix Colors is a great color palette for software design and development. But i
 
 This library is intended to provide a simple way to use Radix Colors in SwiftUI. It parses the original library and generates a Swift file that contains all the colors. Alongside all colors, it also provides a set of extension variables for SwiftUI built-in Color module, which supports dynamic color (a mix of both light color and dark color for light mode and dark mode respectively).
 
-## Naming Convention
+## Usage
 
-This is a cross-language project, which contains two different naming conventions. So, when a folder is intended to be used in TypeScript, it will be named in camelCase. Otherwise, for Swift, it will be named in PascalCase.
+The file `RadixColors.swift` (located in `output` folder) is generated by parsing the original library. It contains all the colors in Radix Colors.
+
+To use Radix Colors in your SwiftUI project, simply copy the `RadixColors.swift` file into your project. The reason why we do not want to make it a Swift Package is that we want to avoid any redundant `import` statement in your code. We want you to be able to use it directly and globally, and can change some helper functions as you wish.
 
 ## Reference
 

generator/header-comment.ts

@@ -0,0 +1,12 @@
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const packageJson = require('../package.json');
+
+export const headerComment = `//
+//  RadixColors.swift
+//  version: ${packageJson.version}
+//  
+//  To update this file, visit: https://github.com/lilingxi01/radix-colors-swift
+//
+//  Created by Lingxi Li on 1/15/23.
+//
+`;

generator/index.ts

@@ -1,13 +1,14 @@
 import * as radixColors from '@radix-ui/colors';
 import fs from 'fs';
 import { helperExtensions } from './helper';
+import { headerComment } from './header-comment';
 
 /**
  * This function takes a color string (the value of each Radix Color) and convert it to Swift Color.
  * @param colorString - The value of a Radix Color
  * @return - A script of Swift Color in Swift.
  */
-function colorStringToHSL(colorString: string): string {
+function parseColorString(colorString: string): string {
   // Remove prefix and suffix.
   let parsedString = colorString
     .replace('hsl(', '')
@@ -36,8 +37,8 @@ function colorStringToHSL(colorString: string): string {
   return `Color(hue: ${h}, saturation: ${s.toFixed(3)}, brightness: ${l.toFixed(3)})`;
 }
 
-const outputDir = 'Sources/RadixColors';
-const outputFile = 'Core.swift';
+const outputDir = 'output';
+const outputFile = 'RadixColors.swift';
 
 function main() {
   // Create the output directory if it does not exist.
@@ -54,6 +55,9 @@ function main() {
   // Get all entries from Radix Colors library.
   const radixEntries = Object.entries(radixColors);
 
+  // Write the header comment.
+  logger.write(headerComment + '\n');
+
   // Write the header of the file.
   logger.write('import SwiftUI\n\n');
 
@@ -62,7 +66,7 @@ function main() {
   for (const [name, colors] of radixEntries) {
     logger.write('    class ' + name + ' {\n');
     for (const [colorName, color] of Object.entries(colors)) {
-      logger.write('        static let ' + colorName + ': Color = ' + colorStringToHSL(color) + '\n');
+      logger.write('        static let ' + colorName + ': Color = ' + parseColorString(color) + '\n');
     }
     logger.write('    }\n');
   }

Sources/RadixColors/Core.swift → output/RadixColors.swift

@@ -1,3 +1,12 @@
+//
+//  RadixColors.swift
+//  version: 1.0.0
+//  
+//  To update this file, visit: https://github.com/lilingxi01/radix-colors-swift
+//
+//  Created by Lingxi Li on 1/15/23.
+//
+
 import SwiftUI
 
 final class RadixColor {