https://github.com/techquery/fs-match

A NodeJS package for finding folders, files & apps by Regular expression based on Asynchronous iteration of ES 9
https://github.com/techquery/fs-match

async command-line filesystem iterator regex-match search

Last synced: 2 months ago
JSON representation

A NodeJS package for finding folders, files & apps by Regular expression based on Asynchronous iteration of ES 9

• Host: GitHub
• URL: https://github.com/techquery/fs-match
• Owner: TechQuery
• License: lgpl-3.0
• Created: 2018-03-24T19:01:06.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-11-25T15:02:21.000Z (7 months ago)
• Last Synced: 2025-04-14T05:49:00.065Z (2 months ago)
• Topics: async, command-line, filesystem, iterator, regex-match, search
• Language: TypeScript
• Homepage: https://tech-query.me/fs-match/
• Size: 737 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: ReadMe.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# FS match

A NodeJS package for finding folders, files & apps by Regular expression based on [Asynchronous iteration of ES 9][1] & TypeScript.

[![NPM Dependency](https://img.shields.io/librariesio/github/idea2app/fs-match.svg)][2]

[![CI & CD](https://github.com/TechQuery/fs-match/actions/workflows/main.yml/badge.svg)][3]

[![NPM](https://nodei.co/npm/fs-match.png?downloads=true&downloadRank=true&stars=true)][4]

## Use in another module

-   Example

    1. [find](source/find.tsx)

    2. [which](source/which.tsx)

-   Document

    -   Online: [URL][5] or `npm docs`

    -   Offline: `npm start`

## Use in Command-line shell

### Search files

```Shell

# Search in current directory

fs-match -r full\.name\.pattern

# Search in a specific folder

fs-match root/path -r full\.name\.pattern

# Search first match in a specific folder

fs-match root/path -r full\.name\.pattern -c 1

```

### Search apps

```Shell

# Show in stdout

app-find chrome firefox

# Append result to an ini-like file

app-find chrome firefox -f .npmrc

# Append result to ".env" file in working directory (since npm@9 & [email protected])

app-find chrome firefox -c

```

## Typical case

1.  [Puppeteer browser](https://web-cell.dev/puppeteer-browser/)

2.  [Hexo migrator for Web](https://tech-query.me/hexo-migrator-web/)

[1]: https://javascript.info/async-iterators-generators

[2]: https://libraries.io/npm/fs-match

[3]: https://github.com/TechQuery/fs-match/actions/workflows/main.yml

[4]: https://nodei.co/npm/fs-match/

[5]: https://tech-query.me/fs-match/