@blackbyte/sugar 1.0.0-beta.27 → 1.0.0-beta.29

package/dist/shared/string/replaceTokens/replaceTokens.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @name                    replaceTokens
+ * @namespace               shared.string
+ * @type                    Function
+ * @platform                js
+ * @platform                node
+ * @status                  stable
+ *
+ * This function takes as parameter a tokened string like "something [cool]", an object
+ * of arguments/values and return the processed string with the tokens replaced by the arguments values.
+ *
+ * @param       {String}          string                The string to process
+ * @param       {Object}          tokensObj             The arguments/value object
+ * @param       {Object}          [settings={}]         A settings object to configure the parsing process
+ * @return      {String}                                The processed string
+ *
+ * @setting     {String}        [regexp=\[([a-zA-Z0-9-_]+)\]        The regexp to use to match the tokens
+ * @setting     {Boolean}       [stripUndefined=true]               Specify if you want to strip the tokens that are not found in the tokensObj
+ *
+ * @snippet         replaceTokens($1, $2)
+ * replaceTokens($1, $2)
+ *
+ * @todo      Add setting to define tokens delimiter
+ * @todo      Support multi level tokens like [something.cool]
+ * @todo      tests
+ *
+ * @example     js
+ * import { replaceTokens } from '@blackbyte/sugar/string';
+ * replaceTokens('hello [world]', { world: 'Coco' }); // => hello Coco
+ *
+ * @since     1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TReplaceTokensSettings = {
+    regexp?: string;
+    stripUndefined?: boolean;
+};
+declare function replaceTokens(string: string, tokensObj: any, settings?: TReplaceTokensSettings): string;
+export default replaceTokens;

package/dist/shared/string/replaceTokens/replaceTokens.js

@@ -0,0 +1,17 @@
+function replaceTokens(string, tokensObj, settings = {}) {
+    var _a;
+    settings = Object.assign({ regexp: '\\[([a-zA-Z0-9-_]+)\\]', stripUndefined: true }, settings);
+    let tokens;
+    const reg = new RegExp((_a = settings.regexp) !== null && _a !== void 0 ? _a : '\\[([a-zA-Z0-9-_]+)\\]', 'g');
+    while ((tokens = reg.exec(string))) {
+        if (tokensObj[tokens[1]] === undefined && !settings.stripUndefined)
+            return '';
+        string = string.replace(tokens[0], tokensObj[tokens[1]] || '');
+    }
+    if (settings.stripUndefined) {
+        string = string.replace(reg, '');
+    }
+    return string;
+}
+export default replaceTokens;
+//# sourceMappingURL=replaceTokens.js.map

package/dist/shared/string/replaceTokens/replaceTokens.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"replaceTokens.js","sourceRoot":"","sources":["../../../../src/shared/string/replaceTokens/replaceTokens.ts"],"names":[],"mappings":"AAsCA,SAAS,aAAa,CACpB,MAAc,EACd,SAAc,EACd,WAAmC,EAAE;;IAErC,QAAQ,mBACN,MAAM,EAAE,wBAAwB,EAChC,cAAc,EAAE,IAAI,IACjB,QAAQ,CACZ,CAAC;IACF,IAAI,MAAM,CAAC;IACX,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,MAAA,QAAQ,CAAC,MAAM,mCAAI,wBAAwB,EAAE,GAAG,CAAC,CAAC;IACzE,OAAO,CAAC,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;QACnC,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,cAAc;YAChE,OAAO,EAAE,CAAC;QACZ,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;QAC5B,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IACnC,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AACD,eAAe,aAAa,CAAC"}

package/dist/shared/string/rtrim/rtrim.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @name                rtrim
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Trim right a specified string
+ *
+ * @param    {String}    string    The string to trim
+ * @param    {String}    needle    The string to find an cut out if found
+ * @param     {Boolean}     [trimResult=true]       Specify if you want to trim the trimed string
+ * @return    {String}    The trimed string
+ *
+ * @todo      tests
+ *
+ * @snippet             rtrim($1, $2)
+ *
+ * @example    js
+ * import { rtrim } from '@blackbyte/sugar/string'
+ * rtrim('Hello World', 'ld') // Hello Wor
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function rtrim(string: string, needle: string, trimResult?: boolean): string;

