https://github.com/disqada/pathfinder
Easily find files in your project
https://github.com/disqada/pathfinder
directory file filesystem nodejs npm npm-package path pathfinding tool
Last synced: 4 months ago
JSON representation
Easily find files in your project
- Host: GitHub
- URL: https://github.com/disqada/pathfinder
- Owner: DisQada
- License: apache-2.0
- Created: 2023-04-10T17:05:43.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-14T06:21:49.000Z (over 1 year ago)
- Last Synced: 2025-06-18T05:41:35.115Z (12 months ago)
- Topics: directory, file, filesystem, nodejs, npm, npm-package, path, pathfinding, tool
- Language: JavaScript
- Homepage: http://docs.disqada.org/PathFinder/
- Size: 532 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# PathFinder
## Badges
[](https://www.github.com/DisQada/PathFinder)
[](https://www.npmjs.com/package/@disqada/pathfinder)
[](https://github.com/DisQada/PathFinder/actions/workflows/docs.yml)
[](https://github.com/semantic-release/semantic-release)
## Table of Contents
- [PathFinder](#pathfinder)
- [Badges](#badges)
- [Table of Contents](#table-of-contents)
- [About](#about)
- [Learn](#learn)
- [License](#license)
- [Getting started](#getting-started)
- [Store paths](#store-paths)
- [Find paths](#find-paths)
- [Same file names](#same-file-names)
- [Renaming files](#renaming-files)
- [Receiving all matches](#receiving-all-matches)
- [Filtering by different properties](#filtering-by-different-properties)
- [Extension difference](#extension-difference)
- [Folder difference](#folder-difference)
## About
This tool was made to be able to find file paths using only their names, or getting all the paths of files with "hello" word in their names.
The file paths you want to get later must be stored first, this will usually be done at the beginning of the program.
## Learn
Check the [Getting started](#getting-started) guide for first time usage.
## License
Copyright © 2023 [DisQada](https://github.com/DisQada)
This tool is licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
See the [LICENSE](LICENSE) file for more information.
# Getting started
## Store paths
The first thing to do when using this tool is to store all the paths that will be required later on in some other file
To store the wanted file paths, use the function `storeFolderPaths()` and specify the array of directories to store their file paths.
> Store all the paths (once) at the beginning of the discord bot (or application)
Let's say that this is out workspace
```bash
├── package.json
├── src
│ ├── a.js
│ └── b.js
└── data
└── a.json
```
We use this code to store the paths of all files in the `src` and `data` folder
```js
import { storeFolderPaths } from '@disqada/pathfinder'
storeFolderPaths(['src', 'data'])
```
Now we'll have the following paths stored successfully
> The file paths are stored in order
```bash
.../src/a.js
.../src/b.js
.../data/a.json
```
## Find paths
In another file in the middle of some function, you want to require a module of one of the files stored earlier, you remember it's name but you don't remember it's location and you don't want to modify the path in the require function every time you move one of the files
Here is where this tools comes to help, if you only know the name of the file then you can easily fetch it's full path using the function `findPath()` or `findPaths()`
> Both functions work the same, it's just that `filePath()` returns the first match while `filePaths()` returns them all in an array
Let's say that we want to require the file `src/b.js`, we use the following code for that
```js
import { findPath } from '@disqada/pathfinder'
const filePath = findPath({ name: 'b' })
const { ... } = (await import(filePath.fullPath)).default
```
With that we successfully required the module and used it just like normal but without the need to know it's full path
If you have multiple files with the same name, then check [Same file names](#same-file-names) guide
# Same file names
Let's say that this is out workspace
```bash
├── package.json
└── src
├── a.js
└── a.json
```
Now let's say we've written some code and we want to require the file `src/a.json`, we can use the same code, but there is a problem, the function is returning the path of `src/a.js` instead of `src/a.json` because it was stored before and the function will return the first match
To work around this, we have couple of choices
## Renaming files
Renaming one of the files to another name will solve this problem, but it's not always something we can do
## Receiving all matches
Instead of getting one file path, we can get an array of all the file paths of that name by changing the function from `findPath()` to `findPaths()`
```js
import { findPaths } from '@disqada/pathfinder'
const filePaths = findPaths({ name: 'a' })
const { ... } = (await import(filePaths[1].fullPath)).default
```
This will solve the problem, for now, what if we then added another file named `a.js` somewhere in our project or the order of the files changed (files order in the workspace or the order of storing)?
## Filtering by different properties
> More than filtering property can be used at the same time
### Extension difference
The best way to work around the problem of file name conflict is by adding more details to the `FilterOptions` object parameter
Both files have the same file name and path except for only the extension, so we can specify the `extension` property in the `FilterOptions` parameter to get our desired file
```js
import { findPath } from '@disqada/pathfinder'
const filePath = findPath({ extension: 'json' })
const { ... } = (await import(filePath.fullPath)).default
```
### Folder difference
If our workspace was instead like this, where both the files' name and extension are identical, but they're in different folder
```bash
├── package.json
├── src
│ └── a.js
└── data
└── a.js
```
Then the way we'll get the correct path is as follows
```js
import { findPath } from '@disqada/pathfinder'
const filePath = findPath({ folder: 'data' })
const { ... } = (await import(filePath.fullPath)).default
```