@adobe/aio-lib-core-config - npm Package Compare versions

Comparing version 2.0.1 to 3.0.0

package.json

 {
   "name": "@adobe/aio-lib-core-config",
-  "version": "2.0.1",
+  "version": "3.0.0",
   "description": "Adobe I/O Configuration Module",
@@ -10,3 +10,3 @@ "main": "./src/index.js",
   "engines": {
-    "node": ">=10.0"
+    "node": "^14.18 || ^16.13 || >=18"
   },
@@ -41,5 +41,5 @@ "files": [
     "eslint-plugin-standard": "^4.0.0",
-    "jest": "^24.5.0",
+    "jest": "^24.9.0",
     "jest-plugin-fs": "^2.9.0",
-    "jsdoc-to-markdown": "^5.0.1",
+    "jsdoc-to-markdown": "^5.0.3",
     "mock-stdin": "^1.0.0",
@@ -46,0 +46,0 @@ "tsd-jsdoc": "^2.4.0"

src/dotenv.js

@@ -91,8 +91,2 @@ /*
 
-/**
- * hoists variables in the ./.env file to process.env
- *
- * @param {Function} debug optional function for debugging
- *
- */
 module.exports = function(force = false) {
@@ -99,0 +93,0 @@ const file = path.join(process.cwd(), '.env')

src/index.js

@@ -82,5 +82,2 @@ /*
 
-/**
- * @returns {ConfigAPI}
- */
 module.exports = new ConfigAPI()

src/pipe.js

@@ -15,5 +15,2 @@ /*
 
-/**
- * get piped data from stdin
- */
 module.exports = () => new Promise((resolve) => {
@@ -20,0 +17,0 @@ if (global[status] || process.stdin.isTTY) return resolve(global[status])

types.d.ts

 /**
  * read a file and log exceptions to debug
- *
- * @param {String} file
- * @param {Function} debugFn
  */
@@ -11,4 +8,3 @@ declare function readFile(file: string, debugFn: (...params: any[]) => any): void;
  * parse file for environmental variables
- *
- * @param {String} file filepath to parse
+ * @param file - filepath to parse
  */
@@ -18,8 +14,10 @@ declare function parse(file: string): void;
 /**
+ * parse file for environmental variables and log debug message for duplicate definitions
+ * @param file - filepath to parse
+ */
+declare function checkForDuplicates(file: string): void;
+
+/**
  * returns all keys in o1 that arent in o2
- *
- * @param {Object} o1
- * @param {Object} o2
- *
- * @return {Array} array of keys
+ * @returns array of keys
  */
@@ -40,5 +38,4 @@ declare function diff(o1: any, o2: any): any[];
      * If no parameters are specified, it will return all keys and values of the consolidated Config.
-     *
-     * @param {string} [key=''] the key to get the value from
-     * @param {string} [source] 'global', 'local', or 'env'. Defaults to searching the consolidated config.
+     * @param [key = ''] - the key to get the value from
+     * @param [source] - 'global', 'local', or 'env'. Defaults to searching the consolidated config.
      */
@@ -48,6 +45,5 @@ get(key?: string, source?: string): void;
      * Set the value for a key in the Config.
-     *
-     * @param {string} key the key to set the value to
-     * @param {string} value the value to save for the key
-     * @param {boolean} [local=false] Set to true to save the value in the local config. Defaults to false (save to global config).
+     * @param key - the key to set the value to
+     * @param value - the value to save for the key
+     * @param [local = false] - Set to true to save the value in the local config. Defaults to false (save to global config).
      */
@@ -57,5 +53,4 @@ set(key: string, value: string, local?: boolean): void;
      * Delete a key and its value in the Config.
-     *
-     * @param {string} key the key to delete the value from
-     * @param {boolean} [local=false] Set to true to delete the value in the local config. Defaults to false (save to global config).
+     * @param key - the key to delete the value from
+     * @param [local = false] - Set to true to delete the value in the local config. Defaults to false (save to global config).
      */
@@ -69,5 +64,2 @@ delete(key: string, local?: boolean): void;
      * Pipe data from stdin.
-     *
-     * @function
-     * @return {Promise<string>}
      */
@@ -77,5 +69,3 @@ getPipedData(): Promise<string>;
      * Hoists variables in the ./.env file to process.env
-     *
-     * @function
-     * @param {Object} the dotenv object
+     * @param the - dotenv object
      */
@@ -87,4 +77,3 @@ dotenv(the: any): void;
  * Support for mkdir -p.
- *
- * @param {String} dir the folder to create
+ * @param dir - the folder to create
  */
@@ -95,5 +84,2 @@ declare function mkdirp(dir: string): void;
  * Get property from object with case insensitivity.
- *
- * @param {Object} obj
- * @param {String} key
  */
@@ -104,7 +90,2 @@ declare function getProp(obj: any, key: string): void;
  * Get a value in an object by dot notation.
- *
- * @param {String} key
- * @param {Object} obj
- *
- * @return {Object}
  */
@@ -115,8 +96,2 @@ declare function getValue(key: string, obj: any): any;
  * Set a value by dot notation.
- *
- * @param {String} key
- * @param {String} value
- * @param {Object} [obj]
- *
- * @return {Object}
  */
@@ -127,6 +102,3 @@ declare function setValue(key: string, value: string, obj?: any): any;
  * Deep merge a collection of objs returning a new object.
- *
- * @param  {Array} objs array of objects
- *
- * @return {Object}
+ * @param objs - array of objects
  */
@@ -137,6 +109,2 @@ declare function merge(...objs: any[][]): any;
  * Remove empty leaves from an object.
- *
- * @param {Object} obj
- *
- * @return {Object}
  */
@@ -147,6 +115,2 @@ declare function shake(obj: any): any;
  * Deserialise from a file.
- *
- * @param {String} file
- *
- * @return {Object}
  */
@@ -157,8 +121,4 @@ declare function loadFile(file: string): any;
  * yaml serialise an object to a file.
- *
- * @param {String} file
- * @param {Object} obj
- * @param {String} format
  */
 declare function saveFile(file: string, obj: any, format: string): void;
 

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

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

32911

decreased by-2.09%

Lines of code

529

decreased by-9.11%

No dependency changes