Pascal Case
Transform text into PascalCase format where the first letter of each word is capitalized with no separators.
๐ Features
- Lightweight - Only ~450B minified + gzipped
- Type-safe - Full TypeScript support with comprehensive type definitions
- Zero dependencies - No external dependencies
- Tree-shakeable - ES modules support
- Universal - Works in browsers, Node.js, and serverless environments
- Well-tested - Comprehensive test suite with edge cases
- Customizable - Flexible options for advanced use cases
๐ฆ Installation
# npm
npm install text-pascal-case
# yarn
yarn add text-pascal-case
# pnpm
pnpm add text-pascal-case
# bun
bun add text-pascal-case
๐ฏ Quick Start
import { pascalCase } from "text-pascal-case";
console.log(pascalCase("hello world")); // "HelloWorld"
console.log(pascalCase("user_profile_data")); // "UserProfileData"
console.log(pascalCase("background-color")); // "BackgroundColor"
๐ Usage
ES Modules (Recommended)
import { pascalCase } from "text-pascal-case";
console.log(pascalCase("hello world")); // "HelloWorld"
CommonJS
const { pascalCase } = require("text-pascal-case");
console.log(pascalCase("hello world")); // "HelloWorld"
TypeScript
import {
pascalCase,
pascalCaseTransformMerge,
Options,
} from "text-pascal-case";
const result: string = pascalCase("hello world");
console.log(result); // "HelloWorld"
๐ Transformation Examples
Basic Transformations
import { pascalCase } from "text-pascal-case";
// From different cases
pascalCase("hello world"); // "HelloWorld"
pascalCase("Hello World"); // "HelloWorld"
pascalCase("HELLO WORLD"); // "HelloWorld"
pascalCase("snake_case"); // "SnakeCase"
pascalCase("kebab-case"); // "KebabCase"
pascalCase("dot.case"); // "DotCase"
pascalCase("camelCase"); // "CamelCase"
pascalCase("CONSTANT_CASE"); // "ConstantCase"
// Complex examples
pascalCase("XMLHttpRequest"); // "XmlHttpRequest"
pascalCase("iPhone"); // "IPhone"
pascalCase("version 1.2.3"); // "Version123"
pascalCase("user-profile-data"); // "UserProfileData"
Advanced Options
import { pascalCase, pascalCaseTransformMerge } from "text-pascal-case";
// Custom transform to merge numbers without separator
pascalCase("version 1.2.3", {
transform: pascalCaseTransformMerge,
}); // "Version123"
// Custom word splitting
pascalCase("XMLHttpRequest", {
splitRegexp: /([a-z])([A-Z])/g,
}); // "XmlHttpRequest"
// Custom character stripping
pascalCase("hello@world.com", {
stripRegexp: /[@.]/g,
}); // "HelloWorldCom"
// Custom transformation function
pascalCase("api-v2-endpoint", {
transform: (word, index) => {
if (word === "api") return "API";
if (word === "v2") return "V2";
return word;
},
}); // "APIV2Endpoint"
๐ Real-World Examples
Class Names
import { pascalCase } from "text-pascal-case";
// Component names
pascalCase("user_profile"); // "UserProfile"
pascalCase("email_validator"); // "EmailValidator"
pascalCase("data_service"); // "DataService"
pascalCase("auth_middleware"); // "AuthMiddleware"
pascalCase("payment_gateway"); // "PaymentGateway"
React Components
import { pascalCase } from "text-pascal-case";
// Component file names
pascalCase("user-profile"); // "UserProfile"
pascalCase("navigation-bar"); // "NavigationBar"
pascalCase("modal-dialog"); // "ModalDialog"
pascalCase("search-input"); // "SearchInput"
pascalCase("loading-spinner"); // "LoadingSpinner"
Database Models
import { pascalCase } from "text-pascal-case";
// Model class names
pascalCase("user_account"); // "UserAccount"
pascalCase("order_item"); // "OrderItem"
pascalCase("product_category"); // "ProductCategory"
pascalCase("shipping_address"); // "ShippingAddress"
API Endpoints to Types
import { pascalCase } from "text-pascal-case";
// Convert API endpoints to TypeScript interface names
const endpoints = [
"user_profile",
"order_history",
"payment_method",
"shipping_address",
];
const typeNames = endpoints.map(
(endpoint) => `${pascalCase(endpoint)}Response`,
);
console.log(typeNames);
// ["UserProfileResponse", "OrderHistoryResponse", "PaymentMethodResponse", "ShippingAddressResponse"]
๐ API Reference
pascalCase(input, options?)
Converts a string to PascalCase.
Parameters
input
(string
): The string to convertoptions
(Options
, optional): Configuration options
Returns
string
: The PascalCase formatted string
Options
interface Options {
// Custom transform function for word processing
transform?: (word: string, index: number, words: string[]) => string;
// Regex to strip characters before processing
stripRegexp?: RegExp;
// Custom split function
split?: (value: string) => string[];
}
pascalCaseTransformMerge
A transform function that merges numeric characters without separation.
import { pascalCase, pascalCaseTransformMerge } from "text-pascal-case";
pascalCase("version 1.2.3", { transform: pascalCaseTransformMerge }); // "Version123"
๐ง Advanced Configuration
Custom Word Splitting
import { pascalCase } from "text-pascal-case";
// Split on specific patterns
pascalCase("XMLHttpRequest", {
splitRegexp: /([a-z])([A-Z])/g,
}); // "XmlHttpRequest"
// Split on numbers
pascalCase("user123data", {
splitRegexp: /([a-zA-Z])(\d)/g,
}); // "User123Data"
Custom Character Stripping
import { pascalCase } from "text-pascal-case";
// Strip specific characters
pascalCase("hello@world.com", {
stripRegexp: /[@.]/g,
}); // "HelloWorldCom"
// Strip all non-alphanumeric
pascalCase("hello!@#world", {
stripRegexp: /[^a-zA-Z0-9]/g,
}); // "HelloWorld"
Custom Transform Functions
import { pascalCase } from "text-pascal-case";
// Preserve acronyms
pascalCase("xml-http-request", {
transform: (word, index) => {
const acronyms = ["xml", "http", "api", "url"];
if (acronyms.includes(word.toLowerCase())) {
return word.toUpperCase();
}
return word;
},
}); // "XMLHTTPRequest"
// Custom business logic
pascalCase("user-v2-api", {
transform: (word, index) => {
if (word === "v2") return "V2";
if (word === "api") return "API";
return word;
},
}); // "UserV2API"
๐ Bundle Size
This package is optimized for minimal bundle size:
- Minified: ~450B
- Gzipped: ~250B
- Tree-shakeable: Yes
- Side effects: None
๐ Browser Support
- Modern browsers: ES2015+ (Chrome 51+, Firefox 54+, Safari 10+)
- Node.js: 12+
- TypeScript: 4.0+
- Bundle formats: UMD, ESM, CommonJS
๐งช Testing
# Run tests
pnpm test
# Run tests in watch mode
pnpm test --watch
# Run tests with coverage
pnpm test --coverage
# Type checking
pnpm typecheck
# Linting
pnpm lint
๐ Related Packages
text-camel-case
- Convert to camelCasetext-snake-case
- Convert to snake_casetext-kebab-case
- Convert to kebab-casetext-title-case
- Convert to Title Casetext-case
- All case transformations in one package
๐ License
๐ค Contributing
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature
) - Commit your changes (
git commit -m 'Add some amazing feature'
) - Push to the branch (
git push origin feature/amazing-feature
) - Open a Pull Request
๐ Support
- ๐ง Email: selikhov.dmitrey@gmail.com
- ๐ Issues: GitHub Issues
- ๐ฌ Discussions: GitHub Discussions
- ๐ Documentation: Full Documentation
Made with โค๏ธ by Dmitry Selikhov