package/dist/shared/string/rtrim/rtrim.js

@@ -0,0 +1,39 @@
+/**
+ * @name                rtrim
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Trim right a specified string
+ *
+ * @param    {String}    string    The string to trim
+ * @param    {String}    needle    The string to find an cut out if found
+ * @param     {Boolean}     [trimResult=true]       Specify if you want to trim the trimed string
+ * @return    {String}    The trimed string
+ *
+ * @todo      tests
+ *
+ * @snippet             rtrim($1, $2)
+ *
+ * @example    js
+ * import { rtrim } from '@blackbyte/sugar/string'
+ * rtrim('Hello World', 'ld') // Hello Wor
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function rtrim(string, needle, trimResult = true) {
+    if (string.substr(needle.length * -1) === needle) {
+        if (trimResult) {
+            return string.substr(0, string.length - needle.length).trim();
+        }
+        else {
+            return string.substr(0, string.length - needle.length);
+        }
+    }
+    // nothing to trim
+    return string;
+}
+//# sourceMappingURL=rtrim.js.map

package/dist/shared/string/rtrim/rtrim.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rtrim.js","sourceRoot":"","sources":["../../../../src/shared/string/rtrim/rtrim.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,OAAO,UAAU,KAAK,CAC3B,MAAc,EACd,MAAc,EACd,aAAsB,IAAI;IAE1B,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC;QACjD,IAAI,UAAU,EAAE,CAAC;YACf,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;QAChE,CAAC;aAAM,CAAC;YACN,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IACD,kBAAkB;IAClB,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/shared/string/sentenceCase/sentenceCase.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @name                sentenceCase
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Sentence case a string
+ *
+ * @param         {String}          text        The string to snakeCase
+ * @return        {String}                      The snakeCased string
+ *
+ * @todo      tests
+ *
+ * @snippet         sentenceCase($1)
+ *
+ * @example     js
+ * import { sentenceCase } from '@blackbyte/sugar/string';
+ * sentenceCase('hello world'); // => Hello world
+ *
+ * @see             https://www.npmjs.com/package/change-case
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function __sentenceCase(text: string): string;

package/dist/shared/string/sentenceCase/sentenceCase.js

@@ -0,0 +1,30 @@
+import { sentenceCase } from 'change-case';
+/**
+ * @name                sentenceCase
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Sentence case a string
+ *
+ * @param         {String}          text        The string to snakeCase
+ * @return        {String}                      The snakeCased string
+ *
+ * @todo      tests
+ *
+ * @snippet         sentenceCase($1)
+ *
+ * @example     js
+ * import { sentenceCase } from '@blackbyte/sugar/string';
+ * sentenceCase('hello world'); // => Hello world
+ *
+ * @see             https://www.npmjs.com/package/change-case
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function __sentenceCase(text) {
+    return sentenceCase(text);
+}
+//# sourceMappingURL=sentenceCase.js.map

package/dist/shared/string/sentenceCase/sentenceCase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sentenceCase.js","sourceRoot":"","sources":["../../../../src/shared/string/sentenceCase/sentenceCase.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,IAAY;IACjD,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC"}

package/dist/shared/string/simplify/simplify.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @name                simply
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This function take a string with accents, etc and convert it to a more simply
+ * version like "éàddö" to "eaddo"
+ *
+ * @param       {String}        string        The string to simplyfy
+ * @param       {Object}        [settings={}]       An object of settings to simplify your string as you want:
+ * @return     {String}                        The simplified string
+ *
+ * @setting    {Boolean}       [specialChars=true]       Specify if you want to get rid of the special chars like é, è, etc...
+ * @setting    {Boolean}       [lowerCase=true]          Specify if you want your returned string to be lowercased
+ * @setting    {Boolean}       [dashSpace=true]          Specify if you want to replace the "_|-" by a space
+ * @setting    {Boolean}       [trim=true}               Specify if you want your string to be trimed or not
+ *
+ * @todo      tests
+ *
+ * @snippet         simplify($1)
+ *
+ * @example       js
+ * import { simplify } from '@blackbyte/sugar/string';
+ * simplify('éàddö'); // => eaddo
+ *
+ * @since     1.0.0
+ * @author    João Filipe Ventura Coelho <joaoventura93@outlook.com>
+ */
+export type TSimplifySettings = {
+    specialChars?: boolean;
+    lowerCase?: boolean;
+    dashSpace?: boolean;
+    trim?: boolean;
+};
+export default function simplify(string: string, settings?: TSimplifySettings): string;

