moderndash 0.0.5

package/test/function/memoize.test.ts

@@ -0,0 +1,33 @@
+import { test, describe, expect, vi, beforeEach } from 'vitest';
+
+import { memoize } from '@function/memoize';
+
+describe('memoize', () => {
+    const testFn = vi.fn((a: number, b: number) => a + b);
+
+    beforeEach(() => {
+        testFn.mockClear();
+    });
+
+
+    test('should memoize a function', () => {
+        const memoizedFunc = memoize(testFn);
+
+        expect(memoizedFunc(1, 2)).to.equal(3);
+        expect(memoizedFunc(1, 2)).to.equal(3);
+        expect(testFn).toHaveBeenCalledOnce();
+    });
+
+    test('should return different results for different arguments', () => {
+        const memoizedFunc = memoize(testFn);
+
+        expect(memoizedFunc(1, 2)).to.equal(3);
+        expect(memoizedFunc(2, 3)).to.equal(5);
+        expect(testFn).toHaveBeenCalledTimes(2);
+    });
+
+    test('should expose a cache property', () => {
+        const memoizedFunc = memoize(testFn);
+        expect(memoizedFunc.cache).to.be.an.instanceof(Map);
+    });
+});

package/test/function/once.test.ts

@@ -0,0 +1,29 @@
+import { test, describe, expect, vi, afterEach } from 'vitest';
+
+import { once } from '@function/once';
+
+describe('once', () => {
+    const testFn = vi.fn((x: number) => x * 2);
+
+    afterEach(() => {
+        testFn.mockClear();
+    });
+
+    test('only calls the function once', () => {
+        const onceFn = once(testFn);
+
+        onceFn(1);
+        expect(testFn).toHaveBeenCalledTimes(1);
+        onceFn(1);
+        expect(testFn).toHaveBeenCalledTimes(1);
+        onceFn(1);
+        expect(testFn).toHaveBeenCalledTimes(1);
+    });
+
+    test('preserves the return value of the function', () => {
+        const onceFn = once(testFn);
+
+        expect(onceFn(2)).toBe(4);
+        expect(onceFn(3)).toBe(4);
+    });
+});

package/test/function/throttle.test.ts

@@ -0,0 +1,24 @@
+import { describe, expect, test, vi } from 'vitest';
+
+import { throttle } from '@function/throttle';
+
+describe('throttle', () => {
+    test('only calls the function once', () => {
+        vi.useFakeTimers();
+
+        const callback = vi.fn();
+        const throttled = throttle(callback, 100);
+
+        throttled();
+        throttled();
+        throttled();
+
+        expect(callback).toHaveBeenCalledTimes(1);
+
+        vi.advanceTimersByTime(99);
+        expect(callback).toHaveBeenCalledTimes(1);
+
+        vi.advanceTimersByTime(1);
+        expect(callback).toHaveBeenCalledTimes(2);
+    });
+});

package/test/lang/isEqualMethods.test.ts

