Skip to content

AGENTS.md

Latest commit

 

History

History
73 lines (54 loc) · 2.7 KB

AGENTS.md

File metadata and controls

73 lines (54 loc) · 2.7 KB
Raw

AI Agent Instructions for capstring

Overview

capstring is a lightweight JavaScript library for text capitalization and transformation. Zero dependencies, many styles, Unicode and emoji safe, ships a CLI and TypeScript types.

Quick Start

import capstring, { capstringAll } from 'capstring';

capstring('hello world', 'title');     // 'Hello World'
capstring('XMLHttpRequest', 'kebab');  // 'xml-http-request'
capstring('hello world', 'slug');      // 'hello-world'
capstringAll('hi').upper;              // 'HI'
npx capstring kebab "Hello World"      # hello-world
echo hi | npx capstring --all          # every style

API

capstring(str, style = 'same', { strict = false } = {})
  • str - String to transform
  • style - Style name (default: 'same')
  • strict - Throw TypeError / RangeError instead of returning false / the input
  • Returns: Transformed string; '' for empty input; false if str is not a string
import { capstringAll, getStyles, isValidStyle, STYLES, CATEGORIES } from 'capstring';

capstringAll('hi');     // { same: 'hi', none: '', ... } in STYLES order
getStyles();            // fresh copy of STYLES
isValidStyle('kebab');  // true
STYLES;                 // frozen array of all style names
CATEGORIES;             // frozen { case, code, fun, encoding, art }

All Styles

Category Styles
case same, none, proper, title, sentence, upper, lower, swap, capitalize, lowerfirst
code camel, pascal, snake, kebab, slug, constant, python, dot, path, train, hashtag, acronym, ada, cobol, initials
fun reverse, sponge, mock, alternate, crazy, random, clap, piglatin, spaced, squish, nato
encoding leet, rot13, morse, binary, hex, base64
art flip, smallcaps, bubble, wide, strike, bold, italic, script

Files

  • index.js - the whole library. Must stay browser-safe: no node: imports, no process.
  • cli.js - CLI logic as main(argv, io); bin/capstring.js is the executable shim.
  • index.d.ts - hand-written types. test/types.test.js fails if the Style union drifts from STYLES.

Website and API

  • web/ - playground, web/docs/ Developer Docs (Swagger API Reference is served at /api by the function); imports ./capstring.js (copied from index.js at Netlify build time)
  • netlify/functions/api.js - HTTP API at https://capstring.netlify.app/api (transform, all, batch, spell, count, lorem, badge, styles; json/txt/html/xml/yaml/csv/jsonp)
  • npm run dev runs both locally on http://localhost:8888

Testing

npm test              # Run tests
npm run lint          # Run linter
npm run test:coverage # Coverage report (100% thresholds enforced)