package/dist/shared/string/simplify/simplify.js

@@ -0,0 +1,36 @@
+export default function simplify(string, settings = {}) {
+    settings = Object.assign({ specialChars: true, lowerCase: true, dashSpace: true, trim: true }, settings);
+    if (string == null)
+        return '';
+    const map = {
+        A: 'À|Á|Ã|Â|Ä',
+        a: 'á|à|ã|â|ä',
+        E: 'É|È|Ê|Ë',
+        e: 'é|è|ê|ë',
+        I: 'Í|Ì|Î|Ï',
+        i: 'í|ì|î|ï',
+        O: 'Ó|Ò|Ô|Õ|Ö',
+        o: 'ó|ò|ô|õ|ö',
+        U: 'Ú|Ù|Û|Ü|Ü',
+        u: 'ú|ù|û|ü|ü',
+        C: 'Ç',
+        c: 'ç',
+        N: 'Ñ',
+        n: 'ñ',
+    };
+    if (settings.dashSpace) {
+        map[' '] = '_|-';
+    }
+    if (settings.lowerCase) {
+        string = string.toLowerCase();
+    }
+    if (settings.specialChars) {
+        for (const pattern in map) {
+            string = string.replace(new RegExp(map[pattern], 'g'), pattern);
+        }
+    }
+    if (settings.trim)
+        string = string.trim();
+    return string;
+}
+//# sourceMappingURL=simplify.js.map

package/dist/shared/string/simplify/simplify.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"simplify.js","sourceRoot":"","sources":["../../../../src/shared/string/simplify/simplify.ts"],"names":[],"mappings":"AAsCA,MAAM,CAAC,OAAO,UAAU,QAAQ,CAC9B,MAAc,EACd,WAA8B,EAAE;IAEhC,QAAQ,mBACN,YAAY,EAAE,IAAI,EAClB,SAAS,EAAE,IAAI,EACf,SAAS,EAAE,IAAI,EACf,IAAI,EAAE,IAAI,IACP,QAAQ,CACZ,CAAC;IAEF,IAAI,MAAM,IAAI,IAAI;QAAE,OAAO,EAAE,CAAC;IAC9B,MAAM,GAAG,GAAG;QACV,CAAC,EAAE,WAAW;QACd,CAAC,EAAE,WAAW;QACd,CAAC,EAAE,SAAS;QACZ,CAAC,EAAE,SAAS;QACZ,CAAC,EAAE,SAAS;QACZ,CAAC,EAAE,SAAS;QACZ,CAAC,EAAE,WAAW;QACd,CAAC,EAAE,WAAW;QACd,CAAC,EAAE,WAAW;QACd,CAAC,EAAE,WAAW;QACd,CAAC,EAAE,GAAG;QACN,CAAC,EAAE,GAAG;QACN,CAAC,EAAE,GAAG;QACN,CAAC,EAAE,GAAG;KACP,CAAC;IAEF,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;QACvB,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACnB,CAAC;IAED,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;QACvB,MAAM,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;IAChC,CAAC;IAED,IAAI,QAAQ,CAAC,YAAY,EAAE,CAAC;QAC1B,KAAK,MAAM,OAAO,IAAI,GAAG,EAAE,CAAC;YAC1B,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;QAClE,CAAC;IACH,CAAC;IAED,IAAI,QAAQ,CAAC,IAAI;QAAE,MAAM,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;IAE1C,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/shared/string/simplifySpecialChars/simplifySpecialChars.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @name            simplifySpecialChars
+ * @namespace       shared.string
+ * @type            Function
+ * @platform        js
+ * @platform        node
+ * @status          stable
+ *
+ * This function take a string and replace all the special chars like "é", "à", etc...
+ * with their simple version like "a", "e", etc...
+ *
+ * @param       {String}        str         The string to process
+ * @return      {String}                        The processed string
+ *
+ * @snippet         simplifySpecialChars($1)
+ *
+ * @todo        tests
+ *
+ * @example         php
+ * import { simplifySpecialChars } from '@blackbyte/sugar/string';
+ * simplifySpecialChars('É'); // E
+ *
+ * @see             https://stackoverflow.com/questions/14114411/remove-all-special-characters-from-a-string/14114443
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function simplifySpecialChars(str: string): string;