@@ -0,0 +1,98 @@
+import { describe, expect, test } from 'vitest';
+
+import { isEqual } from '@lang/isEqual';
+import { isEqualWith } from '@lang/isEqualWith';
+
+describe('isEqual', () => {
+    test('numbers', () => {
+        expect(isEqual(1, 1)).toBe(true);
+        expect(isEqual(1, 2)).toBe(false);
+    });
+
+    test('strings', () => {
+        expect(isEqual('a', 'a')).toBe(true);
+        expect(isEqual('a', 'b')).toBe(false);
+    });
+
+    test('booleans', () => {
+        expect(isEqual(true, true)).toBe(true);
+        expect(isEqual(true, false)).toBe(false);
+    });
+
+    test('null', () => {
+        expect(isEqual(null, null)).toBe(true);
+        expect(isEqual(null, undefined)).toBe(false);
+    });
+
+    test('undefined', () => {
+        expect(isEqual(undefined, undefined)).toBe(true);
+        expect(isEqual(undefined, null)).toBe(false);
+    });
+
+    test('objects', () => {
+        expect(isEqual({ a: 1 }, { a: 1 })).toBe(true);
+        expect(isEqual({ a: 1 }, { a: 2 })).toBe(false);
+    });
+
+    test('arrays', () => {
+        expect(isEqual([1, 2, 3], [1, 2, 3])).toBe(true);
+        expect(isEqual([1, 2, 3], [1, 2, 4])).toBe(false);
+    });
+
+    test('nested objects', () => {
+        expect(isEqual({ a: { b: 1 } }, { a: { b: 1 } })).toBe(true);
+        expect(isEqual({ a: { b: 1 } }, { a: { b: 2 } })).toBe(false);
+    });
+
+    test('nested arrays', () => {
+        expect(isEqual([[1], [2], [3]], [[1], [2], [3]])).toBe(true);
+        expect(isEqual([[1], [2], [3]], [[1], [2], [4]])).toBe(false);
+    });
+
+    test('nested objects and arrays', () => {
+        expect(isEqual({ a: { b: [1] } }, { a: { b: [1] } })).toBe(true);
+        expect(isEqual({ a: { b: [1] } }, { a: { b: [2] } })).toBe(false);
+    });
+
+    test('objects with different keys', () => {
+        expect(isEqual({ a: 1 }, { b: 1 })).toBe(false);
+    });
+
+    test('arrays with different lengths', () => {
+        expect(isEqual([1, 2, 3], [1, 2])).toBe(false);
+    });
+
+    // eslint-disable-next-line unicorn/consistent-function-scoping
+    const testFunction = () => { return 1 };
+    test('functions', () => {
+        expect(isEqual(() => { return 1 }, () => { return 2 })).toBe(false);
+        expect(isEqual(testFunction, testFunction)).toBe(true);
+    });
+
+    test('objects with functions', () => {
+        expect(isEqual({ a: () => { return 1 } }, { a: () => { return 1 } })).toBe(false);
+        expect(isEqual({ a: testFunction }, { a: testFunction })).toBe(true);
+    });
+
+    test('regExp', () => {
+        expect(isEqual(/a(.*)/, /a(.*)/)).toBe(true);
+        expect(isEqual(/a/, /b.*/)).toBe(false);
+    });
+});
+
+
+describe('isEqualWith', () => {
+    test('should return true if the customizer function returns equal values for both inputs', () => {
+        expect(isEqualWith(Math.floor, 1.3, 1.8)).toBe(true);
+    });
+
+    test('should return false if the customizer function returns different values for both inputs', () => {
+        const customizer = (value: number) => value * 2;
+        expect(isEqualWith(customizer, 2, 5)).toBe(false);
+    });
+
+    test('should work with objects as input', () => {
+        const customizer = (value: { a: number, b: number }) => value.a + value.b;
+        expect(isEqualWith(customizer, { a: 2, b: 3 }, { a: 1, b: 4 })).toBe(true);
+    });
+});

package/test/string/camelCase.test.ts

@@ -0,0 +1,13 @@
+import { describe, expect, test } from 'vitest';
+
+import { camelCase } from '@string/camelCase';
+
+describe('camelCase', () => {
+    test('should convert a string to camel case', () => {
+        expect(camelCase('Foo Bar')).toBe('fooBar');
+        expect(camelCase('fooBar')).toBe('fooBar');
+        expect(camelCase('FooBar')).toBe('fooBar');
+        expect(camelCase('--foo-bar--')).toBe('fooBar');
+        expect(camelCase('__FOO_BAR__')).toBe('fooBar');
+    });
+});

package/test/string/capitalize.test.ts

@@ -0,0 +1,17 @@
+import { expect, test, describe } from 'vitest';
+
+import { capitalize } from '@string/capitalize';
+
+describe('capitalize', () => {
+    test('capitalizes the first letter of a string', () => {
+        expect(capitalize('hello world')).toBe('Hello world');
+    });
+
+    test('returns an empty string for an empty input', () => {
+        expect(capitalize('')).toBe('');
+    });
+
+    test('returns the original string for a single-character string', () => {
+        expect(capitalize('a')).toBe('A');
+    });
+});

package/test/string/deburr.test.ts

