korea_super_formatter 1.0.1

Korean-specific formatters for Flutter. Supports KRW currency, phone numbers, dates, privacy masking, business numbers, and more.

Korea Super Formatter 🇰🇷

Korean-specific formatters for Flutter. 한국 서비스에 특화된 포맷터 패키지입니다.

✨ Features

• 💰 금액 포맷터 - 원화, 한글 단위 표기, 파싱
• 📈 수익률 포맷터 - 퍼센트, 부호 포함, 색상 헬퍼
• 📱 전화번호 포맷터 - 자동 포맷팅, 마스킹, 유효성 검사
• 🕐 상대 시간 포맷터 - "5분 전", "어제", "3일 전" 등
• 📅 날짜 포맷터 - 한국식 날짜 형식, 요일 포함
• 🔢 숫자 포맷터 - 천 단위 구분, 한글 단위 표기
• 🔒 개인정보 마스킹 - 이름, 이메일, 전화번호, 계좌번호 등
• 🏢 사업자번호 포맷터 - 포맷팅, 유효성 검사

📦 Installation

dependencies:
  korea_super_formatter: ^1.0.0

flutter pub get

🚀 Usage

💰 금액 포맷터 (KrwFormatter)

import 'package:korea_super_formatter/korea_super_formatter.dart';

// 기본 포맷
KrwFormatter.format(1350000);              // "1,350,000원"
KrwFormatter.format(1350000, unit: false); // "1,350,000"

// 한글 단위 표기
KrwFormatter.toKorean(135003000);          // "1억 3,500만 3,000원"
KrwFormatter.toKoreanCompact(135003000);   // "1.35억"

// 부호 포함
KrwFormatter.formatSigned(50000);          // "+50,000원"
KrwFormatter.formatSigned(-30000);         // "-30,000원"

// 파싱
KrwFormatter.parse("1억 3,500만원");        // 135000000

📈 수익률 포맷터 (PercentFormatter)

// 기본 포맷
PercentFormatter.format(12.345);           // "12.35%"
PercentFormatter.format(12.345, decimals: 1); // "12.3%"

// 부호 포함
PercentFormatter.formatSigned(12.34);      // "+12.34%"
PercentFormatter.formatSigned(-5.67);     // "-5.67%"

// 색상 헬퍼
PercentFormatter.getColor(12.34);         // Colors.red (상승)
PercentFormatter.getColor(-5.67);         // Colors.blue (하락)

// 파싱
PercentFormatter.parse("+12.34%");        // 12.34

📱 전화번호 포맷터 (PhoneFormatter)

// 포맷팅
PhoneFormatter.format("01012345678");      // "010-1234-5678"
PhoneFormatter.format("0212345678");      // "02-1234-5678"

// 마스킹
PhoneFormatter.mask("01012345678");        // "010-****-5678"
PhoneFormatter.mask("01012345678", start: 3, end: 7); // "010-****-5678"

// 유효성 검사
PhoneFormatter.isValid("01012345678");     // true
PhoneFormatter.isMobile("01012345678");    // true

🕐 상대 시간 포맷터 (RelativeTime)

// 기본 포맷
RelativeTime.format(dateTime);             // "5분 전"
RelativeTime.format(dateTime);             // "어제"
RelativeTime.format(dateTime);             // "3일 전"

// 스마트 포맷
RelativeTime.formatSmart(dateTime);
// - 1분 미만: "지금"
// - 1~59분: "N분 전"
// - 1~23시간: "N시간 전"
// - 1~3일: "N일 전"
// - 그 이후: "3월 15일"

// 미래 시간
RelativeTime.formatFuture(futureDate);     // "5분 후", "내일"

📅 날짜 포맷터 (DateFormatter)

// 기본 포맷
DateFormatter.format(date);                // "2024.03.15"
DateFormatter.formatFull(date);            // "2024년 3월 15일"
DateFormatter.formatWithDay(date);         // "2024.03.15 (금)"

