rename filter and sort methods

.changeset/sour-lamps-provide.md

@@ -0,0 +1,10 @@
+---
+'renoun': minor
+---
+
+Renames file system methods `filter` to `withFilter` and `sort` to `withSort` for better clarity since they are not immediately applied.
+
+### Breaking Changes
+
+- `<Directory>.filter` method is now `<Directory>.withFilter`
+- `<Directory>.sort` method is now `<Directory>.withSort`

packages/renoun/src/file-system/index.test.ts

@@ -132,8 +132,8 @@ describe('file system', () => {
       path: 'posts',
       fileSystem,
     })
-      .filter((entry) => isFile(entry, 'mdx'))
-      .sort((a, b) => a.getName().localeCompare(b.getName()))
+      .withFilter((entry) => isFile(entry, 'mdx'))
+      .withSort((a, b) => a.getName().localeCompare(b.getName()))
     const files = await posts.getEntries()
 
     expectTypeOf(files).toMatchTypeOf<JavaScriptFile<PostType>[]>()
@@ -144,7 +144,7 @@ describe('file system', () => {
     type PostType = { frontmatter: { title: string } }
     const posts = new Directory<{ mdx: PostType }>({
       path: 'fixtures/posts',
-    }).filter((entry) => isFile(entry, 'mdx'))
+    }).withFilter((entry) => isFile(entry, 'mdx'))
     const files = await posts.getEntries()
 
     expectTypeOf(files).toMatchTypeOf<JavaScriptFile<PostType>[]>()
@@ -156,7 +156,7 @@ describe('file system', () => {
       'foo.ts': '',
       'bar.ts': '',
     })
-    const directory = new Directory({ fileSystem }).sort((a, b) =>
+    const directory = new Directory({ fileSystem }).withSort((a, b) =>
       a.getName().localeCompare(b.getName())
     )
     const entries = await directory.getEntries()
@@ -185,8 +185,8 @@ describe('file system', () => {
         }
       },
     })
-      .filter((entry) => isFile(entry, 'ts'))
-      .sort(async (a, b) => {
+      .withFilter((entry) => isFile(entry, 'ts'))
+      .withSort(async (a, b) => {
         const aSort = await a.getExport('sort').getRuntimeValue()
         const bSort = await b.getExport('sort').getRuntimeValue()
         return aSort - bSort
@@ -202,7 +202,7 @@ describe('file system', () => {
   })
 
   test('filter and recursive entries', async () => {
-    const docs = new Directory({ path: 'fixtures/docs' }).filter((entry) =>
+    const docs = new Directory({ path: 'fixtures/docs' }).withFilter((entry) =>
       isFile(entry, 'mdx')
     )
     const entries = await docs.getEntries({ recursive: true })

packages/renoun/src/file-system/index.tsx

@@ -566,14 +566,14 @@ export class Directory<
   }
 
   /** Returns a new `Directory` with a narrowed type and filter applied to all descendant entries. */
-  filter<FilteredEntry extends Entry>(
-    filterFn: (entry: FileSystemEntry<Types>) => entry is FilteredEntry
+  withFilter<FilteredEntry extends Entry>(
+    filter: (entry: FileSystemEntry<Types>) => entry is FilteredEntry
   ): Directory<Types, FilteredEntry>
-  filter<FilteredEntry extends Entry>(
-    filterFn: (entry: FileSystemEntry<Types>) => Promise<boolean> | boolean
+  withFilter<FilteredEntry extends Entry>(
+    filter: (entry: FileSystemEntry<Types>) => Promise<boolean> | boolean
   ): Directory<Types, Entry>
-  filter<FilteredEntry extends Entry>(
-    filterFn: (entry: FileSystemEntry<Types>) => Promise<boolean> | boolean
+  withFilter<FilteredEntry extends Entry>(
+    filter: (entry: FileSystemEntry<Types>) => Promise<boolean> | boolean
   ): Directory<Types, Entry | FilteredEntry> {
     const filteredDirectory = new Directory<Types, Entry | FilteredEntry>({
       path: this.#path,
@@ -584,7 +584,7 @@ export class Directory<
     })
 
     filteredDirectory.setDirectory(this)
-    filteredDirectory.setFilterCallback(filterFn)
+    filteredDirectory.setFilterCallback(filter)
     if (this.#sortCallback) {
       filteredDirectory.setSortCallback(this.#sortCallback)
     }
@@ -603,8 +603,8 @@ export class Directory<
   }
 
   /** Returns a new `Directory` with a sorting function applied to all descendant entries. */
-  sort(
-    sortCallback: (a: Entry, b: Entry) => Promise<number> | number
+  withSort(
+    sort: (a: Entry, b: Entry) => Promise<number> | number
   ): Directory<Types, Entry> {
     const sortedDirectory = new Directory<Types, Entry>({
       path: this.#path,
@@ -615,7 +615,7 @@ export class Directory<
     })
 
     sortedDirectory.setDirectory(this)
-    sortedDirectory.setSortCallback(sortCallback)
+    sortedDirectory.setSortCallback(sort)
     if (this.#filterCallback) {
       sortedDirectory.setFilterCallback(this.#filterCallback)
     }