@@ -0,0 +1,16 @@
+import { describe, expect, test } from 'vitest';
+
+import { deburr } from '@string/deburr';
+
+describe('deburr', () => {
+    test('removes diacritics from a string', () => {
+        expect(deburr('Mëtàl Hëàd')).toEqual('Metal Head');
+        expect(deburr('Pokémón')).toEqual('Pokemon');
+        expect(deburr('résumé')).toEqual('resume');
+    });
+
+    test('returns the input string if it has no diacritics', () => {
+        expect(deburr('hello')).toEqual('hello');
+        expect(deburr('world')).toEqual('world');
+    });
+});

package/test/string/escape.test.ts

@@ -0,0 +1,17 @@
+import { expect, test, describe } from 'vitest';
+
+import { escape } from '@string/escape';
+
+describe('escapeToHTML', () => {
+    test('should escape special characters to HTML entities', () => {
+        const str = '<p>Hello, World!</p>';
+        const html = escape(str);
+        expect(html).toBe('&lt;p&gt;Hello, World!&lt;/p&gt;');
+    });
+
+    test('should return the original string if it does not contain special characters', () => {
+        const str = 'Hello, World!';
+        const html = escape(str);
+        expect(html).toBe(str);
+    });
+});

package/test/string/escapeRegExp.test.ts

@@ -0,0 +1,18 @@
+import { expect, test, describe } from 'vitest';
+
+import { escapeRegExp } from '@string/escapeRegExp';
+
+describe('escapeRegExp', () => {
+    test('escapes special characters in a string', () => {
+        expect(escapeRegExp('hello.world*')).toBe('hello\\.world\\*');
+        expect(escapeRegExp('[lodash](https://lodash.com/)')).toBe('\\[lodash\\]\\(https://lodash\\.com/\\)');
+    });
+
+    test('returns an empty string for an empty input', () => {
+        expect(escapeRegExp('')).toBe('');
+    });
+
+    test('returns the original string for a string without special characters', () => {
+        expect(escapeRegExp('hello world')).toBe('hello world');
+    });
+});

package/test/string/kebabCase.test.ts

@@ -0,0 +1,18 @@
+import { describe, expect, test } from 'vitest';
+
+import { kebabCase } from '@string/kebabCase';
+
+describe('kebabCase', () => {
+    test('converts a string to kebab case', () => {
+        expect(kebabCase('helloWorld')).toBe('hello-world');
+        expect(kebabCase('helloCRUELWorld')).toBe('hello-cruel-world');
+    });
+
+    test('returns an empty string for an empty input', () => {
+        expect(kebabCase('')).toBe('');
+    });
+
+    test('returns the original string for a single-word string', () => {
+        expect(kebabCase('hello')).toBe('hello');
+    });
+});

package/test/string/pascalCase.test.ts

@@ -0,0 +1,16 @@
+import { describe, expect, test } from 'vitest';
+
+import { pascalCase } from '@string/pascalCase';
+
+describe('toPascalCase', () => {
+    test('converts a string to PascalCase', () => {
+        expect(pascalCase('hello world')).toEqual('HelloWorld');
+        expect(pascalCase('this is a.test')).toEqual('ThisIsATest');
+        expect(pascalCase('CamelCase')).toEqual('CamelCase');
+    });
+
+    test('handles empty strings and single words correctly', () => {
+        expect(pascalCase('')).toEqual('');
+        expect(pascalCase('hello')).toEqual('Hello');
+    });
+});

package/test/string/snakeCase.test.ts

@@ -0,0 +1,23 @@
+import { describe, expect, test } from 'vitest';
+
+import { snakeCase } from '@string/snakeCase';
+
+describe('snakeCase', () => {
+    test('converts a string to snake_case', () => {
+        expect(snakeCase('someString')).toBe('some_string');
+        expect(snakeCase('someOtherString')).toBe('some_other_string');
+        expect(snakeCase('someStringWithCamelCase')).toBe('some_string_with_camel_case');
+    });
+
+    test('converts a string with multiple uppercase letters to snake_case', () => {
+        expect(snakeCase('someStringWithMultipleUppercaseLetters')).toBe('some_string_with_multiple_uppercase_letters');
+    });
+
+    test('handles strings that are already in snake_case', () => {
+        expect(snakeCase('some_string')).toBe('some_string');
+    });
+
+    test('handles empty strings', () => {
+        expect(snakeCase('')).toBe('');
+    });
+});

