si-funciona 2.2.3 → 2.2.5

package/dist/helpers/objects/reduceObject.js

@@ -15,7 +15,6 @@ function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { d
  * This function is intended to replicate behaviour of the Array.reduce() function but for Objects.
  * If an array is passed in instead then it will perform standard reduce(). It is recommended to
  * always use the standard reduce() function when it is known that the object is actually an array.
- * @function
  * @memberOf module:objectHelpers
  * @param {Object|Array} obj - The Object (or Array) to be filtered
  * @param {module:objectHelpers~reduceCallback|Function|reduceCallback} fn - The function to be processed for each filtered property

package/dist/helpers/objects/setAndReturnValue.d.ts

@@ -4,7 +4,6 @@ type settableItem = Array<any> | {
 };
 /**
  * Set a value on an item, then return the value
- * @function
  * @memberOf module:objectHelpers
  * @param {Object|Array} item - An object or array to be updated
  * @param {string|number} key - The key on the item which will have its value set

package/dist/helpers/objects/setAndReturnValue.js

@@ -7,7 +7,6 @@ exports.default = void 0
 require('core-js/stable')
 /**
  * Set a value on an item, then return the value
- * @function
  * @memberOf module:objectHelpers
  * @param {Object|Array} item - An object or array to be updated
  * @param {string|number} key - The key on the item which will have its value set

package/dist/helpers/objects/setValue.d.ts

@@ -5,7 +5,6 @@ type settableItem = Array<any> | {
 /**
  * Set a value on an item, then return the item.
  * NOTE: Argument order designed for usage with pipe
- * @function
  * @memberOf module:objectHelpers
  * @param {string|number} key - The key on the item which will have its value set
  * @param {*} value - Any value to be applied to the key

package/dist/helpers/objects/setValue.js

@@ -8,7 +8,6 @@ require('core-js/stable')
 /**
  * Set a value on an item, then return the item.
  * NOTE: Argument order designed for usage with pipe
- * @function
  * @memberOf module:objectHelpers
  * @param {string|number} key - The key on the item which will have its value set
  * @param {*} value - Any value to be applied to the key

package/dist/helpers/strings/camelCase.d.ts

@@ -1,7 +1,6 @@
 import 'core-js/stable';
 /**
  * Given a string in kebab-case, snake_case or 'Sentence case', convert to camelCase.
- * @function
  * @memberOf module:stringHelpers
  * @param {string} str
  * @returns {string}

package/dist/helpers/strings/camelCase.js

@@ -13,7 +13,6 @@ var _words = _interopRequireDefault(require('./words'))
 function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { default: obj } }
 /**
  * Given a string in kebab-case, snake_case or 'Sentence case', convert to camelCase.
- * @function
  * @memberOf module:stringHelpers
  * @param {string} str
  * @returns {string}

package/dist/helpers/strings/kabobCase.d.ts

@@ -1,7 +1,6 @@
 import 'core-js/stable';
 /**
  * Given a string in snake_case, camelCase or 'Sentence case', convert to kabob-case.
- * @function
  * @memberOf module:stringHelpers
  * @param {string} str
  * @returns {string}

package/dist/helpers/strings/kabobCase.js

@@ -12,7 +12,6 @@ var _words = _interopRequireDefault(require('./words'))
 function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { default: obj } }
 /**
  * Given a string in snake_case, camelCase or 'Sentence case', convert to kabob-case.
- * @function
  * @memberOf module:stringHelpers
  * @param {string} str
  * @returns {string}

package/dist/helpers/strings/makeFilepath.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Format the given path so that it does not have trailing slashes and also correctly appends a path.
+ * @memberOf module:stringHelpers
+ * @param {string} root
+ * @param {string} [append='']
+ * @returns {string}
+ */
+export declare const makeFilepath: (root: string, append?: string) => string;
+export default makeFilepath;

package/dist/helpers/strings/makeFilepath.js

@@ -0,0 +1,50 @@
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.makeFilepath = exports.default = void 0
+var _strBeforeLast = _interopRequireDefault(require('./strBeforeLast'))
+function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { default: obj } }
+/**
+ * Format the given path so that it does not have trailing slashes and also correctly appends a path.
+ * @memberOf module:stringHelpers
+ * @param {string} root
+ * @param {string} [append='']
+ * @returns {string}
+ */
+const makeFilepath = function (root) {
+  let append = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : ''
+  if (root.startsWith('./')) {
+    root = root.slice(2)
+  }
+  if (root.startsWith('/')) {
+    root = root.slice(1)
+  }
+  if (root.endsWith('/')) {
+    root = root.slice(0, -1)
+  }
+  if (append.startsWith('/')) {
+    append = append.slice(1)
+  }
+  if (append.startsWith('./')) {
+    append = append.slice(2)
+  }
+  if (append.startsWith('../')) {
+    if (!root) {
+      return append.endsWith('/') ? append.slice(0, -1) : append
+    }
+    append = append.slice(3)
+    root = (0, _strBeforeLast.default)(root, '/')
+    return makeFilepath(root, append)
+  }
+  if (append.endsWith('/')) {
+    append = append.slice(0, -1)
+  }
+  if (!root) {
+    return append
+  }
+  return append ? `${root}/${append}` : root
+}
+exports.makeFilepath = makeFilepath
+var _default = exports.default = makeFilepath

