# pathdoras-box

> Pathtool is a powerful tool designed to extract all file paths that end with .js within a specified root directory

Latest version **1.4.6** (published 2023-05-20) · ISC license · 0 weekly downloads

## Install

```sh
npm install pathdoras-box
pnpm add pathdoras-box
yarn add pathdoras-box
bun add pathdoras-box
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.6 |
| Published | 2023-05-20 |
| First published | 2022-11-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | gkchris |
| Maintainers | gkchris |
| Keywords | js, path, recursive, extractor, search |

## Links

- npm: https://www.npmjs.com/package/pathdoras-box
- Repository: https://github.com/GkChris/pathdoras-box
- Homepage: https://github.com/GkChris/pathdoras-box#readme
- Issues: https://github.com/GkChris/pathdoras-box/issues
- npm.io page: https://npm.io/package/pathdoras-box

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.4.6 (latest) — 2023-05-20
- 1.4.5 — 2023-05-20
- 1.4.4 — 2023-05-20
- 1.4.3 — 2023-05-20
- 1.4.2 — 2023-05-10
- 1.4.1 — 2022-11-25
- 1.4.0 — 2022-11-24
- 1.3.0 — 2022-11-20
- 1.2.9 — 2022-11-19
- 1.2.8 — 2022-11-16
- 1.2.7 — 2022-11-16
- 1.2.6 — 2022-11-16

## README

# pathdoras-box

## Description

Pathtool is a powerful tool designed to extract all file paths that end with .js within a specified root directory. It serves as a valuable asset for both coding purposes and storing data in an external text file.

The tool meticulously traverses every branch of the folder tree originating from the specified root directory. During this process, it resolves and captures the file paths of all JavaScript files (.js). This comprehensive search ensures that no relevant files are overlooked.

Furthermore, Pathtool provides an option to write the extracted file paths to an external text file named paths.txt. This text file is placed in the parent folder if the third parameter is set to true. This feature offers a convenient way to save and reference the extracted paths for future use. 

**Note that pathtool skips node_modules content**

## Install 

```
npm i pathdoras-box
```


## Usage 

```Javascript
const {pathtool} = require('pathdoras-box');

function get_paths(){
    pathtool('<your_root directory>', [], Boolean)
    .then(res => console.log('res',res))
    .catch(err => console.log('err',err));
}

get_paths()
```

## Arguments


| Argument       | Required | Type    | Description                                      |
|----------------|----------|---------|--------------------------------------------------|
| root directory | required | string  | Specified root directory                         |
| Empty array    | required | array   | Required for the algorithm to operate            |
| Store data     | optional | boolean | Option to store data to file (default: false).   |

---
_Source: https://npm.io/package/pathdoras-box · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._