package/dist/shared/string/simplifySpecialChars/simplifySpecialChars.js

@@ -0,0 +1,51 @@
+/**
+ * @name            simplifySpecialChars
+ * @namespace       shared.string
+ * @type            Function
+ * @platform        js
+ * @platform        node
+ * @status          stable
+ *
+ * This function take a string and replace all the special chars like "é", "à", etc...
+ * with their simple version like "a", "e", etc...
+ *
+ * @param       {String}        str         The string to process
+ * @return      {String}                        The processed string
+ *
+ * @snippet         simplifySpecialChars($1)
+ *
+ * @todo        tests
+ *
+ * @example         php
+ * import { simplifySpecialChars } from '@blackbyte/sugar/string';
+ * simplifySpecialChars('É'); // E
+ *
+ * @see             https://stackoverflow.com/questions/14114411/remove-all-special-characters-from-a-string/14114443
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function simplifySpecialChars(str) {
+    const utf8 = {
+        a: /[áàâãªä]/gm,
+        A: /[ÁÀÂÃÄ]/gm,
+        I: /[ÍÌÎÏ]/gm,
+        i: /[íìîï]/gm,
+        e: /[éèêë]/gm,
+        E: /[ÉÈÊË]/gm,
+        o: /[óòôõºö]/gm,
+        O: /[ÓÒÔÕÖ]/gm,
+        u: /[úùûü]/gm,
+        U: /[ÚÙÛÜ]/gm,
+        c: /ç/gm,
+        C: /Ç/gm,
+        n: /ñ/gm,
+        N: /Ñ/gm,
+        '-': /–/gm,
+        ' ': /[’‘‹›‚“”«»„[] ]/gm,
+    };
+    Object.keys(utf8).forEach((char) => {
+        str = str.replace(utf8[char], char);
+    });
+    return str;
+}
+//# sourceMappingURL=simplifySpecialChars.js.map

package/dist/shared/string/simplifySpecialChars/simplifySpecialChars.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"simplifySpecialChars.js","sourceRoot":"","sources":["../../../../src/shared/string/simplifySpecialChars/simplifySpecialChars.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,OAAO,UAAU,oBAAoB,CAAC,GAAW;IACtD,MAAM,IAAI,GAAG;QACX,CAAC,EAAE,YAAY;QACf,CAAC,EAAE,WAAW;QACd,CAAC,EAAE,UAAU;QACb,CAAC,EAAE,UAAU;QACb,CAAC,EAAE,UAAU;QACb,CAAC,EAAE,UAAU;QACb,CAAC,EAAE,YAAY;QACf,CAAC,EAAE,WAAW;QACd,CAAC,EAAE,UAAU;QACb,CAAC,EAAE,UAAU;QACb,CAAC,EAAE,KAAK;QACR,CAAC,EAAE,KAAK;QACR,CAAC,EAAE,KAAK;QACR,CAAC,EAAE,KAAK;QACR,GAAG,EAAE,KAAK;QACV,GAAG,EAAE,mBAAmB;KACzB,CAAC;IAEF,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACjC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/shared/string/snakeCase/snakeCase.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @name                snakeCase
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Snake case a string
+ *
+ * @param         {String}          text        The string to snakeCase
+ * @return        {String}                      The snakeCased string
+ *
+ * @todo      tests
+ *
+ * @snippet         snakeCase($1)
+ *
+ * @example     js
+ * import { snakeCase } from '@blackbyte/sugar/string';
+ * snakeCase('hello world'); // => hello_world
+ *
+ * @see             https://www.npmjs.com/package/change-case
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function __snakeCase(text: string): string;

package/dist/shared/string/snakeCase/snakeCase.js

@@ -0,0 +1,30 @@
+import { snakeCase } from 'change-case';
+/**
+ * @name                snakeCase
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Snake case a string
+ *
+ * @param         {String}          text        The string to snakeCase
+ * @return        {String}                      The snakeCased string
+ *
+ * @todo      tests
+ *
+ * @snippet         snakeCase($1)
+ *
+ * @example     js
+ * import { snakeCase } from '@blackbyte/sugar/string';
+ * snakeCase('hello world'); // => hello_world
+ *
+ * @see             https://www.npmjs.com/package/change-case
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function __snakeCase(text) {
+    return snakeCase(text);
+}
+//# sourceMappingURL=snakeCase.js.map

package/dist/shared/string/snakeCase/snakeCase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"snakeCase.js","sourceRoot":"","sources":["../../../../src/shared/string/snakeCase/snakeCase.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,UAAU,WAAW,CAAC,IAAY;IAC9C,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC;AACzB,CAAC"}

package/dist/shared/string/splitEvery/splitEvery.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @name                        splitEvery
+ * @namespace                   shared.string
+ * @type                        Function
+ * @platform                    js
+ * @platform                    node
+ * @status                      stable
+ *
+ * Split a string every n chars either by taking care of not spliting the words, or by simply spliting without any attention to that...
+ *
+ * @param               {String}                  text                      The text to split
+ * @param               {Number}                  every                     How many characters to split the text
+ * @param               {Partial<TSplitEverySettings}       [settings={}]       Some settings to configure your split process
+ * @return              {Array}                                             An array of the splited text parts
+ *
+ * @setting         {Boolean}           [splitWords=true]        If you want to split the words or not...
+ *
+ * @todo      tests
+ *
+ * @snippet         splitEvery($1, $2)
+ *
+ * @example           js
+ * import { splitEvery } from '@blackbyte/sugar/string';
+ * splitEvery('Hello World', 2, {
+ *    splitWords: true
+ * }); // => ['He','ll','o ','Wo','rl','d']
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TSplitEverySettings = {
+    splitWords: boolean;
+};
+export default function splitEvery(text: string, every: number, settings?: Partial<TSplitEverySettings>): string[];

package/dist/shared/string/splitEvery/splitEvery.js

@@ -0,0 +1,57 @@
+import countLineChars from '../countLineChars/countLineChars.js';
+export default function splitEvery(text, every, settings = {}) {
+    const finalSettings = Object.assign({ splitWords: true }, settings);
+    if (finalSettings.splitWords) {
+        const reg = new RegExp(`.{1,${every}}`, 'g');
+        return [...text.matchAll(reg)].map((o) => o[0]);
+    }
+    else {
+        const reg = new RegExp(`(\\x1B\[[0-9;]+m)|(\\x1B\[39m])|(<[a-zA-Z\s/]+>)`, 
+        // `(?:(?:\x1B\[[\d;]*m)*[^\x1B]){1,${every}}(?:(?:\x1B\[[\d;]*m)+$)?`,
+        'g');
+        // const reg = new RegExp(`(?:(?:\033\[[0-9;]*m)*.?){1,${every}}`, 'g');
+        const chunks = text
+            .split(reg)
+            .filter((m) => m != '' && m != null && m != undefined)
+            .map((item) => {
+            return item.split(/(\s{1,99999999})/g);
+        });
+        let finalChunks = [];
+        chunks.forEach((chunk) => {
+            finalChunks = [...finalChunks, ...chunk];
+        });
+        let finalLines = [''];
+        let lineCount = 0;
+        let lastOpenedTag = '';
+        finalChunks.forEach((item) => {
+            if (!item)
+                return;
+            if (reg.test(item)) {
+                if (item.substr(0, 2) !== '</' || item.substr(0, 4) !== '\x1B') {
+                    lastOpenedTag = item;
+                    if (item.substr(0, 1) !== '<') {
+                        lastOpenedTag = `\x1B${lastOpenedTag}`;
+                    }
+                }
+                finalLines[finalLines.length - 1] += item;
+                return;
+            }
+            if (lineCount + item.length > every) {
+                const toAdd = item.substr(0, every - lineCount - 1);
+                finalLines[finalLines.length - 1] += toAdd;
+                const rest = lastOpenedTag + item.replace(toAdd, '');
+                // if (toAdd.slice(-1) !== ' ' && rest.slice(0, 1) !== ' ')
+                //   finalLines[finalLines.length - 1] += '-';
+                const restLines = splitEvery(rest, every);
+                finalLines = [...finalLines, ...restLines];
+                lineCount = countLineChars(finalLines[finalLines.length - 1]);
+            }
+            else {
+                lineCount += item.length;
+                finalLines[finalLines.length - 1] += item;
+            }
+        });
+        return finalLines;
+    }
+}
+//# sourceMappingURL=splitEvery.js.map

package/dist/shared/string/splitEvery/splitEvery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"splitEvery.js","sourceRoot":"","sources":["../../../../src/shared/string/splitEvery/splitEvery.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,qCAAqC,CAAC;AAuCjE,MAAM,CAAC,OAAO,UAAU,UAAU,CAChC,IAAY,EACZ,KAAa,EACb,WAAyC,EAAE;IAE3C,MAAM,aAAa,mBACjB,UAAU,EAAE,IAAI,IACb,QAAQ,CACZ,CAAC;IAEF,IAAI,aAAa,CAAC,UAAU,EAAE,CAAC;QAC7B,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,OAAO,KAAK,GAAG,EAAE,GAAG,CAAC,CAAC;QAC7C,OAAO,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAClD,CAAC;SAAM,CAAC;QACN,MAAM,GAAG,GAAG,IAAI,MAAM,CACpB,kDAAkD;QAClD,uEAAuE;QACvE,GAAG,CACJ,CAAC;QACF,wEAAwE;QACxE,MAAM,MAAM,GAAG,IAAI;aAChB,KAAK,CAAC,GAAG,CAAC;aACV,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,SAAS,CAAC;aACrD,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACZ,OAAO,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;QACL,IAAI,WAAW,GAAa,EAAE,CAAC;QAC/B,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YACvB,WAAW,GAAG,CAAC,GAAG,WAAW,EAAE,GAAG,KAAK,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC,CAAC;QACtB,IAAI,SAAS,GAAG,CAAC,CAAC;QAClB,IAAI,aAAa,GAAG,EAAE,CAAC;QAEvB,WAAW,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAC3B,IAAI,CAAC,IAAI;gBAAE,OAAO;YAElB,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBACnB,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC;oBAC/D,aAAa,GAAG,IAAI,CAAC;oBACrB,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;wBAC9B,aAAa,GAAG,OAAO,aAAa,EAAE,CAAC;oBACzC,CAAC;gBACH,CAAC;gBAED,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC;gBAC1C,OAAO;YACT,CAAC;YACD,IAAI,SAAS,GAAG,IAAI,CAAC,MAAM,GAAG,KAAK,EAAE,CAAC;gBACpC,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,GAAG,SAAS,GAAG,CAAC,CAAC,CAAC;gBACpD,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,KAAK,CAAC;gBAC3C,MAAM,IAAI,GAAG,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBACrD,2DAA2D;gBAC3D,8CAA8C;gBAC9C,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBAC1C,UAAU,GAAG,CAAC,GAAG,UAAU,EAAE,GAAG,SAAS,CAAC,CAAC;gBAC3C,SAAS,GAAG,cAAc,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;YAChE,CAAC;iBAAM,CAAC;gBACN,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC;gBACzB,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC;YAC5C,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,UAAU,CAAC;IACpB,CAAC;AACH,CAAC"}

package/dist/shared/string/sprintf/sprintf.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @name                sprintf
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Javascript implementation of the sprintf php function.
+ * >For more infos, check [this github repository](https://github.com/alexei/sprintf.js)
+ *
+ * @param    {String}    format    The format of the string wanted as output
+ * @param    {Mixed}    ...replacements    The replacement tokens to apply to the string
+ * @return    {String}    The processed string
+ *
+ * @todo      tests
+ *
+ * @snippet         sprintf($1)
+ *
+ * @example    js
+ * import { sprintf } from '@blackbyte/sugar/string'
+ * sprintf('Hello %s', 'world') // Hello World
+ * const user = { name: 'Dolly' }
+ * sprintf('Hello %(name)s', user) // Hello Dolly
+ *
+ * @see    https://github.com/alexei/sprintf.js
+ * @since     1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function sprintf(): string;

package/dist/shared/string/sprintf/sprintf.js

@@ -0,0 +1,35 @@
+import { sprintf as _sprintf } from 'sprintf-js';
+/**
+ * @name                sprintf
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Javascript implementation of the sprintf php function.
+ * >For more infos, check [this github repository](https://github.com/alexei/sprintf.js)
+ *
+ * @param    {String}    format    The format of the string wanted as output
+ * @param    {Mixed}    ...replacements    The replacement tokens to apply to the string
+ * @return    {String}    The processed string
+ *
+ * @todo      tests
+ *
+ * @snippet         sprintf($1)
+ *
+ * @example    js
+ * import { sprintf } from '@blackbyte/sugar/string'
+ * sprintf('Hello %s', 'world') // Hello World
+ * const user = { name: 'Dolly' }
+ * sprintf('Hello %(name)s', user) // Hello Dolly
+ *
+ * @see    https://github.com/alexei/sprintf.js
+ * @since     1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function sprintf() {
+    // @ts-ignore
+    return _sprintf.apply(this, arguments);
+}
+//# sourceMappingURL=sprintf.js.map

package/dist/shared/string/sprintf/sprintf.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sprintf.js","sourceRoot":"","sources":["../../../../src/shared/string/sprintf/sprintf.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,OAAO,UAAU,OAAO;IAC7B,aAAa;IACb,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;AACzC,CAAC"}

package/dist/shared/string/stripAnsi/stripAnsi.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @name                stripAnsi
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This function simply strip all the ansi characters in a string
+ *
+ * @param       {String}        string          The string to strip ansi from
+ * @return      {String}                        The new string without any ansi characters
+ *
+ * @snippet         __stripAnsi($1)
+ *
+ * @todo    tests
+ *
+ * @example     js
+ * import { stripAnsi } from '@blackbyte/sugar/string';
+ * stripAnsi('\u001B]8;;https://github.com\u0007Click\u001B]8;;\u0007'); // => Click
+ *
+ * @see         https://www.npmjs.com/package/strip-ansi
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function stripAnsi(string: string): string;

package/dist/shared/string/stripAnsi/stripAnsi.js

@@ -0,0 +1,30 @@
+import __stripAnsi from 'strip-ansi';
+/**
+ * @name                stripAnsi
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This function simply strip all the ansi characters in a string
+ *
+ * @param       {String}        string          The string to strip ansi from
+ * @return      {String}                        The new string without any ansi characters
+ *
+ * @snippet         __stripAnsi($1)
+ *
+ * @todo    tests
+ *
+ * @example     js
+ * import { stripAnsi } from '@blackbyte/sugar/string';
+ * stripAnsi('\u001B]8;;https://github.com\u0007Click\u001B]8;;\u0007'); // => Click
+ *
+ * @see         https://www.npmjs.com/package/strip-ansi
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function stripAnsi(string) {
+    return __stripAnsi(string);
+}
+//# sourceMappingURL=stripAnsi.js.map

package/dist/shared/string/stripAnsi/stripAnsi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stripAnsi.js","sourceRoot":"","sources":["../../../../src/shared/string/stripAnsi/stripAnsi.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,YAAY,CAAC;AAErC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,MAAc;IAC9C,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC;AAC7B,CAAC"}