package/dist/helpers/strings/makeFilepath.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.makeFilepath=exports.default=void 0;var _strBeforeLast=_interopRequireDefault(require("./strBeforeLast"));function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}const makeFilepath=function(e){let t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:"";return e.startsWith("./")&&(e=e.slice(2)),e.startsWith("/")&&(e=e.slice(1)),e.endsWith("/")&&(e=e.slice(0,-1)),t.startsWith("/")&&(t=t.slice(1)),t.startsWith("./")&&(t=t.slice(2)),t.startsWith("../")?e?(t=t.slice(3),e=(0,_strBeforeLast.default)(e,"/"),makeFilepath(e,t)):t.endsWith("/")?t.slice(0,-1):t:(t.endsWith("/")&&(t=t.slice(0,-1)),e?t?`${e}/${t}`:e:t)};exports.makeFilepath=makeFilepath;var _default=exports.default=makeFilepath;

package/dist/helpers/strings/makeRelativePath.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Compare two file paths and simplify them to a relative path.
+ * @memberOf module:stringHelpers
+ * @param {string} fromFile
+ * @param {string} toFile
+ * @return {string}
+ */
+export declare const makeRelativePath: (fromFile: string, toFile: string) => string;
+export default makeRelativePath;

package/dist/helpers/strings/makeRelativePath.js

@@ -0,0 +1,43 @@
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.makeRelativePath = exports.default = void 0
+var _strBefore = _interopRequireDefault(require('./strBefore'))
+var _strAfter = _interopRequireDefault(require('./strAfter'))
+function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { default: obj } }
+/**
+ * Compare two file paths and simplify them to a relative path.
+ * @memberOf module:stringHelpers
+ * @param {string} fromFile
+ * @param {string} toFile
+ * @return {string}
+ */
+const makeRelativePath = (fromFile, toFile) => {
+  let relativePath = toFile
+  let nextPart = fromFile
+  let firstPart = (0, _strBefore.default)(nextPart, '/')
+  let hasMatches = false
+  while (firstPart && relativePath.startsWith(firstPart)) {
+    relativePath = (0, _strAfter.default)(relativePath, `${firstPart}/`)
+    nextPart = (0, _strAfter.default)(nextPart, `${firstPart}/`)
+    firstPart = (0, _strBefore.default)(nextPart, '/')
+    hasMatches = true
+  }
+  if (!hasMatches) {
+    // No similar base paths, use the path as-is
+    return relativePath
+  }
+  let relativePrefix = ''
+  const nextParts = nextPart.split('/')
+  if (nextParts.length < 2) {
+    relativePrefix = './'
+  }
+  for (let i = 1; i < nextParts.length; ++i) {
+    relativePrefix += '../'
+  }
+  return relativePrefix + relativePath
+}
+exports.makeRelativePath = makeRelativePath
+var _default = exports.default = makeRelativePath

