{"id":46705967,"url":"https://github.com/pppp606/ink-title-box","last_synced_at":"2026-03-09T08:11:25.928Z","repository":{"id":314433589,"uuid":"1049606758","full_name":"pppp606/ink-title-box","owner":"pppp606","description":null,"archived":false,"fork":false,"pushed_at":"2025-09-22T11:44:10.000Z","size":379,"stargazers_count":0,"open_issues_count":6,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-22T13:19:06.214Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pppp606.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-03T08:23:25.000Z","updated_at":"2025-09-22T11:44:15.000Z","dependencies_parsed_at":"2025-09-12T13:15:04.522Z","dependency_job_id":"48db279a-0664-4a47-abfe-76adf98dc105","html_url":"https://github.com/pppp606/ink-title-box","commit_stats":null,"previous_names":["pppp606/ink-title-box"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/pppp606/ink-title-box","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pppp606%2Fink-title-box","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pppp606%2Fink-title-box/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pppp606%2Fink-title-box/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pppp606%2Fink-title-box/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pppp606","download_url":"https://codeload.github.com/pppp606/ink-title-box/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pppp606%2Fink-title-box/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30287500,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-09T02:57:19.223Z","status":"ssl_error","status_checked_at":"2026-03-09T02:56:26.373Z","response_time":61,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-03-09T08:11:25.498Z","updated_at":"2026-03-09T08:11:25.917Z","avatar_url":"https://github.com/pppp606.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ink-title-box\n\nA customizable title box component for [Ink](https://github.com/vadimdemedes/ink) CLI applications that serves as a **perfect drop-in replacement** for Ink's Box component with added title embedding functionality.\n\n## 🎯 **100% Ink Box Compatibility**\n\nTitleBox is fully compatible with Ink's Box component and passes **all official Ink Box tests**:\n\n- ✅ **73 comprehensive tests** using `ink-testing-library`\n- ✅ **Complete recreation** of Ink's official test suite from `vadimdemedes/ink`\n- ✅ **Identical behavior** when no title is provided\n- ✅ **Perfect drop-in replacement** for existing Ink Box usage\n\n**Test coverage includes**: margin, gap, overflow, height, flexbox, borders, padding, dimensions, nested layouts, and all advanced Ink Box features.\n\n## Installation\n\n```bash\nnpm install ink-title-box\n```\n\n## Requirements\n\n- Node.js \u003e=18.0.0\n- React ^18.3.1\n- Ink ^4.4.1\n\n## Usage\n\n### As a CLI Tool\n\n```bash\n# Basic usage\nnpx ink-title-box \"Hello World\"\n\n# With options\nnpx ink-title-box \"My Title\" --width 60 --color green --padding 2\n```\n\n#### CLI Options\n\n- `-w, --width \u003cnumber\u003e` - Set box width (default: 40, max: 200)\n- `-p, --padding \u003cnumber\u003e` - Set box padding (default: 1, max: 10)\n- `-c, --color \u003ccolor\u003e` - Set border color (default: blue)\n- `-h, --help` - Show help message\n\n#### Valid Colors\n\n`black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`, `gray`, `grey`, `blackBright`, `redBright`, `greenBright`, `yellowBright`, `blueBright`, `magentaBright`, `cyanBright`, `whiteBright`\n\n### As a React Component\n\n```tsx\nimport React from 'react';\nimport { render } from 'ink';\nimport { TitleBox } from 'ink-title-box';\n\nconst App = () =\u003e (\n  \u003cTitleBox title='My Application' width={50} padding={2} borderColor='cyan' /\u003e\n);\n\nrender(\u003cApp /\u003e);\n```\n\n#### Component Props\n\n```typescript\ninterface TitleBoxProps {\n  title: string;\n  width?: number; // Box width (default: 40)\n  padding?: number; // Internal padding (default: 1)\n  borderColor?: string; // Border color (default: 'blue')\n}\n```\n\n## Development\n\n### Scripts\n\n```bash\nnpm run build        # Build the project\nnpm run test         # Run tests\nnpm run test:watch   # Run tests in watch mode\nnpm run lint         # Run ESLint\nnpm run format       # Format code with Prettier\nnpm run typecheck    # Run TypeScript checks\nnpm run quality      # Run all quality checks\nnpm run ci           # Run CI pipeline locally\n```\n\n### Testing\n\nThe project uses Jest with 100% test coverage:\n\n```bash\nnpm test                    # Run all tests\nnpm run test:coverage      # Run with coverage report\nnpm run test:ci           # Run in CI mode\n```\n\n### Code Quality\n\n- **TypeScript** - Strict type checking\n- **ESLint** - Code linting with TypeScript support\n- **Prettier** - Code formatting\n- **Jest** - Testing with full coverage\n\n## License\n\nMIT\n\n## Contributing\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/amazing-feature`)\n3. Run quality checks (`npm run quality`)\n4. Commit your changes (`git commit -m 'Add amazing feature'`)\n5. Push to the branch (`git push origin feature/amazing-feature`)\n6. Open a Pull Request\n\nMake sure all tests pass and maintain 100% coverage.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpppp606%2Fink-title-box","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpppp606%2Fink-title-box","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpppp606%2Fink-title-box/lists"}