package/test/string/startCase.test.ts

@@ -0,0 +1,14 @@
+import { expect, test, describe } from 'vitest';
+
+import { startCase } from '@string/startCase';
+
+describe('startCase', () => {
+    test('should convert a string to start case', () => {
+        expect(startCase('hello world')).toBe('Hello World');
+        expect(startCase('HELLO WORLD')).toBe('Hello World');
+        expect(startCase('Hello World')).toBe('Hello World');
+        expect(startCase('hello-world')).toBe('Hello World');
+        expect(startCase('hello_world')).toBe('Hello World');
+        expect(startCase('hello  world')).toBe('Hello World');
+    });
+});

package/test/string/stripSpecialChars.test.ts

@@ -0,0 +1,15 @@
+import { describe, test, expect } from 'vitest';
+
+import { stripSpecialChars } from '@string/stripSpecialChars';
+
+describe('stripSpecialChars', () => {
+    test('removes special characters from a string', () => {
+        expect(stripSpecialChars('Héllo, world!')).toEqual('Hello world');
+        expect(stripSpecialChars('This string has #$%&*!')).toEqual('This string has ');
+        expect(stripSpecialChars('Testing 123')).toEqual('Testing 123');
+    });
+
+    test('returns an empty string if given an empty string', () => {
+        expect(stripSpecialChars('')).toEqual('');
+    });
+});

package/test/string/unescape.test.ts

@@ -0,0 +1,17 @@
+import { test, expect, describe } from 'vitest';
+
+import { unescapeHTML } from '@string/unescape';
+
+describe('unescapeHTML', () => {
+    test('should unescape HTML entities', () => {
+        const html = '<p>Hello, World!</p>';
+        const str = unescapeHTML(html);
+        expect(str).toBe('<p>Hello, World!</p>');
+    });
+
+    test('should return the original string if it does not contain HTML entities', () => {
+        const html = 'Hello, World!';
+        const str = unescapeHTML(html);
+        expect(str).toBe(html);
+    });
+});

package/tsconfig.json

@@ -0,0 +1,112 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2020",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    "lib": ["ESNext", "DOM"],                             /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    "types": [],
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "esnext",                                  /* Specify what module code is generated. */
+    "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+    "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./dist",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true,
+    "paths": {
+      "@array/*": ["src/array/*"],
+      "@lang/*": ["src/lang/*"],
+      "@function/*": ["src/function/*"],
+      "@object/*": ["src/object/*"],
+      "@string/*": ["src/string/*"],
+      "@collection/*": ["src/collection/*"],
+      "@helpers/*": ["src/helpers/*"]
+    }
+  },
+  "include": ["./**/*.ts", "./**/*.js"]
+}

package/tsup.config.js

@@ -0,0 +1,10 @@
+import { defineConfig } from 'tsup';
+
+export default defineConfig({
+    entry: ['src/index.ts'],
+    format: ['esm'],
+    sourcemap: true,
+    clean: true,
+    outDir: 'dist',
+    dts: true
+});

package/vitest.config.ts

@@ -0,0 +1,27 @@
+/// <reference types="vitest" />
+// Configure Vitest (https://vitest.dev/config/)
+
+import { fileURLToPath, URL } from 'url';
+
+import { defineConfig } from 'vite';
+
+const getPath = (path: string) => fileURLToPath(new URL(path, import.meta.url));
+
+export default defineConfig({
+    test: {
+        /* for example, use global to avoid globals imports (describe, test, expect): */
+        // globals: true,
+    },
+    resolve: {
+        alias: {
+            '@array': getPath('src/array'),
+            '@lang': getPath('src/lang'),
+            '@object': getPath('src/object'),
+            '@function': getPath('src/function'),
+            '@collection': getPath('src/collection'),
+            '@string': getPath('src/string'),
+            '@number': getPath('src/number'),
+            '@helpers': getPath('src/helpers')
+        }
+    }
+});