package/dist/helpers/strings/makeRelativePath.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.makeRelativePath=exports.default=void 0;var _strBefore=_interopRequireDefault(require("./strBefore")),_strAfter=_interopRequireDefault(require("./strAfter"));function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}const makeRelativePath=(e,t)=>{let r=t,a=e,l=(0,_strBefore.default)(a,"/"),f=!1;for(;l&&r.startsWith(l);)r=(0,_strAfter.default)(r,`${l}/`),a=(0,_strAfter.default)(a,`${l}/`),l=(0,_strBefore.default)(a,"/"),f=!0;if(!f)return r;let u="";const s=a.split("/");s.length<2&&(u="./");for(let e=1;e<s.length;++e)u+="../";return u+r};exports.makeRelativePath=makeRelativePath;var _default=exports.default=makeRelativePath;

package/dist/helpers/strings/regexEscape.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Take a string and escape the regex characters.
+ * @memberOf module:stringHelpers
+ * @param {string} str
+ * @returns {string}
+ */
+export declare const regexEscape: (str: string) => string;
+export default regexEscape;

package/dist/helpers/strings/regexEscape.js

@@ -0,0 +1,15 @@
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.regexEscape = exports.default = void 0
+/**
+ * Take a string and escape the regex characters.
+ * @memberOf module:stringHelpers
+ * @param {string} str
+ * @returns {string}
+ */
+const regexEscape = str => str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
+exports.regexEscape = regexEscape
+var _default = exports.default = regexEscape

package/dist/helpers/strings/regexEscape.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.regexEscape=exports.default=void 0;const regexEscape=e=>e.replace(/[.*+?^${}()|[\]\\]/g,"\\$&");exports.regexEscape=regexEscape;var _default=exports.default=regexEscape;

package/dist/helpers/strings/snakeCase.d.ts

