@universal-packages/module-loader - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

loadModules.d.ts

 import { LoadModulesOptions, ModuleRegistry } from './loadModules.types';
 /**
  *
- * Starts importing recusively until it finds a package, index file or just a file in that order
+ * Starts importing recursively until it finds a package, index file or just a file in that order
  *
@@ -6,0 +6,0 @@ * If it finds a package.json it will just import the main file in the package

loadModules.js

@@ -34,3 +34,3 @@ "use strict";
  *
- * Starts importing recusively until it finds a package, index file or just a file in that order
+ * Starts importing recursively until it finds a package, index file or just a file in that order
  *
@@ -88,3 +88,3 @@ * If it finds a package.json it will just import the main file in the package
 }
-/** Creates a registry in the current redult packed with an error if any */
+/** Creates a registry in the current result packed with an error if any */
 async function importAndRegister(location, type, options) {
@@ -91,0 +91,0 @@ try {

package.json

 {
   "name": "@universal-packages/module-loader",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Imports deeply all modules in a directory as a list to use later",
@@ -13,6 +13,7 @@ "author": "David De Anda <[e-mail]> (https://github.com/universal-packages)",
     "test": "jest --watch",
-    "test:full": "jest --coverage --verbose"
+    "test:full": "jest --coverage --verbose",
+    "test:clear": "jest --clearCache"
   },
   "dependencies": {
-    "@universal-packages/directory-traversal": "^1.2.0"
+    "@universal-packages/directory-traversal": "1.2.1"
   },
@@ -19,0 +20,0 @@ "devDependencies": {

README.md

@@ -7,3 +7,3 @@ # Module Loader
 
-Imports deeply all modules in a directory as a list to use later, this is useful when you are expecting a arbitrary amount of modules that behaves the same and can be used without the need of importing them manually or even importing them manually will be a hasel, it can also be useful to activate modules (probably with decorators) that need to be activated before being imported manually later.
+Imports deeply all modules in a directory as a list to use later, this is useful when you are expecting a arbitrary amount of modules that behaves the same and can be used without the need of importing them manually or even importing them manually will be a hazel, it can also be useful to activate modules (probably with decorators) that need to be activated before being imported manually later.
 
@@ -16,6 +16,8 @@ ## Install
 
-## loadModules()
+## Global methods
 
-Load recusively a directory until it finds a package, index file or just a file in that order, If it finds a package.json it will just import the main file in the package, If it find and index file it will just import that index file, If any of above it will just import files deep in the hierarchy.
+#### **`loadModules(location: string, [options])`**
 
+Load recursively a directory until it finds a package, index file or just a file in that order, If it finds a package.json it will just import the main file in the package, If it find and index file it will just import that index file, If any of above it will just import files deep in the hierarchy.
+
 ```js
@@ -25,3 +27,3 @@ import { loadModules } from '@universal-packages/module-loader'
 async function test() {
-  const modules = await loadconfig('./modules')
+  const modules = await loadModules('./modules')
 
@@ -40,6 +42,6 @@ console.log(modules)
 
-## Options
+### Options
 
 - **`onlyDefault`** `boolean`
-  When loading the module directly only set `exports` as the `exports.default`, usefull if you are importing classes or components that predominate in the module.
+  When loading the module directly only set `exports` as the `exports.default`, useful if you are importing classes or components that predominate in the module.
 
@@ -53,3 +55,3 @@ - **`conventionPrefix`** `string`
   async function test() {
-    const modules = await loadconfig('./modules', { conventionPrefix:  })
+    const modules = await loadModules('./modules', { conventionPrefix:  })
 
@@ -74,3 +76,3 @@ console.log(modules)
 
-The development of this library in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving this library.
+The development of this library happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving this library.
 
@@ -83,5 +85,1 @@ - [Code of Conduct](./CODE_OF_CONDUCT.md)
 [MIT licensed](./LICENSE).
-
-```
-
-```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

14706

increased by8.75%

Number of package files

12

increased by9.09%

Worsened metrics

Number of lines in readme file

79

decreased by-2.47%

Dependency changes

• + Added@universal-packages/directory-traversal@1.2.1(transitive)

• + Added@universal-packages/fs-utils@1.0.1(transitive)

• - Removed@universal-packages/directory-traversal@1.4.1(transitive)

• - Removed@universal-packages/fs-utils@1.2.0(transitive)

• Updated@universal-packages/directory-traversal@1.2.1