refactor: rename ls by readdir

Author: CoderSerio

Cargo.toml

@@ -2,20 +2,22 @@
 [package]
 authors = ["LongYinan <lynweklm@gmail.com>"]
 edition = "2021"
-name = "hyper_fs"
+name    = "hyper_fs"
 version = "0.1.0"
 
 [lib]
 crate-type = ["cdylib"]
 
 [dependencies]
-napi = "3.0.0"
+jwalk       = "0.8.1"
+napi        = "3.0.0"
 napi-derive = "3.4"
-walkdir = "2.5.0"
+serde       = "1.0.228"
+walkdir     = "2.5.0"
 
 [build-dependencies]
 napi-build = "2"
 
 [profile.release]
-lto = true
+lto   = true
 strip = "symbols"

README.md

@@ -1,15 +1,11 @@
-# `@napi-rs/package-template`
+# Hyper-FS
 
-![https://github.com/napi-rs/package-template/actions](https://github.com/napi-rs/package-template/workflows/CI/badge.svg)
+# Development
 
-> Template project for writing node packages with napi-rs.
-
-# Usage
-
-1. Click **Use this template**.
-2. **Clone** your project.
-3. Run `yarn install` to install dependencies.
-4. Run `yarn napi rename -n [@your-scope/package-name] -b [binary-name]` command under the project folder to rename your package.
+1. Run `pnpm install` to install dependencies.
+2. Edit files in `/src`
+3. Run `pnpm build` to build the lib could be invoked by Node.js
+4. Run `pnpm test` to check if everything is ok
 
 ## Install this test package
 

__test__/ls.spec.ts

@@ -0,0 +1,61 @@
+import test from 'ava'
+import { readdirSync, readdir } from '../index.js'
+
+test('sync: should list files in current directory', (t) => {
+  const files = readdirSync('.')
+
+  t.true(Array.isArray(files))
+  t.true(files.length > 0)
+
+  // Verify Dirent structure
+  const packageJson = files.find((f) => f.name === 'package.json')
+  t.truthy(packageJson, 'Result should contain package.json')
+  t.is(packageJson?.isDir, false)
+  t.true(packageJson?.path.includes('package.json'))
+
+  const srcDir = files.find((f) => f.name === 'src')
+  if (srcDir) {
+    t.is(srcDir.isDir, true, 'src should be identified as a directory')
+  }
+})
+
+test('async: should list files in current directory', async (t) => {
+  const files = await readdir('.')
+  t.true(files.length > 0)
+  t.truthy(files.find((f) => f.name === 'package.json'))
+})
+
+test('concurrency: run with specific thread count', (t) => {
+  const files = readdirSync('.', {
+    concurrency: 4,
+  })
+  t.true(files.length > 0)
+})
+
+test('concurrency: run with high thread count (stress test)', (t) => {
+  const files = readdirSync('.', {
+    concurrency: 100,
+  })
+  t.true(files.length > 0)
+})
+
+test('options: skip_hidden should filter out dotfiles', (t) => {
+  // First, ensure we can see hidden files (default behavior usually depends on impl,
+  // but based on your rust code, default is false)
+  const allFiles = readdirSync('.', { skipHidden: false })
+  // Assuming this repo has a .git folder or similar
+  const hasHidden = allFiles.some((f) => f.name.startsWith('.'))
+
+  if (hasHidden) {
+    const visibleFiles = readdirSync('.', { skipHidden: true })
+    const hiddenRemains = visibleFiles.some((f) => f.name.startsWith('.'))
+    t.false(hiddenRemains, 'Should not contain hidden files when skip_hidden is true')
+  } else {
+    t.pass('No hidden files found in root to test skipping')
+  }
+})
+
+test('error: should throw on non-existent directory', async (t) => {
+  t.throws(() => readdirSync('./path/to/nowhere'))
+  await t.throwsAsync(async () => await readdir('./path/to/nowhere'))
+})

__test__/readdir.spec.ts

@@ -1,21 +1,27 @@
-import { Bench } from 'tinybench'
+import * as fs from 'node:fs'
+import * as path from 'node:path'
+import { fileURLToPath } from 'node:url'
 
-import { plus100 } from '../index.js'
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
 
-function add(a: number) {
-  return a + 100
-}
-
-const b = new Bench()
+async function runBenchmarks() {
+  const files = fs.readdirSync(__dirname).filter((file) => {
+    return file.endsWith('.ts') && file !== 'bench.ts' && !file.endsWith('.d.ts')
+  })
 
-b.add('Native a + 100', () => {
-  plus100(10)
-})
+  console.log(`Found ${files.length} benchmark files to run...`)
 
-b.add('JavaScript a + 100', () => {
-  add(10)
-})
+  for (const file of files) {
+    console.log(`\n========================================`)
+    console.log(`Running benchmark: ${file}`)
+    console.log(`========================================`)
 
-await b.run()
+    try {
+      await import(path.join(__dirname, file))
+    } catch (e) {
+      console.error(`Error running ${file}:`, e)
+    }
+  }
+}
 
-console.table(b.table())
+runBenchmarks()

benchmark/bench.ts

@@ -0,0 +1,28 @@
+import { Bench } from 'tinybench'
+import * as fs from 'node:fs'
+import { readdirSync } from '../index.js'
+import * as path from 'node:path'
+
+const bench = new Bench({ time: 1000 })
+const targetDir = path.resolve(process.cwd(), 'node_modules')
+const dir = fs.existsSync(targetDir) ? targetDir : process.cwd()
+
+console.log(`Benchmarking readdir on: ${dir}`)
+
+bench
+  .add('Node.js fs.readdirSync', () => {
+    fs.readdirSync(dir, { withFileTypes: true })
+  })
+  .add('Node.js fs.readdirSync (recursive)', () => {
+    fs.readdirSync(dir, { recursive: true, withFileTypes: true })
+  })
+  .add('hyper-fs readdirSync (default)', () => {
+    readdirSync(dir)
+  })
+  .add('hyper-fs readdirSync (4 threads)', () => {
+    readdirSync(dir, { concurrency: 4 })
+  })
+
+await bench.run()
+
+console.table(bench.table())

benchmark/readdir.ts

@@ -1,3 +1,16 @@
 /* auto-generated by NAPI-RS */
 /* eslint-disable */
-export declare function ls(path: string): Array<string>
+export interface Dirent {
+  name: string
+  path: string
+  isDir: boolean
+}
+
+export declare function readdir(path: string, options?: ReaddirOptions | undefined | null): Promise<unknown>
+
+export interface ReaddirOptions {
+  skipHidden?: boolean
+  concurrency?: number
+}
+
+export declare function readdirSync(path: string, options?: ReaddirOptions | undefined | null): Array<Dirent>