@voxpelli/config-array-find-files
TypeScript icon, indicating that this package has built-in type declarations

1.2.1 • Public • Published

@voxpelli/config-array-find-files

A proof of concept of a generic equivalent of ESLint's globSearch() for use with ConfigArray

npm version npm downloads neostandard javascript style Module type: ESM Types in JS Follow @voxpelli@mastodon.social

Usage

import { ConfigArray } from '@eslint/config-array';
import { configArrayFindFiles } from '@voxpelli/config-array-find-files';

// Ensure you have a normalized config at hand...

const configs = new ConfigArray([
  { files: ['*.js'] },
  { files: ['*.md'] },
]);
await configs.normalize();

// ...then you are ready to find some files!

const filePaths = await configArrayFindFiles({
  basePath: path.join(dirname(import.meta.url), '../'),
  configs,
});

API

configArrayFindFiles()

Takes a value (input), does something configured by the config (configParam) and returns the processed value asyncly(output)

Syntax

configArrayFindFiles(options) => Promise<string[]>

Options

  • basePath - the directory to search
  • configs - the config array to use for determining what to ignore
  • deepFilter - optional function that indicates whether the directory will be read deep or not
  • entryFilter - optional function that indicates whether the entry will be included to results or not

Returns

A Promise that resolves to an array with string file paths for all matching files

Readme

Keywords

none

Package Sidebar

Install

npm i @voxpelli/config-array-find-files

Weekly Downloads

89,783

Version

1.2.1

License

MIT

Unpacked Size

10.6 kB

Total Files

6

Last publish

Collaborators

  • voxpelli