goodchuck-utils 1.1.0 → 1.3.0

package/src/string/manipulation.ts

@@ -0,0 +1,124 @@
+/**
+ * String Manipulation Utilities
+ */
+
+/**
+ * 문자열을 지정된 길이로 자르고 말줄임표 추가
+ * @example truncate('Hello World', 5) // 'Hello...'
+ */
+export function truncate(str: string, length: number, suffix: string = '...'): string {
+  if (str.length <= length) return str;
+  return str.slice(0, length) + suffix;
+}
+
+/**
+ * 문자열 양쪽 공백 제거 및 연속된 공백을 하나로
+ * @example normalizeWhitespace('  hello   world  ') // 'hello world'
+ */
+export function normalizeWhitespace(str: string): string {
+  return str.trim().replace(/\s+/g, ' ');
+}
+
+/**
+ * URL 친화적인 슬러그 생성
+ * @example slugify('Hello World!') // 'hello-world'
+ * @example slugify('Test123 World') // 'test123-world'
+ */
+export function slugify(str: string): string {
+  return str
+    .toLowerCase()
+    .trim()
+    .replace(/[^\w\s-]/g, '')
+    .replace(/[\s_]+/g, '-')
+    .replace(/-+/g, '-')
+    .replace(/^-+|-+$/g, '');
+}
+
+/**
+ * 랜덤 문자열 생성
+ * @param length - 생성할 문자열 길이
+ * @param charset - 사용할 문자 집합 ('alphanumeric', 'alpha', 'numeric', 'hex')
+ */
+export function randomString(
+  length: number,
+  charset: 'alphanumeric' | 'alpha' | 'numeric' | 'hex' = 'alphanumeric'
+): string {
+  const charsets = {
+    alphanumeric: 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789',
+    alpha: 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz',
+    numeric: '0123456789',
+    hex: '0123456789abcdef',
+  };
+
+  const chars = charsets[charset];
+  let result = '';
+
+  for (let i = 0; i < length; i++) {
+    result += chars.charAt(Math.floor(Math.random() * chars.length));
+  }
+
+  return result;
+}
+
+/**
+ * 문자열 반복
+ * @example repeat('ab', 3) // 'ababab'
+ */
+export function repeat(str: string, count: number): string {
+  return str.repeat(count);
+}
+
+/**
+ * 문자열 뒤집기
+ * @example reverse('hello') // 'olleh'
+ */
+export function reverse(str: string): string {
+  return str.split('').reverse().join('');
+}
+
+/**
+ * 문자열에서 HTML 태그 제거
+ * @example stripHtml('<p>Hello <strong>World</strong></p>') // 'Hello World'
+ */
+export function stripHtml(str: string): string {
+  return str.replace(/<[^>]*>/g, '');
+}
+
+/**
+ * 문자열을 특정 길이로 패딩
+ * @example padStart('5', 3, '0') // '005'
+ */
+export function padStart(str: string, length: number, fillString: string = ' '): string {
+  return str.padStart(length, fillString);
+}
+
+/**
+ * 문자열을 특정 길이로 패딩 (오른쪽)
+ * @example padEnd('5', 3, '0') // '500'
+ */
+export function padEnd(str: string, length: number, fillString: string = ' '): string {
+  return str.padEnd(length, fillString);
+}
+
+/**
+ * 템플릿 문자열 치환
+ * @example template('Hello {name}!', { name: 'World' }) // 'Hello World!'
+ */
+export function template(str: string, values: Record<string, any>): string {
+  return str.replace(/\{(\w+)\}/g, (match, key) => {
+    return values[key] !== undefined ? String(values[key]) : match;
+  });
+}
+
+/**
+ * 마스킹 (특정 위치의 문자를 *로 변경)
+ * @example mask('1234567890', 3, 7) // '123****890'
+ */
+export function mask(str: string, start: number, end?: number, maskChar: string = '*'): string {
+  const endPos = end ?? str.length;
+  return (
+    str.slice(0, start) +
+    maskChar.repeat(endPos - start) +
+    str.slice(endPos)
+  );
+}

package/src/string/validation.ts

