https://github.com/viqueen/fs-directory

https://github.com/viqueen/fs-directory

filesystem library nodejs

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/viqueen/fs-directory
• Owner: viqueen
• License: apache-2.0
• Created: 2022-01-15T09:28:12.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-05-26T08:39:02.000Z (about 3 years ago)
• Last Synced: 2025-03-11T19:41:41.044Z (over 1 year ago)
• Topics: filesystem, library, nodejs
• Language: TypeScript
• Homepage:
• Size: 231 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
## fs-directory

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=viqueen_fs-directory&metric=alert_status)](https://sonarcloud.io/dashboard?id=viqueen_fs-directory)

[![Known Vulnerabilities](https://snyk.io/test/github/viqueen/fs-directory/badge.svg?targetFile=package.json)](https://snyk.io/test/github/viqueen/fs-directory?targetFile=package.json)

---

## use it

```bash

npm install fs-directory --save

```

```javascript

import { listFiles } from "fs-directory";

const filters = {

  fileFilter: (entry) => entry.name.endsWith(".js"),

  directoryFilter: () => true,

};

const jsFiles = listFiles(process.cwd(), filters);

const allFiles = listFiles(process.cwd());

```

---

## develop it

### environment

- [NodeJS](https://nodejs.org/en/)

- optional: [nvm](https://github.com/nvm-sh/nvm)

### build it, test it, and format it

```bash

npm run build

npm test

npm run format

```