style: cleanup fs exports

Author: yleflour

packages/fs/src/dir.lib.ts

@@ -7,7 +7,7 @@ import * as fsSync from "fs";
 import * as fs from "fs/promises";
 import { dirs } from "./dirs-array.lib.ts";
 import { FsFile } from "./file.lib.ts";
-import { files, filesFromDir } from "./files-array.lib.ts";
+import { fsFiles, fsFilesFromDir } from "./files-array.lib.ts";
 
 export class FsDir extends Pipeable<FsDir> {
   private readonly _path: AnyPath;
@@ -395,7 +395,7 @@ Trying to access a dir file from an absolute paths:
       .cwd(this._path)
       .options({ absolute: true })
       .find(...patterns)
-      .then(files);
+      .then(fsFiles);
   }
 
   /**
@@ -416,7 +416,7 @@ Trying to access a dir file from an absolute paths:
    * ```
    */
   public globSync(...patterns: Array<string> | [Array<string>]) {
-    return files(
+    return fsFiles(
       glob
         .cwd(this._path)
         .options({ absolute: true })
@@ -475,7 +475,7 @@ Trying to access a dir file from an absolute paths:
    * ```
    */
   public async gitLs() {
-    return git.ls(this._path).then(filesFromDir(this));
+    return git.ls(this._path).then(fsFilesFromDir(this));
   }
 
   /**
@@ -512,4 +512,9 @@ Trying to access a dir file from an absolute paths:
  * const existingDir = dir(dir("/path/to/existing"));
  * ```
  */
+export const fsDir = FsDir.cwd;
+
+/**
+ * @deprecated Changed to avoid namespacing conflicts. Use {@link fsDir} instead
+ */
 export const dir = FsDir.cwd;

packages/fs/src/dirs-array.lib.ts

@@ -1,6 +1,6 @@
 import { enhance, type Enhanced } from "@synstack/enhance";
 import { type AnyPath } from "@synstack/path";
-import { dir as fsDir, FsDir } from "./dir.lib.ts";
+import { fsDir, FsDir } from "./dir.lib.ts";
 import type { FsFile } from "./file.lib.ts";
 
 /**
@@ -15,7 +15,7 @@ export interface FsDirArrayMethods {
 
 const dirsArrayMethods: FsDirArrayMethods = {
   filter(fn) {
-    return dirs(this.filter(fn));
+    return fsDirs(this.filter(fn));
   },
 
   toPaths() {
@@ -33,5 +33,15 @@ export type FsDirArray = Enhanced<
   FsDirArrayMethods
 >;
 
-export const dirs = (dirs: Array<FsDir | AnyPath>): FsDirArray =>
+/**
+ * Create a new FsDirArray instance with the provided directories.
+ * @param dirs - An array of FsDir or AnyPath instances
+ * @returns A new FsDirArray instance
+ */
+export const fsDirs = (dirs: Array<FsDir | AnyPath>): FsDirArray =>
   enhance("dirs_array", dirs.map(fsDir), dirsArrayMethods);
+
+/**
+ * @deprecated Changed to avoid namespacing conflicts. Use {@link fsDirs} instead
+ */
+export const dirs = fsDirs;

packages/fs/src/file.lib.test.ts

@@ -2,19 +2,19 @@ import assert from "node:assert/strict";
 import { describe, it } from "node:test";
 import { z } from "zod";
 import { assertType } from "../../shared/src/ts.utils.ts";
-import { dir } from "./dir.lib.ts";
-import { file } from "./file.lib.ts";
+import { fsDir } from "./dir.lib.ts";
+import { fsFile } from "./file.lib.ts";
 
 const _typeTests = async () => {
   const schema = z.object({
     id: z.string(),
     name: z.string(),
   });
-  const schemaFile = file("").schema(schema);
+  const schemaFile = fsFile("").schema(schema);
   type Output = z.infer<typeof schema>;
 
   assertType<Output>(await schemaFile.read.json());
-  assertType<[1, 2]>(await file("").read.json<[1, 2]>());
+  assertType<[1, 2]>(await fsFile("").read.json<[1, 2]>());
   assertType<Output>(schemaFile.read.jsonSync());
   assertType<Output>(await schemaFile.read.yaml());
   assertType<Output>(schemaFile.read.yamlSync());
@@ -30,49 +30,49 @@ const _typeTests = async () => {
 describe("File", () => {
   describe("file", () => {
     it("creates a file from a path", () => {
-      const testFile = file("/super/path/test.txt");
+      const testFile = fsFile("/super/path/test.txt");
       assert.equal(testFile.path, "/super/path/test.txt");
     });
   });
   describe("toFile", () => {
     it("creates a file from a relative path", () => {
-      const testFile = file("/super/path/test.txt");
+      const testFile = fsFile("/super/path/test.txt");
       assert.equal(testFile.toFile("../other.txt").path, "/super/other.txt");
     });
   });
   describe("toDir", () => {
     it("creates a dir from a relative path", () => {
-      const testFile = file("/super/path/test.txt");
+      const testFile = fsFile("/super/path/test.txt");
       assert.equal(testFile.toDir("../other").path, "/super/other");
     });
   });
   describe("relativePathTo", () => {
     it("returns the relative path to another file", () => {
-      const testFile = file("/super/path/test.txt");
+      const testFile = fsFile("/super/path/test.txt");
       assert.equal(
-        testFile.relativePathTo(file("/super/other/other.txt")),
+        testFile.relativePathTo(fsFile("/super/other/other.txt")),
         "../other/other.txt",
       );
     });
     it("returns the relative path to another folder", () => {
       assert.equal(
-        file("/super/path/test.txt").relativePathTo(dir("/super/other")),
+        fsFile("/super/path/test.txt").relativePathTo(fsDir("/super/other")),
         "../other",
       );
     });
   });
   describe("relativePathFrom", () => {
     it("returns the relative path from another file", () => {
-      const testFile = file("/super/path/test.txt");
+      const testFile = fsFile("/super/path/test.txt");
       assert.equal(
-        testFile.relativePathFrom(file("/super/other/other.txt")),
+        testFile.relativePathFrom(fsFile("/super/other/other.txt")),
         "../path/test.txt",
       );
     });
     it("returns the relative path from another folder", () => {
-      const testFile = file("/super/path/test.txt");
+      const testFile = fsFile("/super/path/test.txt");
       assert.equal(
-        testFile.relativePathFrom(dir("/super/other")),
+        testFile.relativePathFrom(fsDir("/super/other")),
         "../path/test.txt",
       );
     });

packages/fs/src/file.lib.ts

@@ -1183,4 +1183,9 @@ class FsFileWrite<
  * const existingFile = file(file("/path/to/existing.txt"));
  * ```
  */
+export const fsFile = FsFile.from;
+
+/**
+ * @deprecated Changed to avoid namespacing conflicts. Use {@link fsFile} instead
+ */
 export const file = FsFile.from;

packages/fs/src/files-array.lib.ts

@@ -1,7 +1,7 @@
 import { enhance, type Enhanced } from "@synstack/enhance";
 import { type AnyPath } from "@synstack/path";
 import { FsDir } from "./dir.lib.ts";
-import { FsFile, file } from "./file.lib.ts";
+import { FsFile, fsFile } from "./file.lib.ts";
 
 /**
  * Interface defining chainable methods for arrays of FsFile instances.
@@ -22,7 +22,7 @@ export interface FsFileArrayMethods {
 
 const filesArrayMethods: FsFileArrayMethods = {
   filter(fn) {
-    return files(this.filter(fn));
+    return fsFiles(this.filter(fn));
   },
 
   filterGlobs(...patterns) {
@@ -57,17 +57,33 @@ export type FsFileArray = Enhanced<
   FsFileArrayMethods
 >;
 
-export const files = (files: Array<FsFile<any> | AnyPath>): FsFileArray =>
+/**
+ * Create a new FsFileArray instance with the provided files.
+ * @param files - An array of FsFile or paths
+ * @returns A new FsFileArray instance
+ */
+export const fsFiles = (files: Array<FsFile<any> | AnyPath>): FsFileArray =>
   enhance(
     "files_array",
     files.map((f) => {
       if (f instanceof FsFile) return f;
-      return file(f);
+      return fsFile(f);
     }),
     filesArrayMethods,
   );
 
-export const filesFromDir =
+/**
+ * @deprecated Changed to avoid namespacing conflicts. Use {@link fsFiles} instead
+ */
+export const files = fsFiles;
+
+/**
+ * Create a new FsFileArray instance with the provided files relative to the cwd directory.
+ * @param dir - The cwd directory
+ * @param files - An array of relative paths from the cwd directory
+ * @returns A new FsFileArray instance
+ */
+export const fsFilesFromDir =
   (dir: FsDir) =>
   (files: Array<FsFile<any> | AnyPath>): FsFileArray =>
     enhance(
@@ -78,3 +94,8 @@ export const filesFromDir =
       }),
       filesArrayMethods,
     );
+
+/**
+ * @deprecated Changed to match naming convention. Use {@link fsFilesFromDir} instead
+ */
+export const filesFromDir = fsFilesFromDir;

packages/fs/src/fs.index.ts

@@ -1,3 +1,9 @@
-export { FsDir, dir } from "./dir.lib.ts";
-export { FsFile, file } from "./file.lib.ts";
-export { files, filesFromDir, type FsFileArray } from "./files-array.lib.ts";
+export { dir, FsDir, fsDir } from "./dir.lib.ts";
+export { file, FsFile, fsFile } from "./file.lib.ts";
+export {
+  files,
+  filesFromDir,
+  fsFiles,
+  fsFilesFromDir,
+  type FsFileArray,
+} from "./files-array.lib.ts";