README.md

name	glob-tool
description	Find files and directories by glob pattern using tinyglobby.
context	node

GlobTool

Finds files and directories matching glob patterns using tinyglobby. Three methods: findAll returns everything matching the pattern, findFiles returns only files, and findDirectories returns only directories.

Interface

interface IGlobTool {
  /** Finds all items matching the pattern. */
  findAll(patterns: string | string[], options?: GlobTool.AllOptions): string[];
  /** Finds only files matching the pattern. */
  findFiles(patterns: string | string[], options?: GlobTool.FilesOptions): string[];
  /** Finds only directories matching the pattern. */
  findDirectories(patterns: string | string[], options?: GlobTool.DirectoriesOptions): string[];
}

Usage

With DI

import { Container } from "@webiny/di";
import { GlobTool, GlobToolFeature } from "@webiny/stdlib/node";

const container = new Container();
GlobToolFeature.register(container);

const glob = container.resolve(GlobTool);
const files = glob.findFiles("**/*.ts", { cwd: "/my/project" });

Without DI

import { createGlobTool } from "@webiny/stdlib/node";

const glob = createGlobTool();
const files = glob.findFiles("**/*.ts", { cwd: "/my/project" });
const dirs = glob.findDirectories("*", { cwd: "/my/project" });