update dir and file imports to new fsDir and fsFile names

Author: yleflour

packages/fs-cache/README.md

@@ -45,9 +45,9 @@ pnpm add @synstack/fs-cache
 Cache directory can be initialized using an `FsDir` instance:
 
 ```typescript
-import { dir } from "@synstack/fs";
+import { fsDir } from "@synstack/fs";
 
-const cacheDir = dir(".cache");
+const cacheDir = fsDir(".cache");
 const cache = fsCache(cacheDir);
 ```
 

packages/fs-cache/src/fs-cache.lib.test.ts

@@ -1,9 +1,9 @@
-import { dir } from "@synstack/fs";
+import { fsDir } from "@synstack/fs";
 import assert from "node:assert/strict";
 import { afterEach, describe, it } from "node:test";
 import { fsCache } from "./fs-cache.lib.ts";
 
-const TMP_DIR = dir(import.meta.dirname).to("tmp");
+const TMP_DIR = fsDir(import.meta.dirname).to("tmp");
 
 describe("FsCache", () => {
   afterEach(async () => {

packages/fs-cache/src/fs-cache.lib.ts

@@ -1,4 +1,4 @@
-import { dir, FsDir } from "@synstack/fs";
+import { fsDir, FsDir } from "@synstack/fs";
 import { type OneToN } from "../../shared/src/ts.utils.ts";
 import { deepEqual } from "./deepEqual.lib.ts";
 
@@ -82,7 +82,7 @@ export class FsCache<
     args: TFnArgs,
   ) {
     const relativePath = FsCache.keyToRelativePath(this._config.key, args);
-    const cacheDir = dir(this._config.cwd);
+    const cacheDir = fsDir(this._config.cwd);
     const file = cacheDir.file(relativePath);
 
     if (!(await file.exists())) {
@@ -105,7 +105,7 @@ export class FsCache<
     args: TFnArgs,
   ): Promise<["miss", null] | ["hit", TValue]> {
     const relativePath = FsCache.keyToRelativePath(this._config.key, args);
-    const cacheDir = dir(this._config.cwd);
+    const cacheDir = fsDir(this._config.cwd);
 
     if (!(await cacheDir.file(relativePath).exists())) return ["miss", null];
 
@@ -140,7 +140,7 @@ export class FsCache<
     value: any,
   ) {
     const relativePath = FsCache.keyToRelativePath(this._config.key, args);
-    const file = dir(this._config.cwd).file(relativePath);
+    const file = fsDir(this._config.cwd).file(relativePath);
     return file.write.text(
       JSON.stringify(
         {

packages/fs/README.md

@@ -9,8 +9,10 @@ This package provides a strongly-typed, chainable, and immutable API for file sy
 Turn verbose file operations into chainable, immutable, and strongly-typed commands:
 
 ```typescript
+import { fsDir } from "@synstack/fs";
+
 // Chain directory and file operations
-const srcDir = dir("./src");
+const srcDir = fsDir("./src");
 
 // Recursively create directories
 await srcDir.to("dist/assets/images").make();
@@ -72,10 +74,10 @@ Create and work with files using the `file()` function:
 #### Basic Operations
 
 ```typescript
-import { file } from "@synstack/fs";
+import { fsFile } from "@synstack/fs";
 
 // Create a file instance
-const myFile = file("/path/to/file.txt");
+const myFile = fsFile("/path/to/file.txt");
 
 // Check file existence
 await myFile.exists(); // Promise<boolean>
@@ -97,7 +99,7 @@ myFile.creationDateSync(); // Date
 #### Path Operations
 
 ```typescript
-const myFile = file("/path/to/file.txt");
+const myFile = fsFile("/path/to/file.txt");
 
 // Get path information
 myFile.path; // "/path/to/file.txt"
@@ -170,10 +172,11 @@ await myFile.write.mode("overwrite").text("content"); // Default behavior
 #### Schema Validation
 
 ```typescript
+import { fsFile } from "@synstack/fs";
 import { z } from "zod";
 
 const schema = z.object({ name: z.string() });
-const configFile = file("config.json").schema(schema);
+const configFile = fsFile("config.json").schema(schema);
 
 // Read with validation
 const config = await configFile.read.json();
@@ -188,9 +191,9 @@ Work with directories using the `dir()` function:
 #### Basic Operations
 
 ```typescript
-import { dir } from "@synstack/fs";
+import { fsDir } from "@synstack/fs";
 
-const myDir = dir("/path/to/directory");
+const myDir = fsDir("/path/to/directory");
 
 // Check existence
 await myDir.exists(); // Promise<boolean>
@@ -251,14 +254,14 @@ await myDir.exec`echo "Hello, world!"`;
 Work with collections of files using powerful array methods:
 
 ```typescript
-import { dir, files } from "@synstack/fs";
+import { fsDir, fsFiles } from "@synstack/fs";
 
 // Create from directory
-const sourceDir = dir("./src");
+const sourceDir = fsDir("./src");
 const fileArray = await sourceDir.glob("**/*");
 
 // Create from paths
-const customArray = files(["/path/to/file1.txt", "/path/to/file2.txt"]);
+const customArray = fsFiles(["/path/to/file1.txt", "/path/to/file2.txt"]);
 
 // Filtering
 fileArray.filter((file) => file.fileExtension() === ".ts");

packages/fs/src/dir.lib.ts

@@ -23,7 +23,7 @@ export class FsDir extends Pipeable<FsDir> {
    * @returns The absolute path of the directory as a string
    *
    * ```typescript
-   * const srcDir = dir("./src");
+   * const srcDir = fsDir("./src");
    * console.log(srcDir.toString()); // "/absolute/path/to/src"
    * ```
    */
@@ -56,7 +56,7 @@ export class FsDir extends Pipeable<FsDir> {
    * @returns The absolute path as a string
    *
    * ```typescript
-   * const srcDir = dir("./src");
+   * const srcDir = fsDir("./src");
    * console.log(srcDir.path); // "/absolute/path/to/src"
    * ```
    */
@@ -95,13 +95,13 @@ export class FsDir extends Pipeable<FsDir> {
    *
    * ```typescript
    * // Create from absolute path
-   * const rootDir = dir("/path/to/project");
+   * const rootDir = fsDir("/path/to/project");
    *
    * // Create from relative path
-   * const srcDir = dir("./src");
+   * const srcDir = fsDir("./src");
    *
    * // Create from existing directory
-   * const existingDir = dir(dir("/path/to/existing"));
+   * const existingDir = fsDir(fsDir("/path/to/existing"));
    * ```
    */
   public static cwd(this: void, arg: FsDir | AnyPath): FsDir;
@@ -118,7 +118,7 @@ export class FsDir extends Pipeable<FsDir> {
    * @returns A new FsDir instance representing the combined path
    *
    * ```typescript
-   * const projectDir = dir("/path/to/project");
+   * const projectDir = fsDir("/path/to/project");
    *
    * // Navigate to subdirectories
    * const srcDir = projectDir.toDir("src");
@@ -141,7 +141,7 @@ export class FsDir extends Pipeable<FsDir> {
    * @returns A new FsDir instance representing the combined path
    *
    * ```typescript
-   * const projectDir = dir("/path/to/project");
+   * const projectDir = fsDir("/path/to/project");
    *
    * // Navigate to subdirectories
    * const srcDir = projectDir.to("src");
@@ -164,7 +164,7 @@ export class FsDir extends Pipeable<FsDir> {
    * @throws If an absolute path is provided
    *
    * ```typescript
-   * const srcDir = dir("./src");
+   * const srcDir = fsDir("./src");
    *
    * // Access files in the directory
    * const configFile = srcDir.toFile("config.json");
@@ -193,7 +193,7 @@ Trying to access a dir file from an absolute paths:
    * @throws If an absolute path is provided
    *
    * ```typescript
-   * const srcDir = dir("./src");
+   * const srcDir = fsDir("./src");
    *
    * // Access files in the directory
    * const configFile = srcDir.file("config.json");
@@ -213,7 +213,7 @@ Trying to access a dir file from an absolute paths:
    * @returns The directory name without the full path
    *
    * ```typescript
-   * const srcDir = dir("/path/to/project/src");
+   * const srcDir = fsDir("/path/to/project/src");
    * console.log(srcDir.name()); // "src"
    * ```
    */
@@ -227,7 +227,7 @@ Trying to access a dir file from an absolute paths:
    * @returns A promise that resolves to true if the directory exists, false otherwise
    *
    * ```typescript
-   * const configDir = dir("./config");
+   * const configDir = fsDir("./config");
    *
    * if (await configDir.exists()) {
    *   // Directory exists, safe to use
@@ -252,7 +252,7 @@ Trying to access a dir file from an absolute paths:
    * @returns True if the directory exists, false otherwise
    *
    * ```typescript
-   * const configDir = dir("./config");
+   * const configDir = fsDir("./config");
    *
    * if (configDir.existsSync()) {
    *   // Directory exists, safe to use
@@ -279,7 +279,7 @@ Trying to access a dir file from an absolute paths:
    * @returns A promise that resolves when the directory is created
    *
    * ```typescript
-   * const assetsDir = dir("./dist/assets/images");
+   * const assetsDir = fsDir("./dist/assets/images");
    *
    * // Creates all necessary parent directories
    * await assetsDir.make();
@@ -295,7 +295,7 @@ Trying to access a dir file from an absolute paths:
    * @synchronous
    *
    * ```typescript
-   * const assetsDir = dir("./dist/assets/images");
+   * const assetsDir = fsDir("./dist/assets/images");
    *
    * // Creates all necessary parent directories immediately
    * assetsDir.makeSync();
@@ -336,7 +336,7 @@ Trying to access a dir file from an absolute paths:
    * @returns A promise that resolves when the directory is removed
    *
    * ```typescript
-   * const tempDir = dir("./temp");
+   * const tempDir = fsDir("./temp");
    *
    * // Remove directory and all contents
    * await tempDir.rm();
@@ -356,7 +356,7 @@ Trying to access a dir file from an absolute paths:
    * @synchronous
    *
    * ```typescript
-   * const tempDir = dir("./temp");
+   * const tempDir = fsDir("./temp");
    *
    * // Remove directory and all contents immediately
    * tempDir.rmSync();
@@ -378,7 +378,7 @@ Trying to access a dir file from an absolute paths:
    * @returns A promise that resolves to an FsFileArray containing the matching files
    *
    * ```typescript
-   * const srcDir = dir("./src");
+   * const srcDir = fsDir("./src");
    *
    * // Find all TypeScript files
    * const tsFiles = await srcDir.glob("**\/*.ts");
@@ -406,7 +406,7 @@ Trying to access a dir file from an absolute paths:
    * @synchronous
    *
    * ```typescript
-   * const srcDir = dir("./src");
+   * const srcDir = fsDir("./src");
    *
    * // Find all TypeScript files synchronously
    * const tsFiles = srcDir.globSync("**\/*.ts");
@@ -468,7 +468,7 @@ Trying to access a dir file from an absolute paths:
    * @returns A promise that resolves to an FsFileArray containing the git-tracked files
    *
    * ```typescript
-   * const projectDir = dir("./project");
+   * const projectDir = fsDir("./project");
    *
    * // Get all git-tracked files in the directory
    * const trackedFiles = await projectDir.gitLs();
@@ -503,13 +503,13 @@ Trying to access a dir file from an absolute paths:
  *
  * ```typescript
  * // Create from absolute path
- * const rootDir = dir("/path/to/project");
+ * const rootDir = fsDir("/path/to/project");
  *
  * // Create from relative path
- * const srcDir = dir("./src");
+ * const srcDir = fsDir("./src");
  *
  * // Create from existing directory
- * const existingDir = dir(dir("/path/to/existing"));
+ * const existingDir = fsDir(fsDir("/path/to/existing"));
  * ```
  */
 export const fsDir = FsDir.cwd;