@sapphire/node-utilities 1.1.0-next.f555c82.0 → 1.1.0-pr-434.d192d9e.0

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+# [@sapphire/node-utilities@1.0.0](https://github.com/sapphiredev/utilities/tree/@sapphire/node-utilities@1.0.0) - (2022-10-02)
+
+## 🚀 Features
+
+- Add `@sapphire/node-utilities` (#468) ([1606208](https://github.com/sapphiredev/utilities/commit/1606208ce2e1ca8a6b307d14ce7f119e6c914a97))
+

package/README.md

@@ -4,7 +4,7 @@
 
 # @sapphire/node-utilities
 
-**Common JavaScript utilities for the Sapphire Community.**
+**Common NodeJS utilities for the Sapphire Community.**
 
 [![GitHub](https://img.shields.io/github/license/sapphiredev/utilities)](https://github.com/sapphiredev/utilities/blob/main/LICENSE.md)
 [![codecov](https://codecov.io/gh/sapphiredev/utilities/branch/main/graph/badge.svg?token=OEGIV6RFDO)](https://codecov.io/gh/sapphiredev/utilities)
@@ -13,6 +13,15 @@
 
 </div>
 
+**Table of Contents**
+
+-   [Features](#features)
+-   [Installation](#installation)
+-   [Usage](#usage)
+    -   [`findFilesRecursively`](#findfilesrecursively)
+-   [Buy us some doughnuts](#buy-us-some-doughnuts)
+-   [Contributors ✨](#contributors-)
+
 ## Features
 
 -   Written in TypeScript
@@ -27,6 +36,32 @@ You can use the following command to install this package, or replace `npm insta
 npm install @sapphire/node-utilities
 ```
 
+## Usage
+
+### `findFilesRecursively`
+
+Recursively searches for files in a directory and returns an [`AsyncIterableIterator`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols) of the found paths.
+
+```ts
+import { findFilesRecursively } from '@sapphire/node-utilities';
+
+const files = findFilesRecursively('./src');
+for await (const file of files) {
+	console.log(file);
+}
+
+// This, for example, could log:
+// /root/src/index.js
+// /root/src/database.csv
+// /root/src/lib/utils/constants.json
+
+// Alternate forms:
+const files = findFilesRecursivelyStringStartsWith('./src', 'index'); // filename starts with "index"
+const files = findFilesRecursivelyStringEndsWith('./src', '.js'); // filename ends with ".js"
+const files = findFilesRecursivelyStringIncludes('./src', 'database'); // filename includes "database"
+const files = findFilesRecursivelyRegex('./src', /\.[tj]sx?$/); // filename matches the regex
+```
+
 ---
 
 ## Buy us some doughnuts
@@ -100,6 +135,14 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <td align="center"><a href="https://github.com/EvolutionX-10"><img src="https://avatars.githubusercontent.com/u/85353424?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Evo</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=EvolutionX-10" title="Code">💻</a></td>
     <td align="center"><a href="https://enes.ovh/"><img src="https://avatars.githubusercontent.com/u/61084101?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Enes Genç</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=enxg" title="Code">💻</a></td>
     <td align="center"><a href="https://github.com/muchnameless"><img src="https://avatars.githubusercontent.com/u/12682826?v=4?s=100" width="100px;" alt=""/><br /><sub><b>muchnameless</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=muchnameless" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/r-priyam"><img src="https://avatars.githubusercontent.com/u/50884372?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Priyam</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=r-priyam" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/legendhimslef"><img src="https://avatars.githubusercontent.com/u/69213593?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Voxelli</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=legendhimslef" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/CitTheDev"><img src="https://avatars.githubusercontent.com/u/94020875?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Cit The Dev</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=CitTheDev" title="Code">💻</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://www.goestav.com/"><img src="https://avatars.githubusercontent.com/u/27970303?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Goestav</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=goestav" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/didinele"><img src="https://avatars.githubusercontent.com/u/27137376?v=4?s=100" width="100px;" alt=""/><br /><sub><b>DD</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=didinele" title="Code">💻</a></td>
+    <td align="center"><a href="https://steamcommunity.com/id/06000208"><img src="https://avatars.githubusercontent.com/u/52764066?v=4?s=100" width="100px;" alt=""/><br /><sub><b>amber</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=06000208" title="Code">💻</a></td>
   </tr>
 </table>
 

package/dist/index.js

@@ -1,7 +1,5 @@
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
 var promises = require('fs/promises');
 var path = require('path');
 
@@ -40,4 +38,5 @@ exports.findFilesRecursivelyRegex = findFilesRecursivelyRegex;
 exports.findFilesRecursivelyStringEndsWith = findFilesRecursivelyStringEndsWith;
 exports.findFilesRecursivelyStringIncludes = findFilesRecursivelyStringIncludes;
 exports.findFilesRecursivelyStringStartsWith = findFilesRecursivelyStringStartsWith;
+//# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.js.map

package/dist/index.mjs

@@ -32,4 +32,5 @@ function findFilesRecursivelyRegex(path, regex) {
 __name(findFilesRecursivelyRegex, "findFilesRecursivelyRegex");
 
 export { findFilesRecursively, findFilesRecursivelyRegex, findFilesRecursivelyStringEndsWith, findFilesRecursivelyStringIncludes, findFilesRecursivelyStringStartsWith };
+//# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.mjs.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapphire/node-utilities",
-  "version": "1.1.0-next.f555c82.0",
+  "version": "1.1.0-pr-434.d192d9e.0",
   "description": "Node specific JavaScript utilities for the Sapphire Community",
   "author": "@sapphire",
   "license": "MIT",
@@ -55,12 +55,12 @@
     "access": "public"
   },
   "devDependencies": {
-    "@favware/cliff-jumper": "^1.8.8",
-    "@vitest/coverage-c8": "^0.23.4",
-    "tsup": "^6.2.3",
-    "typedoc": "^0.23.15",
-    "typedoc-json-parser": "^5.0.1",
-    "typescript": "^4.8.4",
-    "vitest": "^0.23.4"
+    "@favware/cliff-jumper": "^1.9.0",
+    "@vitest/coverage-c8": "^0.26.2",
+    "tsup": "^6.5.0",
+    "typedoc": "^0.23.23",
+    "typedoc-json-parser": "^7.0.2",
+    "typescript": "^4.9.4",
+    "vitest": "^0.26.2"
   }
 }