0.22.9 - simplify setup process, bump bun version

Author: jalexw

.github/workflows/build-test-and-publish.yml

@@ -8,6 +8,9 @@ on:
 permissions:
   packages: write
 
+env:
+  BUN_VERSION: 1.2.22
+
 jobs:
   build-test-and-publish:
     name: "Build, test, & publish package"
@@ -18,7 +21,7 @@ jobs:
       - name: Setup Bun
         uses: oven-sh/setup-bun@v2
         with:
-          bun-version: 1.2.21
+          bun-version: ${{ env.BUN_VERSION }}
       - name: Install dependencies with Bun
         run: bun install
       - name: Build package with Bun

README.md

@@ -11,12 +11,25 @@ Package containing code for building TailwindCSS themes that contain SchemaVault
 The generated TailwindCSS config sets colors based on CSS variables. It's important that `globals.css` is imported, so that these colors can be resolved. E.g. `var(--foreground)` and `var(--card)` become functional after this CSS import.
 
 ```javascript
-import "@schemavaults/theme/dist/globals.css"
+import "@schemavaults/theme/globals.css"
 ```
 
 ### Import and run the TailwindCSS Config Factory from your `tailwind.config.mjs` or `tailwind.config.ts`
 
-```javascript
+#### Simple Example
+```typescript
+import { SchemaVaultsTailwindConfigFactory } from "@schemavaults/theme";
+const config = new SchemaVaultsTailwindConfigFactory().createConfig({
+  content: [
+    "./src/**/*.tsx|jsx|js|ts",
+    "@schemavaults/ui", // resolved and converted to an absolute path to the schemavaults package in the node_modules folder
+  ],
+});
+export default config;
+```
+
+#### More complex example
+```typescript
 // Import the config factory
 import { SchemaVaultsTailwindConfigFactory } from "@schemavaults/theme";
 import { join } from "path";

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@schemavaults/theme",
   "description": "TailwindCSS theme shared by different SchemaVaults applications",
-  "version": "0.22.8",
+  "version": "0.22.9",
   "private": false,
   "license": "UNLICENSED",
   "repository": {
@@ -19,8 +19,8 @@
     "@types/react": "19.0.0",
     "@types/react-dom": "19.0.0",
     "tsc-alias": "1.8.16",
-    "bun-types": "1.2.21",
-    "typescript": "5.9.2",
+    "bun-types": "1.2.22",
+    "typescript": "5.9.3",
     "ignore-loader": "0.1.2",
     "tailwindcss": "3.4.17"
   },
@@ -69,5 +69,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "packageManager": "bun@1.2.21"
+  "packageManager": "bun@1.2.22"
 }

src/TailwindConfigFactory.test.ts

@@ -58,4 +58,12 @@ describe("SchemaVaultsTailwindConfigFactory", () => {
     });
     expect(typeof config === "object").toBeTrue();
   });
+
+  test("can create a config factory without any options", () => {
+    const factory = new SchemaVaultsTailwindConfigFactory();
+    const config = factory.createConfig({
+      content: ["./src/**/*.ts|tsx|js|jsx"],
+    });
+    expect(typeof config === "object").toBeTrue();
+  });
 });

src/TailwindConfigFactory.ts

@@ -12,17 +12,18 @@ type OsJoinFn = (
   path_segment: string,
   ...remaining_path_segments: string[]
 ) => string;
+import { lstatSync } from "fs";
 
 // TailwindCSS Plugins:
 import tailwindAnimatePlugin from "@/plugins/tailwindcss-animate";
 
 export interface ISchemaVaultsTailwindConfigFactoryInitOptions {
   debug?: boolean;
-  join: OsJoinFn;
+  join?: OsJoinFn;
   // Path (or fn that resolves to a path) to node_modules for application
-  node_modules: string | (() => string);
+  node_modules?: string | (() => string);
   // Checks whether a path is a directory (e.g. lstatSync(file).isDirectory())
-  isdir: (path: string) => boolean;
+  isdir?: (path: string) => boolean;
   scope?: string;
   // A list of file extensions that should be considered/searched for TailwindCSS className usage. Defaults to ts/tsx/js/jsx
   fileExtensions?: readonly string[];
@@ -66,26 +67,76 @@ export class SchemaVaultsTailwindConfigFactory
 
   protected readonly fileExtensionsToIncludeInTailwindClassNamesSearch: readonly string[];
 
-  public constructor(opts: ISchemaVaultsTailwindConfigFactoryInitOptions) {
+  private static defaultJoinImplementation(
+    path_segment: string,
+    ...remaining_path_segments: string[]
+  ): string {
+    const path_segments: readonly string[] = [
+      path_segment,
+      ...remaining_path_segments,
+    ];
+    return path_segments.join("/");
+  }
+
+  private static defaultIsDirImplementation(maybeDirPath: string): boolean {
+    return lstatSync(maybeDirPath).isDirectory();
+  }
+
+  private static getDefaultResolveNodeModulesDirectoryPathImplementation(
+    join: OsJoinFn,
+    isdir: (dir: string) => boolean,
+  ): () => string {
+    const cwd = process.cwd();
+
+    if (isdir(join(cwd, "node_modules"))) {
+      return (): string => join(cwd, "node_modules");
+    } else if (isdir(join(cwd, "..", "node_modules"))) {
+      return (): string => join(cwd, "..", "node_modules");
+    } else if (isdir(join(cwd, "..", "..", "node_modules"))) {
+      return () => join(cwd, "..", "..", "node_modules");
+    } else {
+      console.error(
+        "Failed to resolve path to 'node_modules' directory from SchemaVaultsTailwindConfigFactory!",
+      );
+      console.error(
+        "You can pass a custom resolver function to the config factory constructor to fix this!",
+      );
+      process.exit(1);
+    }
+  }
+
+  public constructor(opts?: ISchemaVaultsTailwindConfigFactoryInitOptions) {
     this.debug = opts?.debug ?? false;
     if (this.debug) {
       console.log("[SchemaVaultsTailwindConfigFactory] constructor()");
     }
-    this.join = opts.join;
+    this.join =
+      typeof opts?.join === "function"
+        ? opts.join
+        : SchemaVaultsTailwindConfigFactory.defaultJoinImplementation;
+    this.isdir =
+      typeof opts?.isdir === "function"
+        ? opts.isdir
+        : SchemaVaultsTailwindConfigFactory.defaultIsDirImplementation;
+
     this.node_modules_path =
-      typeof opts.node_modules === "string"
+      typeof opts?.node_modules === "string"
         ? opts.node_modules
-        : opts.node_modules();
-    this.isdir = opts.isdir;
-    this.scope = opts.scope ?? DefaultOrgScope;
+        : typeof opts?.node_modules === "function"
+          ? opts.node_modules()
+          : SchemaVaultsTailwindConfigFactory.getDefaultResolveNodeModulesDirectoryPathImplementation(
+              this.join,
+              this.isdir,
+            )();
+    this.scope = opts?.scope ?? DefaultOrgScope;
     if (this.scope.startsWith("@")) {
       throw new Error(
         "Don't pass the @ in the scope, we'll handle adding passing that!",
       );
     }
 
     this.fileExtensionsToIncludeInTailwindClassNamesSearch = Array.isArray(
-      opts.fileExtensions,
+      opts?.fileExtensions,
     )
       ? opts.fileExtensions
       : SchemaVaultsTailwindConfigFactory.defaultFileExtensionsToSearch;