directory-import - npm Package Compare versions

Comparing version 3.0.7 to 3.0.8

package.json

 {
   "name": "directory-import",
-  "version": "3.0.7",
+  "version": "3.0.8",
   "description": "Module will allow you to synchronously or asynchronously import (requires) all modules from the folder you specify",
@@ -11,4 +11,5 @@ "main": "dist/src/index.js",
   "scripts": {
-    "build": "rimraf ./dist && tsc && rimraf ./dist/test && rimraf ./dist/sample-directory",
+    "build": "rimraf ./dist && tsc",
     "start": "npm run dist && node dist/index.js",
+    "publish": "npm run build && npm publish",
     "jest": "npm run build && jest --silent",
@@ -15,0 +16,0 @@ "jest:watcher": "jest --watchAll"

README.md

@@ -8,3 +8,3 @@ <!--suppress HtmlDeprecatedAttribute -->
     <a href="https://discord.gg/ADFYZtJ">
-      <img src="https://img.shields.io/discord/219557939466338304?label=Discord%20chat%20(rus)" alt="Discord server">
+      <img src="https://img.shields.io/discord/219557939466338304?label=Discord%20chat" alt="Discord server">
     </a>
@@ -21,6 +21,5 @@ </p>
 
-Module will allow you to synchronously or asynchronously import (requires) all modules from the folder you specify.
+Module for automatic import of files from a directory and subdirectories (sync and async).
+You can use imported modules either from the returned object or in the callback function.
 
-You can use modules from the returned object, or you can invoke function per file
-
 ---
@@ -30,15 +29,30 @@
 
+```bash
+npm install directory-import
 ```
-npm i directory-import
-```
 
-After install, you can require module and import files:
+After installation, you can use the module in your project:
 
-```javascript
+```js
 const { directoryImport } = require('directory-import');
 
-// Returns: { filePath1: fileData1, filePath2: fileData2, ... },
-const importedModules = directoryImport('./');
+const importedModules = directoryImport('./path/to/directory');
+
+// Will output an object with imported modules
+// For example: { modulePath1: module1, modulePath2: module2, ... }
+console.log(importedModules);
 ```
 
+or:
+
+```ts
+import { directoryImport } from 'directory-import';
+
+const importedModules = directoryImport('./path/to/directory');
+
+// Will output an object with imported modules
+// For example: { modulePath1: module1, modulePath2: module2, ... }
+console.log(importedModules);
+```
+
 ---
@@ -53,3 +67,3 @@
 
-const importedModules = directoryImport('../sample-directory');
+const importedModules = directoryImport('./sample-directory');
 
@@ -72,3 +86,3 @@ console.info(importedModules);
 
-directoryImport('../sample-directory', (moduleName, modulePath, moduleData) => {
+directoryImport('./sample-directory', (moduleName, modulePath, moduleData) => {
   console.info({ moduleName, modulePath, moduleData });
@@ -82,42 +96,96 @@ });
 
----
+### {Function} Callback properties:
 
-### {Function} Callback:
+| Property | Type   | Description                                                  |
+| -------- | ------ | ------------------------------------------------------------ |
+| name     | String | Module name based on file name                               |
+| path     | String | Relative module path                                         |
+| data     | String | Exported data of the module. (Ex: "module.exports = 'test'") |
+| index    | Number | Imported module index                                        |
 
-| Property | Type   | Description        |
-| -------- | ------ | ------------------ |
-| fileName | String | File name          |
-| filePath | String | File path          |
-| fileData | String | Exported file data |
-| index    | Number | The module index   |
+### {Object} Options properties:
 
+| Property              | Type    | Description                                               |
+| --------------------- | ------- | --------------------------------------------------------- |
+| includeSubdirectories | Boolean | If true, the module will import files from subdirectories |
+| targetDirectoryPath   | String  | The path to the directory to import modules from          |
+| importPattern         | RegExp  | RegExp pattern to filter files                            |
+| importMode            | String  | The import mode. Can be 'sync' or 'async'                 |
+| limit                 | Number  | Limit the number of imported modules                      |
+
 ---
 
-## More examples
+### More examples:
 
-#### Minimum code to run modules that are in the same folder as the code below:
+Minimum code to use:
 
-```javascript
+```js
 const { directoryImport } = require('directory-import');
 
+// Will synchronously import all files in the same directory as the code was called
 directoryImport();
 ```
 
-#### Async call:
+Asynchronously import files from the specified directory:
 
-```javascript
+```js
 const { directoryImport } = require('directory-import');
 
-const importedModules = directoryImport('../sample-directory', 'async');
+const result = directoryImport('./path/to/directory', 'async');
 
 // Promise { <pending> }
+console.log(result);
+```
+
+Put result in a variable and invoce callback on each file:
+
+```js
+const { directoryImport } = require('directory-import');
+
+const importedModules = directoryImport('./path/to/directory', (moduleName, modulePath, moduleData) => {
+  // {
+  //   moduleName: 'sample-file-1',
+  //   modulePath: '/sample-file-1.js',
+  //   moduleData: 'This is first sampleFile'
+  // }
+  // ...
+  console.info({ moduleName, modulePath, moduleData });
+});
+
+// {
+//   '/sample-file-1.js': 'This is first sampleFile',
+//   ...
+// }
 console.info(importedModules);
 ```
 
-#### Async call with callback:
+---
 
-```javascript
+### Overloads:
+
+```js
 const { directoryImport } = require('directory-import');
 
-directoryImport('../sample-directory', 'async', (moduleName, modulePath, moduleData) => {
+/**
+ * Import modules from the current directory synchronously
+ * @returns {Object} An object containing all imported modules.
+ */
+const importedModules = directoryImport();
+
+// {
+//   '/sample-file-1.js': 'This is first sampleFile',
+//   ...
+// }
+console.log(importedModules);
+```
+
+```js
+const { directoryImport } = require('directory-import');
+
+/**
+ * Import modules from the current directory synchronously and call the provided callback for each imported module.
+ * @param {Function} callback - The callback function to call for each imported module.
+ * @returns {Object} An object containing all imported modules.
+ */
+directoryImport((moduleName, modulePath, moduleData) => {
   // {
@@ -133,8 +201,29 @@ //   moduleName: 'sample-file-1',
 
-#### Put the result in a variable and invoke a callback for each module
+```js
+const { directoryImport } = require('directory-import');
 
-```javascript
+/**
+ * Import modules from the specified directory synchronously
+ * @param {String} directoryPath - The path to the directory from which you want to import modules.
+ * @returns {Object} An object containing all imported modules.
+ */
+const importedModules = directoryImport('./path/to/directory');
+
+// {
+//   '/sample-file-1.js': 'This is first sampleFile',
+//   ...
+// }
+console.log(importedModules);
+```
+
+```js
 const { directoryImport } = require('directory-import');
 
-const importedModules = directoryImport('../sample-directory', (moduleName, modulePath, moduleData) => {
+/**
+ * Import modules from the specified directory synchronously and call the provided callback for each imported module.
+ * @param {String} directoryPath - The path to the directory from which you want to import modules.
+ * @param {Function} callback - The callback function to call for each imported module.
+ * @returns {Object} An object containing all imported modules.
+ */
+directoryImport('./path/to/directory', (moduleName, modulePath, moduleData) => {
   // {
@@ -148,3 +237,15 @@ //   moduleName: 'sample-file-1',
 });
+```
 
+```js
+const { directoryImport } = require('directory-import');
+
+/**
+ * Import all modules from the specified directory synchronously or asynchronously.
+ * @param {string} targetDirectoryPath - The path to the directory to import modules from.
+ * @param {'sync'|'async'} mode - The import mode. Can be 'sync' or 'async'.
+ * @returns {Object} An object containing all imported modules.
+ */
+const importModules = directoryImport('./path/to/directory', 'sync');
+
 // {
@@ -154,19 +255,92 @@ //   '/sample-file-1.js': 'This is first sampleFile',
 // }
-console.info(importedModules);
+console.log(importedModules);
 ```
 
+```js
+const { directoryImport } = require('directory-import');
+
+/**
+ * Import all modules from the specified directory synchronously or asynchronously and call the provided callback for each imported module.
+ * @param {string} targetDirectoryPath - The path to the directory to import modules from.
+ * @param {'sync'|'async'} mode - The import mode. Can be 'sync' or 'async'.
+ * @param {Function} callback - The callback function to call for each imported module.
+ * @returns {Object} An object containing all imported modules.
+ */
+directoryImport('./path/to/directory', 'sync', (moduleName, modulePath, moduleData) => {
+  // {
+  //   moduleName: 'sample-file-1',
+  //   modulePath: '/sample-file-1.js',
+  //   moduleData: 'This is first sampleFile'
+  // }
+  // ...
+  console.info({ moduleName, modulePath, moduleData });
+});
+```
+
+```js
+const { directoryImport } = require('directory-import');
+
+const options = {
+  includeSubdirectories: true,
+  targetDirectoryPath: './path/to/directory',
+  importPattern: /\.js/,
+  importMode: 'sync',
+  limit: 2,
+};
+
+/**
+ * Import all modules from the specified directory
+ * @param {Object} targetDirectoryPath - options - The options object.
+ * @returns {Object} An object containing all imported modules.
+ */
+const importModules = directoryImport(options);
+
+// {
+//   '/sample-file-1.js': 'This is first sampleFile',
+//   ...
+// }
+console.log(importedModules);
+```
+
+```js
+const { directoryImport } = require('directory-import');
+
+const options = {
+  includeSubdirectories: true,
+  targetDirectoryPath: './path/to/directory',
+  importPattern: /\.js/,
+  importMode: 'sync',
+  limit: 2,
+};
+
+/**
+ * Import all modules from the specified directory and call the provided callback for each imported module.
+ * @param {Object} targetDirectoryPath - options - The options object.
+ * @param {Function} callback - The callback function to call for each imported module.
+ * @returns {Object} An object containing all imported modules.
+ */
+directoryImport(options, (moduleName, modulePath, moduleData) => {
+  // {
+  //   moduleName: 'sample-file-1',
+  //   modulePath: '/sample-file-1.js',
+  //   moduleData: 'This is first sampleFile'
+  // }
+  // ...
+  console.info({ moduleName, modulePath, moduleData });
+});
+```
+
 ---
 
-## Help
+### Help
 
-If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [Discord server][discordServer].
+- If you have any questions, you can ask them in the [Discord server][discordServer].
+- If you find a bug, or you have any suggestions? please create an issue on [GitHub issues][gitIssues].
+- If you want to help with the development of the project, you can create a pull request on [GitHub pull requests][gitPullRequests].
+- If you like the project, you can put a star on [GitHub][gitProject].
 
-<a href="https://discord.gg/ADFYZtJ">
-  <img src="https://img.shields.io/discord/219557939466338304?label=Discord%20chat" alt="Discord server">
-</a>
-
 [pathToDirectoryFromGif]: https://github.com/KiiDii/directory-import/tree/master/sample-directory
-[regex101]: https://regex101.com/r/mp8lkk/1
-[webpackExample]: https://github.com/KiiDii/directory-import#using-with-webpack
 [discordServer]: https://discord.gg/ADFYZtJ
-[jsFileIcon]: https://www.flaticon.com/svg/static/icons/svg/2306/2306122.svg 'Logo Title Text 2'
+[gitProject]: https://github.com/ANIname/directory-import
+[gitIssues]: https://github.com/ANIname/directory-import/issues
+[gitPullRequests]: https://github.com/ANIname/directory-import/pulls

No alert changes

Improved metrics

Total package byte prevSize

31219

increased by23.32%

Number of lines in readme file

338

increased by106.1%

No dependency changes