Sentence Case
Transform text into Sentence case format where the first word is capitalized and the rest are lowercase, separated by spaces.
๐ 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-sentence-case
# yarn
yarn add text-sentence-case
# pnpm
pnpm add text-sentence-case
# bun
bun add text-sentence-case
๐ฏ Quick Start
import { sentenceCase } from "text-sentence-case";
console.log(sentenceCase("hello world")); // "Hello world"
console.log(sentenceCase("userProfileData")); // "User profile data"
console.log(sentenceCase("backgroundColor")); // "Background color"
๐ Usage
ES Modules (Recommended)
import { sentenceCase } from "text-sentence-case";
console.log(sentenceCase("hello world")); // "Hello world"
CommonJS
const { sentenceCase } = require("text-sentence-case");
console.log(sentenceCase("hello world")); // "Hello world"
TypeScript
import { sentenceCase, Options } from "text-sentence-case";
const result: string = sentenceCase("hello world");
console.log(result); // "Hello world"
๐ Transformation Examples
Basic Transformations
import { sentenceCase } from "text-sentence-case";
// From different cases
sentenceCase("hello world"); // "Hello world"
sentenceCase("Hello World"); // "Hello world"
sentenceCase("HELLO WORLD"); // "Hello world"
sentenceCase("camelCase"); // "Camel case"
sentenceCase("PascalCase"); // "Pascal case"
sentenceCase("snake_case"); // "Snake case"
sentenceCase("kebab-case"); // "Kebab case"
sentenceCase("dot.case"); // "Dot case"
// Complex examples
sentenceCase("XMLHttpRequest"); // "Xml http request"
sentenceCase("iPhone"); // "I phone"
sentenceCase("version 1.2.3"); // "Version 1 2 3"
sentenceCase("userProfileData"); // "User profile data"
Advanced Options
import { sentenceCase } from "text-sentence-case";
// Custom word splitting
sentenceCase("XMLHttpRequest", {
splitRegexp: /([a-z])([A-Z])/g,
}); // "Xml http request"
// Custom character stripping
sentenceCase("hello@world.com", {
stripRegexp: /[@.]/g,
}); // "Hello world com"
// Custom transformation function
sentenceCase("api-v2-endpoint", {
transform: (word, index) => {
if (index === 0) {
if (word === "api") return "API";
return word.charAt(0).toUpperCase() + word.slice(1).toLowerCase();
}
if (word === "v2") return "V2";
return word.toLowerCase();
},
}); // "API v2 endpoint"
๐ Real-World Examples
Content Headings
import { sentenceCase } from "text-sentence-case";
// Article headings
sentenceCase("gettingStarted"); // "Getting started"
sentenceCase("bestPractices"); // "Best practices"
sentenceCase("troubleshooting"); // "Troubleshooting"
sentenceCase("frequentlyAskedQuestions"); // "Frequently asked questions"
sentenceCase("advancedConfiguration"); // "Advanced configuration"
Form Labels
import { sentenceCase } from "text-sentence-case";
// Form field labels
sentenceCase("firstName"); // "First name"
sentenceCase("emailAddress"); // "Email address"
sentenceCase("phoneNumber"); // "Phone number"
sentenceCase("dateOfBirth"); // "Date of birth"
sentenceCase("billingAddress"); // "Billing address"
Error Messages
import { sentenceCase } from "text-sentence-case";
// Error message formatting
sentenceCase("invalidEmailFormat"); // "Invalid email format"
sentenceCase("passwordTooShort"); // "Password too short"
sentenceCase("userNotFound"); // "User not found"
sentenceCase("accessDenied"); // "Access denied"
sentenceCase("sessionExpired"); // "Session expired"
Documentation Sections
import { sentenceCase } from "text-sentence-case";
// Documentation sections
sentenceCase("apiReference"); // "Api reference"
sentenceCase("installationGuide"); // "Installation guide"
sentenceCase("migrationNotes"); // "Migration notes"
sentenceCase("performanceTips"); // "Performance tips"
sentenceCase("securityConsiderations"); // "Security considerations"
Content Processing
import { sentenceCase } from "text-sentence-case";
// Process content titles
const contentSections = [
"userManagement",
"dataVisualization",
"reportGeneration",
"systemConfiguration",
"backupAndRestore",
];
const formattedSections = contentSections.map(sentenceCase);
console.log(formattedSections);
// [
// "User management",
// "Data visualization",
// "Report generation",
// "System configuration",
// "Backup and restore"
// ]
Notification Messages
import { sentenceCase } from "text-sentence-case";
function formatNotification(type, message) {
return `${sentenceCase(type)}: ${sentenceCase(message)}`;
}
console.log(formatNotification("successMessage", "dataUpdatedSuccessfully"));
// "Success message: Data updated successfully"
console.log(formatNotification("warningAlert", "sessionWillExpireSoon"));
// "Warning alert: Session will expire soon"
Menu Item Processing
import { sentenceCase } from "text-sentence-case";
const menuItems = [
{ key: "userProfile", icon: "user" },
{ key: "accountSettings", icon: "settings" },
{ key: "billingInformation", icon: "credit-card" },
{ key: "securityOptions", icon: "shield" },
{ key: "privacySettings", icon: "lock" },
];
const formattedMenu = menuItems.map((item) => ({
...item,
label: sentenceCase(item.key),
}));
console.log(formattedMenu);
// [
// { key: "userProfile", icon: "user", label: "User profile" },
// { key: "accountSettings", icon: "settings", label: "Account settings" },
// { key: "billingInformation", icon: "credit-card", label: "Billing information" },
// { key: "securityOptions", icon: "shield", label: "Security options" },
// { key: "privacySettings", icon: "lock", label: "Privacy settings" }
// ]
Help Text Generation
import { sentenceCase } from "text-sentence-case";
function generateHelpText(fieldName, validationRule) {
const field = sentenceCase(fieldName);
const rule = sentenceCase(validationRule);
return `${field} ${rule}`;
}
console.log(generateHelpText("emailAddress", "mustBeValidFormat"));
// "Email address must be valid format"
console.log(generateHelpText("password", "mustContainSpecialCharacters"));
// "Password must contain special characters"
Status Message Processing
import { sentenceCase } from "text-sentence-case";
class StatusProcessor {
static formatStatus(status) {
return sentenceCase(status);
}
static createStatusMessage(action, status) {
const formattedAction = sentenceCase(action);
const formattedStatus = sentenceCase(status);
return `${formattedAction} ${formattedStatus}`;
}
}
console.log(StatusProcessor.formatStatus("dataProcessingComplete"));
// "Data processing complete"
console.log(StatusProcessor.createStatusMessage("fileUpload", "inProgress"));
// "File upload in progress"
๐ API Reference
sentenceCase(input, options?)
Converts a string to Sentence case format.
Parameters
input
(string
): The string to convertoptions
(Options
, optional): Configuration options
Returns
string
: The Sentence case 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[];
}
๐ง Advanced Configuration
Custom Word Splitting
import { sentenceCase } from "text-sentence-case";
// Split on specific patterns
sentenceCase("XMLHttpRequest", {
splitRegexp: /([a-z])([A-Z])/g,
}); // "Xml http request"
// Split on numbers
sentenceCase("user123data", {
splitRegexp: /([a-zA-Z])(\d)/g,
}); // "User 123 data"
Custom Character Stripping
import { sentenceCase } from "text-sentence-case";
// Strip specific characters
sentenceCase("hello@world.com", {
stripRegexp: /[@.]/g,
}); // "Hello world com"
// Strip all non-alphanumeric
sentenceCase("hello!@#world", {
stripRegexp: /[^a-zA-Z0-9]/g,
}); // "Hello world"
Custom Transform Functions
import { sentenceCase } from "text-sentence-case";
// Preserve acronyms in first position
sentenceCase("xml-http-request", {
transform: (word, index) => {
const acronyms = ["xml", "http", "api", "url", "html", "css", "js"];
if (index === 0 && acronyms.includes(word.toLowerCase())) {
return word.toUpperCase();
}
if (index === 0) {
return word.charAt(0).toUpperCase() + word.slice(1).toLowerCase();
}
return word.toLowerCase();
},
}); // "XML http request"
// Custom business logic
sentenceCase("user-v2-api", {
transform: (word, index) => {
if (index === 0) {
return word.charAt(0).toUpperCase() + word.slice(1).toLowerCase();
}
if (word === "v2") return "V2";
if (word === "api") return "API";
return word.toLowerCase();
},
}); // "User V2 API"
๐ 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-title-case
- Convert to Title Casetext-capital-case
- Convert to Capital Casetext-upper-case-first
- Make first character uppercasetext-no-case
- Convert to no 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