@@ -1,7 +1,6 @@
 import 'core-js/stable';
 /**
  * Given a string in kebab-case, camelCase or 'Sentence case', convert to snake_case.
- * @function
  * @memberOf module:stringHelpers
  * @param {string} str
  * @returns {string}

package/dist/helpers/strings/snakeCase.js

@@ -12,7 +12,6 @@ var _words = _interopRequireDefault(require('./words'))
 function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { default: obj } }
 /**
  * Given a string in kebab-case, camelCase or 'Sentence case', convert to snake_case.
- * @function
  * @memberOf module:stringHelpers
  * @param {string} str
  * @returns {string}

package/dist/helpers/strings/strAfter.d.ts

@@ -1,7 +1,6 @@
 import 'core-js/stable';
 /**
  * Retrieve the string part after the search match.
- * @function
  * @memberOf module:stringHelpers
  * @param {string} str
  * @param {string} search

package/dist/helpers/strings/strAfter.js

@@ -7,7 +7,6 @@ exports.default = void 0
 require('core-js/stable')
 /**
  * Retrieve the string part after the search match.
- * @function
  * @memberOf module:stringHelpers
  * @param {string} str
  * @param {string} search

package/dist/helpers/strings/strAfterLast.d.ts

@@ -1,7 +1,6 @@
 import 'core-js/stable';
 /**
  * Retrieve the string part after the last search match.
- * @function
  * @memberOf module:stringHelpers
  * @param {string} str
  * @param {string} search

package/dist/helpers/strings/strAfterLast.js

@@ -7,7 +7,6 @@ exports.default = void 0
 require('core-js/stable')
 /**
  * Retrieve the string part after the last search match.
- * @function
  * @memberOf module:stringHelpers
  * @param {string} str
  * @param {string} search

package/dist/helpers/strings/strBefore.d.ts

@@ -1,7 +1,6 @@
 import 'core-js/stable';
 /**
  * Retrieve the string part before the search match.
- * @function
  * @memberOf module:stringHelpers
  * @param {string} str
  * @param {string} search

package/dist/helpers/strings/strBefore.js

@@ -7,7 +7,6 @@ exports.default = void 0
 require('core-js/stable')
 /**
  * Retrieve the string part before the search match.
- * @function
  * @memberOf module:stringHelpers
  * @param {string} str
  * @param {string} search

package/dist/helpers/strings/strBeforeLast.d.ts

@@ -1,7 +1,6 @@
 import 'core-js/stable';
 /**
  * Retrieve the string part after the last search match.
- * @function
  * @memberOf module:stringHelpers
  * @param {string} str
  * @param {string} search

package/dist/helpers/strings/strBeforeLast.js

@@ -7,7 +7,6 @@ exports.default = void 0
 require('core-js/stable')
 /**
  * Retrieve the string part after the last search match.
- * @function
  * @memberOf module:stringHelpers
  * @param {string} str
  * @param {string} search

package/dist/helpers/strings/titleCase.d.ts

@@ -1,7 +1,6 @@
 import 'core-js/stable';
 /**
  * Given a string in kebab-case, snake_case, camelCase or 'Sentence case', convert to 'Title Case'.
- * @function
  * @memberOf module:stringHelpers
  * @param {string} str
  * @returns {string}

package/dist/helpers/strings/titleCase.js

@@ -13,7 +13,6 @@ var _words = _interopRequireDefault(require('./words'))
 function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { default: obj } }
 /**
  * Given a string in kebab-case, snake_case, camelCase or 'Sentence case', convert to 'Title Case'.
- * @function
  * @memberOf module:stringHelpers
  * @param {string} str
  * @returns {string}

package/dist/helpers/strings/ucFirst.d.ts

@@ -1,7 +1,6 @@
 import 'core-js/stable';
 /**
  * Given a string, make the first character uppercase and the rest lowercase.
- * @function
  * @memberOf module:stringHelpers
  * @param {string} str
  * @returns {string}

package/dist/helpers/strings/ucFirst.js

@@ -7,7 +7,6 @@ exports.default = void 0
 require('core-js/stable')
 /**
  * Given a string, make the first character uppercase and the rest lowercase.
- * @function
  * @memberOf module:stringHelpers
  * @param {string} str
  * @returns {string}

package/dist/helpers/strings/words.d.ts

@@ -1,7 +1,6 @@
 import 'core-js/stable';
 /**
  * Split a string into sets of numbers or letters.
- * @function
  * @memberOf module:stringHelpers
  * @param {string} str
  * @returns {array}

package/dist/helpers/strings/words.js

@@ -7,7 +7,6 @@ exports.default = void 0
 require('core-js/stable')
 /**
  * Split a string into sets of numbers or letters.
- * @function
  * @memberOf module:stringHelpers
  * @param {string} str
  * @returns {array}

package/dist/helpers/strings.d.ts

@@ -10,6 +10,9 @@ import 'core-js/stable';
 declare const _default: {
     camelCase: (str: string) => string;
     kabobCase: (str: string) => string;
+    makeFilepath: (root: string, append?: string) => string;
+    makeRelativePath: (fromFile: string, toFile: string) => string;
+    regexEscape: (str: string) => string;
     snakeCase: (str: string) => string;
     strAfter: (str: string, search: string) => string;
     strAfterLast: (str: string, search: string) => string;

package/dist/helpers/strings.js

@@ -7,6 +7,9 @@ exports.default = void 0
 require('core-js/stable')
 var _camelCase = _interopRequireDefault(require('./strings/camelCase'))
 var _kabobCase = _interopRequireDefault(require('./strings/kabobCase'))
+var _makeFilepath = _interopRequireDefault(require('./strings/makeFilepath'))
+var _makeRelativePath = _interopRequireDefault(require('./strings/makeRelativePath'))
+var _regexEscape = _interopRequireDefault(require('./strings/regexEscape'))
 var _snakeCase = _interopRequireDefault(require('./strings/snakeCase'))
 var _strAfter = _interopRequireDefault(require('./strings/strAfter'))
 var _strAfterLast = _interopRequireDefault(require('./strings/strAfterLast'))
@@ -27,6 +30,9 @@ function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { d
 var _default = exports.default = {
   camelCase: _camelCase.default,
   kabobCase: _kabobCase.default,
+  makeFilepath: _makeFilepath.default,
+  makeRelativePath: _makeRelativePath.default,
+  regexEscape: _regexEscape.default,
   snakeCase: _snakeCase.default,
   strAfter: _strAfter.default,
   strAfterLast: _strAfterLast.default,

package/dist/helpers/strings.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0,require("core-js/stable");var _camelCase=_interopRequireDefault(require("./strings/camelCase")),_kabobCase=_interopRequireDefault(require("./strings/kabobCase")),_snakeCase=_interopRequireDefault(require("./strings/snakeCase")),_strAfter=_interopRequireDefault(require("./strings/strAfter")),_strAfterLast=_interopRequireDefault(require("./strings/strAfterLast")),_strBefore=_interopRequireDefault(require("./strings/strBefore")),_strBeforeLast=_interopRequireDefault(require("./strings/strBeforeLast")),_titleCase=_interopRequireDefault(require("./strings/titleCase")),_ucFirst=_interopRequireDefault(require("./strings/ucFirst")),_words=_interopRequireDefault(require("./strings/words"));function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}var _default=exports.default={camelCase:_camelCase.default,kabobCase:_kabobCase.default,snakeCase:_snakeCase.default,strAfter:_strAfter.default,strAfterLast:_strAfterLast.default,strBefore:_strBefore.default,strBeforeLast:_strBeforeLast.default,titleCase:_titleCase.default,ucFirst:_ucFirst.default,words:_words.default};
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0,require("core-js/stable");var _camelCase=_interopRequireDefault(require("./strings/camelCase")),_kabobCase=_interopRequireDefault(require("./strings/kabobCase")),_makeFilepath=_interopRequireDefault(require("./strings/makeFilepath")),_makeRelativePath=_interopRequireDefault(require("./strings/makeRelativePath")),_regexEscape=_interopRequireDefault(require("./strings/regexEscape")),_snakeCase=_interopRequireDefault(require("./strings/snakeCase")),_strAfter=_interopRequireDefault(require("./strings/strAfter")),_strAfterLast=_interopRequireDefault(require("./strings/strAfterLast")),_strBefore=_interopRequireDefault(require("./strings/strBefore")),_strBeforeLast=_interopRequireDefault(require("./strings/strBeforeLast")),_titleCase=_interopRequireDefault(require("./strings/titleCase")),_ucFirst=_interopRequireDefault(require("./strings/ucFirst")),_words=_interopRequireDefault(require("./strings/words"));function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}var _default=exports.default={camelCase:_camelCase.default,kabobCase:_kabobCase.default,makeFilepath:_makeFilepath.default,makeRelativePath:_makeRelativePath.default,regexEscape:_regexEscape.default,snakeCase:_snakeCase.default,strAfter:_strAfter.default,strAfterLast:_strAfterLast.default,strBefore:_strBefore.default,strBeforeLast:_strBeforeLast.default,titleCase:_titleCase.default,ucFirst:_ucFirst.default,words:_words.default};

package/package.json

@@ -13,7 +13,7 @@
     "general",
     "typescript"
   ],
-  "version": "2.2.3",
+  "version": "2.2.5",
   "license": "GPL-3.0-or-later",
   "bugs": {
     "url": "https://github.com/jheagle/si-funciona/issues"
@@ -30,14 +30,15 @@
     "watch:test": "gulp watchTest"
   },
   "dependencies": {
-    "npm": "^10.2.5"
+    "npm": "^10.4.0"
   },
   "devDependencies": {
-    "collect-your-stuff": "^1.1.5",
+    "collect-your-stuff": "^1.1.7",
     "gulp": "^4.0.2",
-    "js-build-tools": "^2.3.1",
+    "js-build-tools": "^3.0.1",
     "jsdoc": "^4.0.2",
-    "standard": "^17.1.0"
+    "standard": "^17.1.0",
+    "test-filesystem": "^1.3.1"
   },
   "resolutions": {},
   "repository": {
@@ -45,7 +46,7 @@
     "url": "git+https://github.com/jheagle/si-funciona.git"
   },
   "main": "dist/main.min.js",
-  "types": "dist/main.js",
+  "types": "dist/main.d.ts",
   "files": [
     "dist",
     "browser"