open-index/open-npm huggingface dataset:
npm package: @modular-rocks/traverse-files
Description: Simply traversing files
Author: Alex Dollery
Latest version: 0.3.8

# Traverse files

## Installation

`npm install @modular-rocks/traverse-files`

or

`yarn add @modular-rocks/traverse-files`

# Usage

This package gives you an array of files in a directory. Its designed to be used across the ModularRocks modules, so its been extracted into its own package.

## Collect

```
import { collect } from "@modular-rocks/traverse-files"

const fullpath = '/path/to/directory'
const extensions = ['js', 'ts', 'tsx', 'jsx']
const ignoredExtensions = ['.d.ts', '.d.tsx']
const ignoreTests = true

collect(fullpath, extensions, ignoredExtensions, ignoreTests)

// ['/path/to/directory/file1', '/path/to/directory/file2']
```

## Traverse

```
import { traverse } from "@modular-rocks/traverse-files"

const fullpath = '/path/to/directory'

traverse(fullpath, [])

// ['/path/to/directory/file1', '/path/to/directory/file2']
```

## ReadDirectory

```
import { readDirectory } from "@modular-rocks/traverse-files"

const src: string = resolve(__dirname, './test-directory')
const extensions = ['js', 'ts', 'tsx', 'jsx']
const ignoredFiles = ['.d.ts', '.d.tsx']

const opts = {
  src,
  extensions,
  ignoredFiles
}

readDirectory(opts)

//  [["/src/tests/test-directory/nested/one.js", "code"], ["/src/tests/test-directory/nested/three.js", "code"], ["/src/tests/test-directory/nested/two.js", ""], ["/src/tests/test-directory/one.js", "code"], ["/src/tests/test-directory/three.js", ""], ["/src/tests/test-directory/two.js", "code"]]
```

## ReadJSONFile

```
import { readJSONFile } from "@modular-rocks/traverse-files"

const packagePath: string = resolve(__dirname, './test-package.json')

readJSONFile(packagePath)

// {}
```