filelist

What is filelist?

The filelist npm package is a utility for managing and manipulating lists of file paths. It is commonly used in build systems and task runners to handle groups of files efficiently.

What are filelist's main functionalities?

Creating a FileList

This feature allows you to create a new FileList instance and include files matching a specific pattern. In this example, all JavaScript files in the 'src' directory and its subdirectories are included.

const FileList = require('filelist').FileList;
const files = new FileList();
files.include('src/**/*.js');
console.log(files.toArray());

Excluding Files

This feature allows you to exclude specific files from the FileList. In this example, all JavaScript files in the 'src' directory are included except for those named 'test.js'.

const FileList = require('filelist').FileList;
const files = new FileList();
files.include('src/**/*.js');
files.exclude('src/**/test.js');
console.log(files.toArray());

Refreshing the FileList

This feature allows you to refresh the FileList to ensure it is up-to-date with the current file system state. This is useful when files are added or removed during the execution of a script.

const FileList = require('filelist').FileList;
const files = new FileList();
files.include('src/**/*.js');
files.refresh();
console.log(files.toArray());

Other packages similar to filelist

glob

The glob package is a popular utility for matching file paths using patterns. It is more focused on pattern matching and file searching compared to filelist, which also provides list management capabilities.

minimatch

The minimatch package is a library for matching file paths against glob patterns. It is often used as a lower-level utility for pattern matching, whereas filelist provides higher-level list management features.

fast-glob

The fast-glob package is a high-performance globbing library for Node.js. It offers faster file matching and searching capabilities compared to filelist, but does not include list management features.

README