add onlyDirectories option

closes #1

README.md

@@ -30,3 +30,4 @@ globSync({ patterns: ['src/*.ts', '!**/*.d.ts'] });
 - `cwd`: The current working directory in which to search. Defaults to `process.cwd()`.
 - `absolute`: Whether to return absolute paths. Defaults to `false`.
 - `expandDirectories`: Whether to expand directories. Disable to best match `fast-glob`. Defaults to `true`.
+- `onlyDirectories`: Enable to only return directories. Defaults to `false`.

src/index.ts

@@ -7,6 +7,7 @@ export interface GlobOptions {
   patterns?: string[];
   ignore?: string[];
   expandDirectories?: boolean;
+  onlyDirectories?: boolean;
 }
 
 // using a directory as entry should match all files inside it
@@ -56,7 +57,19 @@ function getFdirBuilder(options: GlobOptions) {
       }
     : undefined;
 
-  return options.absolute ? new fdir(fdirOptions).withFullPaths() : new fdir(fdirOptions).withRelativePaths();
+  let builder = new fdir(fdirOptions);
+
+  if (options.absolute) {
+    builder = builder.withFullPaths();
+  } else {
+    builder = builder.withRelativePaths();
+  }
+
+  if (options.onlyDirectories) {
+    builder = builder.onlyDirs();
+  }
+
+  return builder;
 }
 
 export async function glob(options: GlobOptions | undefined = {}): Promise<string[]> {

test/index.test.ts

@@ -1,35 +1,42 @@
 import assert from 'node:assert/strict';
-import path from 'node:path';
+import path, { posix } from 'node:path';
 import { test } from 'node:test';
 import { glob, globSync } from '../src';
 
+const cwd = path.join(__dirname, 'fixtures');
+
 test('directory expansion', async () => {
-  const files = await glob({ patterns: ['a'], cwd: path.join(__dirname, 'fixtures') });
+  const files = await glob({ patterns: ['a'], cwd });
   assert.deepEqual(files.sort(), [path.join('a', 'a.ts'), path.join('a', 'b.ts')]);
 });
 
 test('no directory expansion if expandDirectories is set to false', async () => {
-  const files = await glob({ patterns: ['a'], expandDirectories: false, cwd: path.join(__dirname, 'fixtures') });
+  const files = await glob({ patterns: ['a'], expandDirectories: false, cwd });
   assert.deepEqual(files.sort(), []);
 });
 
 test('negative patterns', async () => {
-  const files = await glob({ patterns: ['**/a.ts', '!b/a.ts'], cwd: path.join(__dirname, 'fixtures') });
+  const files = await glob({ patterns: ['**/a.ts', '!b/a.ts'], cwd });
   assert.deepEqual(files.sort(), [path.join('a', 'a.ts')]);
 });
 
 test('ignore option', async () => {
-  const files = await glob({ patterns: ['**/a.ts'], ignore: ['b/a.ts'], cwd: path.join(__dirname, 'fixtures') });
+  const files = await glob({ patterns: ['**/a.ts'], ignore: ['b/a.ts'], cwd });
   assert.deepEqual(files.sort(), [path.join('a', 'a.ts')]);
 });
 
+test('onlyDirectories option', async () => {
+  const files = await glob({ patterns: ['a'], onlyDirectories: true, cwd });
+  assert.deepEqual(files.sort(), [`a${path.sep}`]);
+});
+
 test('bracket expanding', async () => {
-  const files = await glob({ patterns: ['a/{a,b}.ts'], cwd: path.join(__dirname, 'fixtures') });
+  const files = await glob({ patterns: ['a/{a,b}.ts'], cwd });
   assert.deepEqual(files.sort(), [path.join('a', 'a.ts'), path.join('a', 'b.ts')]);
 });
 
 test('no patterns returns everything in cwd', async () => {
-  const files = await glob({ cwd: path.join(__dirname, 'fixtures') });
+  const files = await glob({ cwd });
   assert.deepEqual(files.sort(), [
     path.join('a', 'a.ts'),
     path.join('a', 'b.ts'),
@@ -39,7 +46,7 @@ test('no patterns returns everything in cwd', async () => {
 });
 
 test('**/* works', async () => {
-  const files = await glob({ patterns: ['**/*'], cwd: path.join(__dirname, 'fixtures') });
+  const files = await glob({ patterns: ['**/*'], cwd });
   assert.deepEqual(files.sort(), [
     path.join('a', 'a.ts'),
     path.join('a', 'b.ts'),
@@ -49,6 +56,6 @@ test('**/* works', async () => {
 });
 
 test('sync version', () => {
-  const files = globSync({ patterns: ['a/*.ts'], cwd: path.join(__dirname, 'fixtures') });
+  const files = globSync({ patterns: ['a/*.ts'], cwd });
   assert.deepEqual(files.sort(), [path.join('a', 'a.ts'), path.join('a', 'b.ts')]);
 });