{"id":31556088,"url":"https://github.com/moh3n9595/persian-figlet","last_synced_at":"2025-10-04T22:48:39.907Z","repository":{"id":305331791,"uuid":"1020006260","full_name":"moh3n9595/persian-figlet","owner":"moh3n9595","description":"A Figlet-style ASCII art renderer for Persian (Farsi) text with full contextual character shaping and RTL support.","archived":false,"fork":false,"pushed_at":"2025-07-21T13:43:42.000Z","size":1569,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-29T13:16:11.751Z","etag":null,"topics":["ascii-art","farsi","figlet","persian","unicode"],"latest_commit_sha":null,"homepage":"https://persian-figlet.vercel.app","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/moh3n9595.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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}},"created_at":"2025-07-15T07:44:36.000Z","updated_at":"2025-07-26T12:08:03.000Z","dependencies_parsed_at":"2025-07-19T17:07:22.752Z","dependency_job_id":"528beff0-ce7e-401a-8eac-96f69fc9142c","html_url":"https://github.com/moh3n9595/persian-figlet","commit_stats":null,"previous_names":["moh3n9595/persian-figlet"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/moh3n9595/persian-figlet","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moh3n9595%2Fpersian-figlet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moh3n9595%2Fpersian-figlet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moh3n9595%2Fpersian-figlet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moh3n9595%2Fpersian-figlet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/moh3n9595","download_url":"https://codeload.github.com/moh3n9595/persian-figlet/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moh3n9595%2Fpersian-figlet/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278386121,"owners_count":25978109,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-04T02:00:05.491Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["ascii-art","farsi","figlet","persian","unicode"],"created_at":"2025-10-04T22:48:38.773Z","updated_at":"2025-10-04T22:48:39.895Z","avatar_url":"https://github.com/moh3n9595.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./images/logo.png\" alt=\"Banner\" width=\"20%\"\u003e\n\u003cp\u003e\n\u003ch1 align=\"center\"\u003ePersian Figlet\u003c/h1\u003e\n\u003cp align=\"center\"\u003eA Figlet-style ASCII art renderer for Persian (Farsi) text with full contextual character shaping and RTL support.\u003c/p\u003e\n\u003cdiv align=\"center\"\u003e\n\n![CI/CD](https://github.com/moh3n9595/persian-figlet/actions/workflows/build.yml/badge.svg) ![Vercel Deploy](https://deploy-badge.vercel.app/vercel/persian-figlet?name=website)\n[![CodeCov](https://codecov.io/gh/moh3n9595/persian-figlet/graph/badge.svg?token=WN2WK8QQMJ)](https://codecov.io/gh/moh3n9595/persian-figlet) [![CodeFactor](https://www.codefactor.io/repository/github/moh3n9595/persian-figlet/badge)](https://www.codefactor.io/repository/github/moh3n9595/persian-figlet)\n[![NPM](https://img.shields.io/npm/v/persian-figlet.svg)](https://www.npmjs.com/package/persian-figlet)\n[![Size](https://badgen.net/bundlephobia/min/persian-figlet)](https://bundlephobia.com/result?p=persian-figlet@latest)\n[![GitHub contributors](https://img.shields.io/github/contributors/moh3n9595/persian-figlet.svg)](https://GitHub.com/moh3n9595/persian-figlet/contributors/)\n[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/moh3n9595/persian-figlet/blob/master/LICENSE)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-orange.svg)](https://github.com/moh3n9595/persian-figlet/compare)\n[![Prettier](https://img.shields.io/badge/prettier-1A2C34?logo=prettier\u0026logoColor=F7BA3E)](https://github.com/prettier/prettier)\n[![EsLint](https://badges.aleen42.com/src/eslint.svg)](https://eslint.org/)\n[![TS](https://badges.aleen42.com/src/typescript.svg)](https://www.typescriptlang.org/)\n\n\u003c/div\u003e\n\n## 🌐 Try it Online\n\n**[🚀 Live Demo - Persian Figlet Web Tool](https://persian-figlet.vercel.app)**\n\nExperience Persian Figlet directly in your browser with our interactive web tool.\n\n## ✨ Features\n\n- 💻 **CLI Tool**: Command-line interface for terminal usage with colors and file output\n- 🎨 **Multiple Font Styles**: Standard and Slim fonts with distinct visual characteristics\n- 🔤 **Complete Persian Support**: All Persian chars with proper contextual forms\n- ↔️ **Kerning System**: Intelligent character spacing with overlap support for authentic Persian typography\n- 🔗 **Smart Char Connection**: Automatic handling of char joining rules\n- 📝 **TypeScript Support**: Full type definitions and IntelliSense support\n- 🎯 **Easy to Use**: Simple API with sensible defaults\n- 🧪 **Well Tested**: Comprehensive test coverage\n- 📦 **Zero Dependencies**: Lightweight and self-contained\n\n## ⚙️ Installation\n\n```bash\nnpm install persian-figlet\n```\n\n```bash\nyarn add persian-figlet\n```\n\n## 📖 Usage\n\n### Command Line Interface (CLI)\n\n#### Basic Usage\n```bash\n# Basic text conversion\npersian-figlet \"سلام دنیا\"\n```\n\n#### Advanced CLI Options\n```bash\n# With colors\npersian-figlet \"تست\" --color red\npersian-figlet \"فارسی\" -c blue\n\n# Font selection\npersian-figlet \"متن\" --font standard\npersian-figlet \"نمونه\" -f standard\n\n# Output to file\npersian-figlet \"ذخیره\" --output output.txt\npersian-figlet \"فایل\" -o result.txt\n\n# List available fonts\npersian-figlet --list-fonts\n\n# Show library information\npersian-figlet --info\n```\n\n#### CLI Colors\nAvailable colors: `red`, `green`, `blue`, `yellow`, `magenta`, `cyan`, `white`\n\n#### Pipe Usage\n```bash\n# Using with pipes\necho \"پایپ\" | xargs persian-figlet\npersian-figlet \"رنگی\" -c green | less\n\n# Save colored output\npersian-figlet \"رنگی\" -c red \u003e colored-output.txt\n```\n\n#### CLI Help\n```bash\npersian-figlet --help\npersian-figlet -v  # version\n```\n\n### JavaScript/TypeScript Library\n\n#### Basic Usage\n\n```typescript\nimport { print, FontStyle } from 'persian-figlet';\n\n// Basic usage with default font\nprint('سلام دنیا');\n\n// Using different fonts\nprint('سلام دنیا', { font: FontStyle.STANDARD });\n\n// Silent mode (no console output)\nconst result = print('سلام دنیا', { silent: true });\nconsole.log(result);\n```\n\n### Example Output\n\n```\nprint('تست');\n```\n\nWill output beautiful ASCII art representation of the Persian text \"تست\".\n\n```                     \n    █ █                 █ █ \n                        \n█         █   █   █   █    █\n████████████████████████████\n```\n\n## 🚀 Roadmap \u0026 Future Work\n\n1. **Add \u0026 Create More Fonts**  \n   - Design “Slim”, “Rounded” or “Shadow” variations  \n   - Allow community‑contributed font packs via a simple JSON schema\n\n2. **Ligature \u0026 Diacritic Support**  \n   - Render optional diacritics above/below base chars\n  \n3. **Interactive Playground \u0026 Live Preview**  \n   - Web demo to type in Persian and see instant Figlet output  \n   - Let users tweak spacing, font, and colors in real time  \n\n## 🙋 Contributing\n\nFor help on setting up the repo locally, building, testing, and contributing\nplease see [CONTRIBUTING.md](https://github.com/moh3n9595/persian-figlet/blob/master/CONTRIBUTING.md).\n\n## 🧑‍💻 Code of Conduct\n\nAll developers who wish to contribute through code or issues, take a look at the\n[CODE_OF_CONDUCT.md](https://github.com/moh3n9595/persian-figlet/blob/master/CODE_OF_CONDUCT.md).\n\n## 📃 License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](https://github.com/moh3n9595/persian-figlet/blob/master/LICENSE) file for details.\n\n## 🙏 Acknowledgments\n\n- Inspired by the classic Figlet tool\n- Built with love for the Persian language community\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoh3n9595%2Fpersian-figlet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmoh3n9595%2Fpersian-figlet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoh3n9595%2Fpersian-figlet/lists"}