@goast/core 0.0.1

package/dist/lib/utils/string.utils.cjs

@@ -0,0 +1,337 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StringBuilder = exports.defaultStringBuilderOptions = exports.escapeRegExp = exports.toCustomCase = exports.toSnakeCase = exports.toKebabCase = exports.toPascalCase = exports.toCamelCase = exports.toCasing = exports.wordToCasing = exports.getWords = void 0;
+const os_1 = require("os");
+const common_utils_1 = require("./common.utils");
+/**
+ * Gets the words from a string. Words are separated by capital letters. Leading numbers are removed. Non-alphanumerical characters are removed and interpreted as word seperators. Multiple uppercase letters are interpreted as one word.
+ * @param str The string to get the words from.
+ * @returns The words.
+ * @example
+ * getWords('fooBar') // => ['foo', 'Bar']
+ * getWords('fooBarBaz') // => ['foo', 'Bar', 'Baz']
+ * getWords('fooBarBaz123') // => ['foo', 'Bar', 'Baz', '123']
+ * getWords('123Foo###Bar###') // => ['Foo', 'Bar']
+ * getWords('fooBARBaz') // => ['foo', 'BAR', 'Baz']
+ */
+function getWords(str) {
+    var _a;
+    if ((0, common_utils_1.isNullish)(str))
+        return [];
+    // Remove non-alphanumerical characters
+    str = str.replace(/[^a-zA-Z0-9]+/g, '-');
+    str = str.replace(/^[0-9-]+/, '');
+    // Split into words
+    return (_a = str.match(/[A-Z]{2,}(?=[A-Z0-9-]|$)|[a-zA-Z][a-z]*|[0-9]+/g)) !== null && _a !== void 0 ? _a : [];
+}
+exports.getWords = getWords;
+/**
+ * Converts a word to a given casing.
+ * @param str The word to convert.
+ * @param casing The casing to convert to.
+ * @returns The converted word.
+ * @example
+ * toCasing('fooBar', 'unchanged') // => 'fooBar'
+ * toCasing('fooBar', 'all-lower') // => 'foobar'
+ * toCasing('fooBar', 'all-upper') // => 'FOOBAR'
+ * toCasing('fooBar', 'first-upper') // => 'FooBar'
+ * toCasing('FooBar', 'first-lower') // => 'fooBar'
+ * toCasing('fooBar', 'first-upper-then-lower') // => 'Foobar'
+ * toCasing('FooBar', 'first-lower-then-upper') // => 'fOOBAR'
+ * toCasing('fooBar', 'first-upper-alternating') // => 'FoObAr'
+ * toCasing('FooBar', 'first-lower-alternating') // => 'fOoBaR'
+ */
+function wordToCasing(str, casing) {
+    str !== null && str !== void 0 ? str : (str = '');
+    switch (casing) {
+        case 'unchanged':
+            return str;
+        case 'all-lower':
+            return str.toLowerCase();
+        case 'all-upper':
+            return str.toUpperCase();
+        case 'first-upper':
+            return str[0].toUpperCase() + str.slice(1);
+        case 'first-lower':
+            return str[0].toLowerCase() + str.slice(1);
+        case 'first-upper-then-lower':
+            return str[0].toUpperCase() + str.slice(1).toLowerCase();
+        case 'first-lower-then-upper':
+            return str[0].toLowerCase() + str.slice(1).toUpperCase();
+        case 'first-upper-alternating':
+            return str
+                .split('')
+                .map((c, i) => (i % 2 === 0 ? c.toUpperCase() : c.toLowerCase()))
+                .join('');
+        case 'first-lower-alternating':
+            return str
+                .split('')
+                .map((c, i) => (i % 2 === 0 ? c.toLowerCase() : c.toUpperCase()))
+                .join('');
+    }
+}
+exports.wordToCasing = wordToCasing;
+function toCasing(str, casing) {
+    let options;
+    let casingType;
+    if (typeof casing === 'string') {
+        casingType = casing;
+    }
+    else {
+        options = casing;
+        casingType = casing.casing;
+    }
+    switch (casingType) {
+        case 'camel':
+            return toCamelCase(str, options);
+        case 'pascal':
+            return toPascalCase(str, options);
+        case 'kebab':
+            return toKebabCase(str, options);
+        case 'snake':
+            return toSnakeCase(str, options);
+        case 'custom':
+            return toCustomCase(str, options);
+        default:
+            return wordToCasing(getWords(str).join(''), casingType);
+    }
+}
+exports.toCasing = toCasing;
+function addPrefixAndSuffix(str, { prefix, suffix }) {
+    if (prefix) {
+        str = prefix + str;
+    }
+    if (suffix) {
+        str = str + suffix;
+    }
+    return str;
+}
+/**
+ * Converts a string to camel case.
+ * @param str The string to convert.
+ * @param options The options.
+ * @returns The converted string.
+ * @example
+ * toCamelCase('Foo bAR') // => 'fooBar'
+ * toCamelCase('Foo bAR', { keepOriginalCase: true }) // => 'fooBAR'
+ * toCamelCase('Foo bAR', { keepOriginalCase: false }) // => 'fooBar'
+ * toCamelCase('Foo bAR', { prefix: 'bar' }) // => 'barfooBar'
+ * toCamelCase('Foo bAR', { suffix: 'bar' }) // => 'fooBarbar'
+ */
+function toCamelCase(str, options) {
+    const opts = Object.assign({ keepOriginalCase: false }, options);
+    const words = getWords(str);
+    const camelCase = words
+        .map((word, index) => index === 0
+        ? wordToCasing(word, opts.keepOriginalCase ? 'first-lower' : 'all-lower')
+        : wordToCasing(word, opts.keepOriginalCase ? 'first-upper' : 'first-upper-then-lower'))
+        .join('');
+    return addPrefixAndSuffix(camelCase, opts);
+}
+exports.toCamelCase = toCamelCase;
+/**
+ * Converts a string to pascal case.
+ * @param str The string to convert.
+ * @param options The options.
+ * @returns The converted string.
+ * @example
+ * toPascalCase('foo bAR') // => 'FooBar'
+ * toPascalCase('foo bAR', { keepOriginalCase: true }) // => 'FooBAR'
+ * toPascalCase('foo bAR', { keepOriginalCase: false }) // => 'FooBar'
+ * toPascalCase('foo bAR', { prefix: 'bar' }) // => 'barFooBar'
+ * toPascalCase('foo bAR', { suffix: 'bar' }) // => 'FooBarbar'
+ */
+function toPascalCase(str, options) {
+    const opts = Object.assign({ keepOriginalCase: false }, options);
+    const words = getWords(str);
+    const pascalCase = words
+        .map((word) => wordToCasing(word, opts.keepOriginalCase ? 'first-upper' : 'first-upper-then-lower'))
+        .join('');
+    return addPrefixAndSuffix(pascalCase, opts);
+}
+exports.toPascalCase = toPascalCase;
+/**
+ * Converts a string to kebab case.
+ * @param str The string to convert.
+ * @param options The options.
+ * @returns The converted string.
+ * @example
+ * toKebabCase('Foo bAR') // => 'foo-bar'
+ * toKebabCase('Foo bAR', { wordCasing: 'all-upper' }) // => 'FOO-BAR'
+ * toKebabCase('Foo bAR', { firstWordCasing: 'all-upper' }) // => 'FOO-bar'
+ * toKebabCase('Foo bAR', { casing: 'all-upper', firstWordCasing: 'all-lower' }) // => 'foo-BAR'
+ * toKebabCase('Foo bAR', { prefix: 'bar' }) // => 'barfoo-bar'
+ * toKebabCase('Foo bAR', { suffix: 'bar' }) // => 'foo-barbar'
+ */
+function toKebabCase(str, options) {
+    const opts = Object.assign({ wordCasing: 'all-lower' }, options);
+    const words = getWords(str);
+    const kebabCase = words
+        .map((word, index) => { var _a; return index === 0 ? wordToCasing(word, (_a = opts.firstWordCasing) !== null && _a !== void 0 ? _a : opts.wordCasing) : wordToCasing(word, opts.wordCasing); })
+        .join('-');
+    return addPrefixAndSuffix(kebabCase, opts);
+}
+exports.toKebabCase = toKebabCase;
+/**
+ * Converts a string to snake case.
+ * @param str The string to convert.
+ * @param options The options.
+ * @returns The converted string.
+ * @example
+ * toSnakeCase('Foo bAR') // => 'FOO_BAR'
+ * toSnakeCase('Foo bAR', { wordCasing: 'all-lower' }) // => 'foo_bar'
+ * toSnakeCase('Foo bAR', { firstWordCasing: 'all-lower' }) // => 'foo_BAR'
+ * toSnakeCase('Foo bAR', { casing: 'all-lower', firstWordCasing: 'all-upper' }) // => 'FOO_bar'
+ * toSnakeCase('Foo bAR', { prefix: 'bar' }) // => 'barFOO_BAR'
+ * toSnakeCase('Foo bAR', { suffix: 'bar' }) // => 'FOO_BARbar'
+ */
+function toSnakeCase(str, options) {
+    const opts = Object.assign({ wordCasing: 'all-upper' }, options);
+    const words = getWords(str);
+    const snakeCase = words
+        .map((word, index) => { var _a; return index === 0 ? wordToCasing(word, (_a = opts.firstWordCasing) !== null && _a !== void 0 ? _a : opts.wordCasing) : wordToCasing(word, opts.wordCasing); })
+        .join('_');
+    return addPrefixAndSuffix(snakeCase, opts);
+}
+exports.toSnakeCase = toSnakeCase;
+/**
+ * Converts a string to a custom case.
+ * @param str The string to convert.
+ * @param options The options.
+ * @returns The converted string.
+ * @example
+ * toCustomCase('Foo bAR', { wordCasing: 'first-upper-then-lower' }) // => 'FooBar'
+ * toCustomCase('Foo bAR', { wordCasing: 'first-upper-then-lower', wordSeparator: '~' }) // => 'Foo~Bar'
+ * toCustomCase('Foo bAR', { wordCasing: 'first-upper-then-lower', wordSeparator: '~', prefix: 'bar' }) // => 'barFoo~Bar'
+ * toCustomCase('Foo bAR', { wordCasing: 'first-upper-then-lower', wordSeparator: '~', suffix: 'bar' }) // => 'Foo~Barbar'
+ * toCustomCase('Foo bAR', { wordCasing: 'all-upper', firstWordCasing: 'all-lower' }) // => 'fooBAR'
+ * toCustomCase('Foo bAR baz', { wordCasing: (wordIndex) => (wordIndex % 2 === 0 ? 'all-upper' : 'all-lower') }) // => 'FOObarBAZ'
+ */
+function toCustomCase(str, options) {
+    var _a;
+    const words = getWords(str);
+    const wordMapFn = typeof options.wordCasing === 'function'
+        ? (word, index) => wordToCasing(word, options.wordCasing(index))
+        : (word, index) => {
+            var _a;
+            return index === 0
+                ? wordToCasing(word, (_a = options.firstWordCasing) !== null && _a !== void 0 ? _a : options.wordCasing)
+                : wordToCasing(word, options.wordCasing);
+        };
+    const customCase = words.map(wordMapFn).join((_a = options.wordSeparator) !== null && _a !== void 0 ? _a : '');
+    return addPrefixAndSuffix(customCase, options);
+}
+exports.toCustomCase = toCustomCase;
+/**
+ * Escapes a string to be used in a regular expression.
+ * @param str The string to escape.
+ */
+function escapeRegExp(str) {
+    return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}
+exports.escapeRegExp = escapeRegExp;
+exports.defaultStringBuilderOptions = {
+    newLine: os_1.EOL,
+};
+/**
+ * Represents a mutable string of characters.
+ */
+class StringBuilder {
+    get options() {
+        return this._options;
+    }
+    /**
+     * Initializes a new instance of the StringBuilder class.
+     * @param options The options.
+     */
+    constructor(options) {
+        this._str = '';
+        this._options = Object.assign(Object.assign({}, exports.defaultStringBuilderOptions), options);
+    }
+    /**
+     * Creates a new StringBuilder instance and appends the specified string to it.
+     * @param str The string to append.
+     * @param options The options.
+     * @returns A new StringBuilder instance.
+     */
+    static fromString(str, options) {
+        const builder = new StringBuilder(options);
+        builder.append(str);
+        return builder;
+    }
+    /**
+     * Builds a string using a StringBuilder build action.
+     * @param buildAction The build action to perform on the StringBuilder instance.
+     * @param options The options for the StringBuilder instance.
+     * @returns The built string.
+     */
+    static build(buildAction, options) {
+        const builder = new StringBuilder(options);
+        buildAction(builder);
+        return builder.toString();
+    }
+    /**
+     * Appends one or more strings to the end of the current StringBuilder.
+     * @param value The string(s) to append.
+     * @returns The current StringBuilder.
+     */
+    append(...value) {
+        for (const part of value) {
+            if ((0, common_utils_1.isNullish)(part) || part.length === 0)
+                continue;
+            this._str += part;
+        }
+        return this;
+    }
+    /**
+     * Appends one or more strings to the end of the current StringBuilder, followed by a line terminator.
+     * @param value
+     * @returns
+     */
+    appendLine(...value) {
+        return this.append(...value, this._options.newLine);
+    }
+    /**
+     * Prepends one or more strings to the beginning of the current StringBuilder.
+     * @param value The string(s) to prepend.
+     * @returns The current StringBuilder.
+     */
+    prepend(...value) {
+        for (const part of value.reverse()) {
+            if ((0, common_utils_1.isNullish)(part))
+                continue;
+            if (typeof part === 'function') {
+                const builder = new StringBuilder(this.options);
+                part(builder);
+                this._str = builder.toString() + this._str;
+            }
+            else if (part.length > 0) {
+                this._str = part + this._str;
+            }
+        }
+        return this;
+    }
+    /**
+     * Prepends one or more strings to the beginning of the current StringBuilder, followed by a line terminator.
+     * @param value The string(s) to prepend.
+     * @returns The current StringBuilder.
+     */
+    prependLine(...value) {
+        return this.prepend(...value, this._options.newLine);
+    }
+    /**
+     * Converts the value of this instance to a string.
+     * @returns A string whose value is the same as this instance.
+     */
+    toString() {
+        return this._str;
+    }
+    /**
+     * Removes all characters from the current StringBuilder.
+     */
+    clear() {
+        this._str = '';
+    }
+}
+exports.StringBuilder = StringBuilder;
+//# sourceMappingURL=string.utils.js.map

