Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tada5hi/locter
Locter is a library to locate and load a file regarding specific criteria.
https://github.com/tada5hi/locter
file file-loader file-locator loader locator
Last synced: about 2 months ago
JSON representation
Locter is a library to locate and load a file regarding specific criteria.
- Host: GitHub
- URL: https://github.com/tada5hi/locter
- Owner: tada5hi
- License: mit
- Created: 2022-05-07T07:29:53.000Z (over 2 years ago)
- Default Branch: develop
- Last Pushed: 2024-10-11T13:29:09.000Z (2 months ago)
- Last Synced: 2024-10-12T18:57:33.178Z (2 months ago)
- Topics: file, file-loader, file-locator, loader, locator
- Language: TypeScript
- Homepage:
- Size: 4.78 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.MD
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Locter 🔥
[](https://badge.fury.io/js/locter)
[](https://github.com/tada5hi/locter/actions/workflows/main.yml)
[](https://codecov.io/gh/Tada5hi/locter)
[](https://snyk.io/test/github/Tada5hi/locter?targetFile=package.json)
[](https://conventionalcommits.org)
Locter is a library to locate and load a file/modules regarding specific criteria.
**Table of Contents**
- [Installation](#installation)
- [Usage](#usage)
- [Locator](#locator)
- [Loader](#loader)
- [License](#license)
## Installation
```bash
npm install locter --save
```
## Usage
The following examples are based on some shared assumptions:
- A folder named `files` exists in the root directory.
- The folder `files` contains the following files:
- example.js
- example.json
- example.ts
- example-long.ts
### Locator
**Multiple**
Locating multiple files will return information about all files matching the pattern.
```typescript
import { locateMany } from 'locter';
(async () => {
let files = await locateMany(
'files/example.{js,.ts}'
);
console.log(files);
/*
[
{ path: 'files', name: 'example', extension: '.js'},
{ path: 'files', name: 'example', extension: '.ts'}
]
*/
files = await locateMany(
'files/*.{js,ts}'
);
console.log(files);
/*
[
{ path: 'files', name: 'example', extension: '.js'},
{ path: 'files', name: 'example', extension: '.ts'},
{ path: 'files', name: 'example-long', extension: '.ts'},
]
*/
})
```
A synchronous variant is also available: `locateManySync`
**Single**
Locating a single file will return information about the first file matching the pattern.
```typescript
import { locate } from 'locter';
(async () => {
let file = await locate(
'files/example.{js,.ts}'
);
console.log(file);
/*
{ path: 'files', name: 'example', extension: '.js'}
*/
})
```
A synchronous variant is also available: `locateSync`
### Loader
The `load` method can be used to load a file/module in an asynchronous fashion.
Either a string or the output of the locate/locateSync method can be passed as argument.
```typescript
import { load, locate } from 'locter';
(async () => {
const file = await locate(
'files/example.{js,.ts}'
);
let content = await load(file);
console.log(content);
// ...
content = await load('...');
console.log(content);
// ...
})
```
There is also a synchronous method called `loadSync` to load files.
```typescript
import { loadSync, locateSync } from 'locter';
(async () => {
const file = await locateSync(
'files/example.{js,.ts}'
);
let content = await loadSync(file);
console.log(content);
// ...
content = await loadSync('...');
console.log(content);
// ...
})
```
Two loaders are predefined from scratch and already registered:
- **ConfLoader**: This loader allows to load `.conf` files.
- **JSONLoader**: This loader allows to load `.json` files.
- **YAMLLoader**: This loader allows to load `.yml` files.
- **ModuleLoader**: This loader allows to load modules with
`.js`, `.mjs`, `.mts`, `.cjs`, `.cts`, `.ts` file extensions independent of the environment (cjs or esm).
To register loader for other file types, the function `registerLoader` can be used.
```typescript
import { registerLoader } from 'locter';
registerLoader(['.ext'], {
execute(input: string) {
},
executeSync(input: string) {
}
})
```
## License
Made with 💚
Published under [MIT License](./LICENSE).