// 시간 포함
DateFormatter.formatDateTime(dateTime);    // "2024.03.15 14:30"
DateFormatter.formatTime12(dateTime);      // "오후 2:30"

// 기간
DateFormatter.formatRange(start, end);     // "2024.03.15 ~ 2024.03.20"

🔒 개인정보 마스킹 (PrivacyMasker)

// 범용 마스킹
PrivacyMasker.mask("홍길동", start: 1, end: 2);     // "홍*동"
PrivacyMasker.mask("01012345678", start: 3, end: 7); // "010****5678"

// 타입별 편의 메서드
PrivacyMasker.name("홍길동");              // "홍*동" (기본)
PrivacyMasker.name("홍길동", start: 0, end: 2); // "**동" (커스텀)

PrivacyMasker.email("[e-mail]");     // "te**@gmail.com"
PrivacyMasker.phone("01012345678");        // "010-****-5678"
PrivacyMasker.rrn("901215-1234567");       // "901215-1******"
PrivacyMasker.account("12345678901234");   // "1234******1234"
PrivacyMasker.card("1234567890123456");    // "1234-****-****-3456"

🏢 사업자번호 포맷터 (BusinessFormatter)

// 포맷팅
BusinessFormatter.formatBrn("1234567890");  // "123-45-67890"

// 유효성 검사 (국세청 공식 알고리즘)
BusinessFormatter.isValidBrn("1234567890"); // true/false

// 법인등록번호
BusinessFormatter.formatCrn("1234567890123"); // "123456-7890123"
BusinessFormatter.isValidCrn("1234567890123"); // true/false

📋 API Reference

KrwFormatter

• format(int amount, {bool unit = true}) - 기본 금액 포맷팅
• toKorean(int amount) - 한글 단위 표기
• toKoreanCompact(int amount) - 간략형 한글 단위
• formatSigned(int amount, {bool unit = true}) - 부호 포함
• parse(String amountStr) - 한글 금액 파싱

PercentFormatter

• format(double rate, {int decimals = 2}) - 기본 포맷팅
• formatSigned(double rate, {int decimals = 2}) - 부호 포함
• getColor(double rate, {...}) - 색상 반환
• parse(String rateStr) - 퍼센트 파싱

PhoneFormatter

• format(String phone) - 전화번호 포맷팅
• mask(String phone, {int? start, int? end}) - 마스킹
• isValid(String phone) - 유효성 검사
• isMobile(String phone) - 휴대폰 확인
• isLandline(String phone) - 일반전화 확인

RelativeTime

• format(DateTime dateTime) - 기본 상대 시간
• formatSmart(DateTime dateTime) - 스마트 포맷
• formatShort(DateTime dateTime) - 짧은 형식
• formatFuture(DateTime dateTime) - 미래 시간

DateFormatter

• format(DateTime date) - 기본 날짜 포맷
• formatFull(DateTime date) - 전체 날짜
• formatWithDay(DateTime date) - 요일 포함
• formatDateTime(DateTime dateTime) - 날짜+시간
• formatTime12(DateTime dateTime) - 12시간제

PrivacyMasker

• mask(String value, {int? start, int? end, String maskChar = '*'}) - 범용 마스킹
• name(String name, {...}) - 이름 마스킹
• email(String email, {...}) - 이메일 마스킹
• phone(String phone, {...}) - 전화번호 마스킹
• rrn(String rrn, {...}) - 주민등록번호 마스킹
• account(String account, {...}) - 계좌번호 마스킹
• card(String card, {...}) - 카드번호 마스킹

BusinessFormatter

• formatBrn(String brn) - 사업자등록번호 포맷팅
• isValidBrn(String brn) - 사업자등록번호 검증
• formatCrn(String crn) - 법인등록번호 포맷팅
• isValidCrn(String crn) - 법인등록번호 검증

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Formatters are optimized for Korean financial and business environments
• Business registration number validation follows NTS (National Tax Service) standards