package/dist/lib/utils/string.utils.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"string.utils.cjs","sourceRoot":"","sources":["../../../../../../packages/core/src/lib/utils/string.utils.ts"],"names":[],"mappings":";;;AAAA,2BAAyB;AAEzB,iDAA2C;AAe3C;;;;;;;;;;GAUG;AACH,SAAgB,QAAQ,CAAC,GAAqB;;IAC5C,IAAI,IAAA,wBAAS,EAAC,GAAG,CAAC;QAAE,OAAO,EAAE,CAAC;IAE9B,uCAAuC;IACvC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;IACzC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IAElC,mBAAmB;IACnB,OAAO,MAAA,GAAG,CAAC,KAAK,CAAC,iDAAiD,CAAC,mCAAI,EAAE,CAAC;AAC5E,CAAC;AATD,4BASC;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,YAAY,CAAC,GAAqB,EAAE,MAAkB;IACpE,GAAG,aAAH,GAAG,cAAH,GAAG,IAAH,GAAG,GAAK,EAAE,EAAC;IACX,QAAQ,MAAM,EAAE;QACd,KAAK,WAAW;YACd,OAAO,GAAG,CAAC;QACb,KAAK,WAAW;YACd,OAAO,GAAG,CAAC,WAAW,EAAE,CAAC;QAC3B,KAAK,WAAW;YACd,OAAO,GAAG,CAAC,WAAW,EAAE,CAAC;QAC3B,KAAK,aAAa;YAChB,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC7C,KAAK,aAAa;YAChB,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC7C,KAAK,wBAAwB;YAC3B,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;QAC3D,KAAK,wBAAwB;YAC3B,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;QAC3D,KAAK,yBAAyB;YAC5B,OAAO,GAAG;iBACP,KAAK,CAAC,EAAE,CAAC;iBACT,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;iBAChE,IAAI,CAAC,EAAE,CAAC,CAAC;QACd,KAAK,yBAAyB;YAC5B,OAAO,GAAG;iBACP,KAAK,CAAC,EAAE,CAAC;iBACT,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;iBAChE,IAAI,CAAC,EAAE,CAAC,CAAC;KACf;AACH,CAAC;AA5BD,oCA4BC;AAED,SAAgB,QAAQ,CAAyB,GAAqB,EAAE,MAAsC;IAC5G,IAAI,OAAmC,CAAC;IACxC,IAAI,UAAwB,CAAC;IAC7B,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;QAC9B,UAAU,GAAG,MAAM,CAAC;KACrB;SAAM;QACL,OAAO,GAAG,MAAM,CAAC;QACjB,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC;KAC5B;IAED,QAAQ,UAAU,EAAE;QAClB,KAAK,OAAO;YACV,OAAO,WAAW,CAAC,GAAG,EAAE,OAA+B,CAAC,CAAC;QAC3D,KAAK,QAAQ;YACX,OAAO,YAAY,CAAC,GAAG,EAAE,OAAgC,CAAC,CAAC;QAC7D,KAAK,OAAO;YACV,OAAO,WAAW,CAAC,GAAG,EAAE,OAA+B,CAAC,CAAC;QAC3D,KAAK,OAAO;YACV,OAAO,WAAW,CAAC,GAAG,EAAE,OAA+B,CAAC,CAAC;QAC3D,KAAK,QAAQ;YACX,OAAO,YAAY,CAAC,GAAG,EAAE,OAAgC,CAAC,CAAC;QAC7D;YACE,OAAO,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC;KAC3D;AACH,CAAC;AAxBD,4BAwBC;AAED,SAAS,kBAAkB,CAAC,GAAW,EAAE,EAAE,MAAM,EAAE,MAAM,EAAmB;IAC1E,IAAI,MAAM,EAAE;QACV,GAAG,GAAG,MAAM,GAAG,GAAG,CAAC;KACpB;IACD,IAAI,MAAM,EAAE;QACV,GAAG,GAAG,GAAG,GAAG,MAAM,CAAC;KACpB;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,WAAW,CAAC,GAAqB,EAAE,OAAmC;IACpF,MAAM,IAAI,mBAAuB,gBAAgB,EAAE,KAAK,IAAK,OAAO,CAAE,CAAC;IACvE,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC5B,MAAM,SAAS,GAAG,KAAK;SACpB,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CACnB,KAAK,KAAK,CAAC;QACT,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,WAAW,CAAC;QACzE,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,wBAAwB,CAAC,CACzF;SACA,IAAI,CAAC,EAAE,CAAC,CAAC;IACZ,OAAO,kBAAkB,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;AAC7C,CAAC;AAXD,kCAWC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,YAAY,CAAC,GAAqB,EAAE,OAAoC;IACtF,MAAM,IAAI,mBAAwB,gBAAgB,EAAE,KAAK,IAAK,OAAO,CAAE,CAAC;IACxE,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC5B,MAAM,UAAU,GAAG,KAAK;SACrB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,wBAAwB,CAAC,CAAC;SACnG,IAAI,CAAC,EAAE,CAAC,CAAC;IACZ,OAAO,kBAAkB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;AAC9C,CAAC;AAPD,oCAOC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,WAAW,CAAC,GAAqB,EAAE,OAAmC;IACpF,MAAM,IAAI,mBAAuB,UAAU,EAAE,WAAW,IAAK,OAAO,CAAE,CAAC;IACvE,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC5B,MAAM,SAAS,GAAG,KAAK;SACpB,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,WACnB,OAAA,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,MAAA,IAAI,CAAC,eAAe,mCAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA,EAAA,CAChH;SACA,IAAI,CAAC,GAAG,CAAC,CAAC;IACb,OAAO,kBAAkB,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;AAC7C,CAAC;AATD,kCASC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,WAAW,CAAC,GAAqB,EAAE,OAAmC;IACpF,MAAM,IAAI,mBAAuB,UAAU,EAAE,WAAW,IAAK,OAAO,CAAE,CAAC;IACvE,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC5B,MAAM,SAAS,GAAG,KAAK;SACpB,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,WACnB,OAAA,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,MAAA,IAAI,CAAC,eAAe,mCAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA,EAAA,CAChH;SACA,IAAI,CAAC,GAAG,CAAC,CAAC;IACb,OAAO,kBAAkB,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;AAC7C,CAAC;AATD,kCASC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,YAAY,CAAC,GAAqB,EAAE,OAA0B;;IAC5E,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC5B,MAAM,SAAS,GACb,OAAO,OAAO,CAAC,UAAU,KAAK,UAAU;QACtC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;;YACd,OAAA,KAAK,KAAK,CAAC;gBACT,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,MAAA,OAAO,CAAC,eAAe,mCAAI,OAAO,CAAC,UAAU,CAAC;gBACnE,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,CAAA;SAAA,CAAC;IACnD,MAAM,UAAU,GAAG,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,MAAA,OAAO,CAAC,aAAa,mCAAI,EAAE,CAAC,CAAC;IAC1E,OAAO,kBAAkB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;AACjD,CAAC;AAXD,oCAWC;AAED;;;GAGG;AACH,SAAgB,YAAY,CAAC,GAAW;IACtC,OAAO,GAAG,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;AACpD,CAAC;AAFD,oCAEC;AAUY,QAAA,2BAA2B,GAAyB;IAC/D,OAAO,EAAE,QAAG;CACb,CAAC;AAEF;;GAEG;AACH,MAAa,aAAa;IAIxB,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;OAGG;IACH,YAAY,OAAuC;QAV3C,SAAI,GAAW,EAAE,CAAC;QAWxB,IAAI,CAAC,QAAQ,mCAAQ,mCAA2B,GAAK,OAAO,CAAE,CAAC;IACjE,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,UAAU,CAAC,GAAW,EAAE,OAAuC;QAC3E,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACpB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,WAA6C,EAAE,OAAuC;QACxG,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;QAC3C,WAAW,CAAC,OAAO,CAAC,CAAC;QACrB,OAAO,OAAO,CAAC,QAAQ,EAAE,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,GAAG,KAAyB;QACxC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,IAAI,IAAA,wBAAS,EAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;gBAAE,SAAS;YACnD,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC;SACnB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,GAAG,KAAyB;QAC5C,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAC,GAAG,KAA8D;QAC9E,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE;YAClC,IAAI,IAAA,wBAAS,EAAC,IAAI,CAAC;gBAAE,SAAS;YAC9B,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE;gBAC9B,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAChD,IAAI,CAAC,OAAO,CAAC,CAAC;gBACd,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,QAAQ,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC;aAC5C;iBAAM,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;aAC9B;SACF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,GAAG,KAA8D;QAClF,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;OAEG;IACI,KAAK;QACV,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;IACjB,CAAC;CACF;AAxGD,sCAwGC"}