@@ -0,0 +1,126 @@
+/**
+ * String Validation Utilities
+ */
+
+/**
+ * 빈 문자열 또는 공백만 있는지 확인
+ * @example isEmpty('') // true
+ * @example isEmpty('  ') // true
+ * @example isEmpty('hello') // false
+ */
+export function isEmpty(str: string): boolean {
+  return !str || str.trim().length === 0;
+}
+
+/**
+ * 문자열이 특정 문자로 시작하는지 확인
+ * @example startsWith('hello', 'he') // true
+ */
+export function startsWith(str: string, searchString: string): boolean {
+  return str.startsWith(searchString);
+}
+
+/**
+ * 문자열이 특정 문자로 끝나는지 확인
+ * @example endsWith('hello', 'lo') // true
+ */
+export function endsWith(str: string, searchString: string): boolean {
+  return str.endsWith(searchString);
+}
+
+/**
+ * 문자열에 특정 문자열이 포함되어 있는지 확인
+ * @example contains('hello world', 'world') // true
+ */
+export function contains(str: string, searchString: string): boolean {
+  return str.includes(searchString);
+}
+
+/**
+ * 알파벳만 포함하는지 확인
+ * @example isAlpha('hello') // true
+ * @example isAlpha('hello123') // false
+ */
+export function isAlpha(str: string): boolean {
+  return /^[a-zA-Z]+$/.test(str);
+}
+
+/**
+ * 숫자만 포함하는지 확인
+ * @example isNumeric('123') // true
+ * @example isNumeric('123.45') // false
+ */
+export function isNumeric(str: string): boolean {
+  return /^[0-9]+$/.test(str);
+}
+
+/**
+ * 알파벳과 숫자만 포함하는지 확인
+ * @example isAlphanumeric('hello123') // true
+ * @example isAlphanumeric('hello_123') // false
+ */
+export function isAlphanumeric(str: string): boolean {
+  return /^[a-zA-Z0-9]+$/.test(str);
+}
+
+/**
+ * 소문자만 포함하는지 확인
+ * @example isLowerCase('hello') // true
+ * @example isLowerCase('Hello') // false
+ */
+export function isLowerCase(str: string): boolean {
+  return str === str.toLowerCase() && str !== str.toUpperCase();
+}
+
+/**
+ * 대문자만 포함하는지 확인
+ * @example isUpperCase('HELLO') // true
+ * @example isUpperCase('Hello') // false
+ */
+export function isUpperCase(str: string): boolean {
+  return str === str.toUpperCase() && str !== str.toLowerCase();
+}
+
+/**
+ * JSON 형식인지 확인
+ * @example isJSON('{"name":"John"}') // true
+ * @example isJSON('not json') // false
+ */
+export function isJSON(str: string): boolean {
+  try {
+    JSON.parse(str);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+/**
+ * 16진수 색상 코드인지 확인
+ * @example isHexColor('#fff') // true
+ * @example isHexColor('#ffffff') // true
+ * @example isHexColor('fff') // false
+ */
+export function isHexColor(str: string): boolean {
+  return /^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$/.test(str);
+}
+
+/**
+ * UUID 형식인지 확인
+ * @example isUUID('123e4567-e89b-12d3-a456-426614174000') // true
+ */
+export function isUUID(str: string): boolean {
+  return /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i.test(str);
+}
+
+/**
+ * Base64 인코딩된 문자열인지 확인
+ * @example isBase64('SGVsbG8gV29ybGQ=') // true
+ */
+export function isBase64(str: string): boolean {
+  try {
+    return btoa(atob(str)) === str;
+  } catch {
+    return false;
+  }
+}

package/tsconfig.json

@@ -1,14 +1,18 @@
 {
   "compilerOptions": {
-    "target": "es6" /* 최신 브라우저는 es6을 대부분 지원한다. */,
-    "module": "commonjs" /* 모듈 시스템을 지정한다. */,
-    "lib": [
-      "es5",
-      "es6",
-      "dom"
-    ] /* 타입스크립트가 어떤 버전의 JS의 빌트인 api를 사용할건지에 대한 것을 명시해 준다. */,
-    "declaration": true /* 타입스크립트가 자동으로 타입정의 (d.ts) 파일을 생성해 준다. */,
-    "outDir": "dist" /* 컴파일된 결과물을 어디에 저장할지에 대한 것을 명시해 준다. */,
-    "strict": true /* 타입스크립트의 엄격한 모드를 활성화한다. */
-  }
+    "target": "ES2020",
+    "module": "ESNext",
+    "lib": ["ES2020", "DOM"],
+    "declaration": true,
+    "declarationMap": true,
+    "outDir": "dist",
+    "rootDir": "src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["node_modules", "dist"]
 }

package/vitest.config.ts

@@ -0,0 +1,13 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    globals: true,
+    environment: 'node',
+    coverage: {
+      provider: 'v8',
+      reporter: ['text', 'html'],
+      exclude: ['node_modules/', 'dist/', '**/*.test.ts'],
+    },
+  },
+});