package/dist/lib/utils/string.utils.d.ts

@@ -0,0 +1,173 @@
+import { WordCasing, StringCasing, CamelCaseOptions, PascalCaseOptions, KebabCaseOptions, SnakeCaseOptions, CustomCaseOptions, StringCasingWithOptions } from './string.utils.types';
+import { Nullable } from './type.utils';
+/**
+ * Gets the words from a string. Words are separated by capital letters. Leading numbers are removed. Non-alphanumerical characters are removed and interpreted as word seperators. Multiple uppercase letters are interpreted as one word.
+ * @param str The string to get the words from.
+ * @returns The words.
+ * @example
+ * getWords('fooBar') // => ['foo', 'Bar']
+ * getWords('fooBarBaz') // => ['foo', 'Bar', 'Baz']
+ * getWords('fooBarBaz123') // => ['foo', 'Bar', 'Baz', '123']
+ * getWords('123Foo###Bar###') // => ['Foo', 'Bar']
+ * getWords('fooBARBaz') // => ['foo', 'BAR', 'Baz']
+ */
+export declare function getWords(str: Nullable<string>): string[];
+/**
+ * Converts a word to a given casing.
+ * @param str The word to convert.
+ * @param casing The casing to convert to.
+ * @returns The converted word.
+ * @example
+ * toCasing('fooBar', 'unchanged') // => 'fooBar'
+ * toCasing('fooBar', 'all-lower') // => 'foobar'
+ * toCasing('fooBar', 'all-upper') // => 'FOOBAR'
+ * toCasing('fooBar', 'first-upper') // => 'FooBar'
+ * toCasing('FooBar', 'first-lower') // => 'fooBar'
+ * toCasing('fooBar', 'first-upper-then-lower') // => 'Foobar'
+ * toCasing('FooBar', 'first-lower-then-upper') // => 'fOOBAR'
+ * toCasing('fooBar', 'first-upper-alternating') // => 'FoObAr'
+ * toCasing('FooBar', 'first-lower-alternating') // => 'fOoBaR'
+ */
+export declare function wordToCasing(str: Nullable<string>, casing: WordCasing): string;
+export declare function toCasing<T extends StringCasing>(str: Nullable<string>, casing: T | StringCasingWithOptions<T>): string;
+/**
+ * Converts a string to camel case.
+ * @param str The string to convert.
+ * @param options The options.
+ * @returns The converted string.
+ * @example
+ * toCamelCase('Foo bAR') // => 'fooBar'
+ * toCamelCase('Foo bAR', { keepOriginalCase: true }) // => 'fooBAR'
+ * toCamelCase('Foo bAR', { keepOriginalCase: false }) // => 'fooBar'
+ * toCamelCase('Foo bAR', { prefix: 'bar' }) // => 'barfooBar'
+ * toCamelCase('Foo bAR', { suffix: 'bar' }) // => 'fooBarbar'
+ */
+export declare function toCamelCase(str: Nullable<string>, options?: Partial<CamelCaseOptions>): string;
+/**
+ * Converts a string to pascal case.
+ * @param str The string to convert.
+ * @param options The options.
+ * @returns The converted string.
+ * @example
+ * toPascalCase('foo bAR') // => 'FooBar'
+ * toPascalCase('foo bAR', { keepOriginalCase: true }) // => 'FooBAR'
+ * toPascalCase('foo bAR', { keepOriginalCase: false }) // => 'FooBar'
+ * toPascalCase('foo bAR', { prefix: 'bar' }) // => 'barFooBar'
+ * toPascalCase('foo bAR', { suffix: 'bar' }) // => 'FooBarbar'
+ */
+export declare function toPascalCase(str: Nullable<string>, options?: Partial<PascalCaseOptions>): string;
+/**
+ * Converts a string to kebab case.
+ * @param str The string to convert.
+ * @param options The options.
+ * @returns The converted string.
+ * @example
+ * toKebabCase('Foo bAR') // => 'foo-bar'
+ * toKebabCase('Foo bAR', { wordCasing: 'all-upper' }) // => 'FOO-BAR'
+ * toKebabCase('Foo bAR', { firstWordCasing: 'all-upper' }) // => 'FOO-bar'
+ * toKebabCase('Foo bAR', { casing: 'all-upper', firstWordCasing: 'all-lower' }) // => 'foo-BAR'
+ * toKebabCase('Foo bAR', { prefix: 'bar' }) // => 'barfoo-bar'
+ * toKebabCase('Foo bAR', { suffix: 'bar' }) // => 'foo-barbar'
+ */
+export declare function toKebabCase(str: Nullable<string>, options?: Partial<KebabCaseOptions>): string;
+/**
+ * Converts a string to snake case.
+ * @param str The string to convert.
+ * @param options The options.
+ * @returns The converted string.
+ * @example
+ * toSnakeCase('Foo bAR') // => 'FOO_BAR'
+ * toSnakeCase('Foo bAR', { wordCasing: 'all-lower' }) // => 'foo_bar'
+ * toSnakeCase('Foo bAR', { firstWordCasing: 'all-lower' }) // => 'foo_BAR'
+ * toSnakeCase('Foo bAR', { casing: 'all-lower', firstWordCasing: 'all-upper' }) // => 'FOO_bar'
+ * toSnakeCase('Foo bAR', { prefix: 'bar' }) // => 'barFOO_BAR'
+ * toSnakeCase('Foo bAR', { suffix: 'bar' }) // => 'FOO_BARbar'
+ */
+export declare function toSnakeCase(str: Nullable<string>, options?: Partial<SnakeCaseOptions>): string;
+/**
+ * Converts a string to a custom case.
+ * @param str The string to convert.
+ * @param options The options.
+ * @returns The converted string.
+ * @example
+ * toCustomCase('Foo bAR', { wordCasing: 'first-upper-then-lower' }) // => 'FooBar'
+ * toCustomCase('Foo bAR', { wordCasing: 'first-upper-then-lower', wordSeparator: '~' }) // => 'Foo~Bar'
+ * toCustomCase('Foo bAR', { wordCasing: 'first-upper-then-lower', wordSeparator: '~', prefix: 'bar' }) // => 'barFoo~Bar'
+ * toCustomCase('Foo bAR', { wordCasing: 'first-upper-then-lower', wordSeparator: '~', suffix: 'bar' }) // => 'Foo~Barbar'
+ * toCustomCase('Foo bAR', { wordCasing: 'all-upper', firstWordCasing: 'all-lower' }) // => 'fooBAR'
+ * toCustomCase('Foo bAR baz', { wordCasing: (wordIndex) => (wordIndex % 2 === 0 ? 'all-upper' : 'all-lower') }) // => 'FOObarBAZ'
+ */
+export declare function toCustomCase(str: Nullable<string>, options: CustomCaseOptions): string;
+/**
+ * Escapes a string to be used in a regular expression.
+ * @param str The string to escape.
+ */
+export declare function escapeRegExp(str: string): string;
+/**
+ * Options for the StringBuilder class.
+ * @default newLine = os.EOL
+ */
+export type StringBuilderOptions = {
+    readonly newLine: string;
+};
+export declare const defaultStringBuilderOptions: StringBuilderOptions;
+/**
+ * Represents a mutable string of characters.
+ */
+export declare class StringBuilder {
+    private readonly _options;
+    private _str;
+    get options(): StringBuilderOptions;
+    /**
+     * Initializes a new instance of the StringBuilder class.
+     * @param options The options.
+     */
+    constructor(options?: Partial<StringBuilderOptions>);
+    /**
+     * Creates a new StringBuilder instance and appends the specified string to it.
+     * @param str The string to append.
+     * @param options The options.
+     * @returns A new StringBuilder instance.
+     */
+    static fromString(str: string, options?: Partial<StringBuilderOptions>): StringBuilder;
+    /**
+     * Builds a string using a StringBuilder build action.
+     * @param buildAction The build action to perform on the StringBuilder instance.
+     * @param options The options for the StringBuilder instance.
+     * @returns The built string.
+     */
+    static build(buildAction: (builder: StringBuilder) => void, options?: Partial<StringBuilderOptions>): string;
+    /**
+     * Appends one or more strings to the end of the current StringBuilder.
+     * @param value The string(s) to append.
+     * @returns The current StringBuilder.
+     */
+    append(...value: Nullable<string>[]): this;
+    /**
+     * Appends one or more strings to the end of the current StringBuilder, followed by a line terminator.
+     * @param value
+     * @returns
+     */
+    appendLine(...value: Nullable<string>[]): this;
+    /**
+     * Prepends one or more strings to the beginning of the current StringBuilder.
+     * @param value The string(s) to prepend.
+     * @returns The current StringBuilder.
+     */
+    prepend(...value: Nullable<string | ((builder: StringBuilder) => void)>[]): this;
+    /**
+     * Prepends one or more strings to the beginning of the current StringBuilder, followed by a line terminator.
+     * @param value The string(s) to prepend.
+     * @returns The current StringBuilder.
+     */
+    prependLine(...value: Nullable<string | ((builder: StringBuilder) => void)>[]): this;
+    /**
+     * Converts the value of this instance to a string.
+     * @returns A string whose value is the same as this instance.
+     */
+    toString(): string;
+    /**
+     * Removes all characters from the current StringBuilder.
+     */
+    clear(): void;
+}