UNPKG

@bevry/figures

Version:

Unicode symbols with fallbacks for older terminals. Forked to implement Bevry's best practices and maintain widespread compatibility.

169 lines (120 loc) 12.8 kB
<!-- TITLE/ --> # @bevry/figures <!-- /TITLE --> <!-- BADGES/ --> <span class="badge-githubworkflow"><a href="https://github.com/bevry/figures/actions?query=workflow%3Abevry" title="View the status of this project's GitHub Workflow: bevry"><img src="https://github.com/bevry/figures/workflows/bevry/badge.svg" alt="Status of the GitHub Workflow: bevry" /></a></span> <span class="badge-npmversion"><a href="https://npmjs.org/package/@bevry/figures" title="View this project on NPM"><img src="https://img.shields.io/npm/v/@bevry/figures.svg" alt="NPM version" /></a></span> <span class="badge-npmdownloads"><a href="https://npmjs.org/package/@bevry/figures" title="View this project on NPM"><img src="https://img.shields.io/npm/dm/@bevry/figures.svg" alt="NPM downloads" /></a></span> <br class="badge-separator" /> <span class="badge-githubsponsors"><a href="https://github.com/sponsors/balupton" title="Donate to this project using GitHub Sponsors"><img src="https://img.shields.io/badge/github-donate-yellow.svg" alt="GitHub Sponsors donate button" /></a></span> <span class="badge-thanksdev"><a href="https://thanks.dev/u/gh/bevry" title="Donate to this project using ThanksDev"><img src="https://img.shields.io/badge/thanksdev-donate-yellow.svg" alt="ThanksDev donate button" /></a></span> <span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span> <span class="badge-liberapay"><a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span> <span class="badge-buymeacoffee"><a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a></span> <span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span> <span class="badge-crypto"><a href="https://bevry.me/crypto" title="Donate to this project using Cryptocurrency"><img src="https://img.shields.io/badge/crypto-donate-yellow.svg" alt="crypto donate button" /></a></span> <span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span> <br class="badge-separator" /> <span class="badge-discord"><a href="https://discord.gg/nQuXddV7VP" title="Join this project's community on Discord"><img src="https://img.shields.io/discord/1147436445783560193?logo=discord&amp;label=discord" alt="Discord server badge" /></a></span> <span class="badge-twitch"><a href="https://www.twitch.tv/balupton" title="Join this project's community on Twitch"><img src="https://img.shields.io/twitch/status/balupton?logo=twitch" alt="Twitch community badge" /></a></span> <!-- /BADGES --> <!-- DESCRIPTION/ --> Unicode symbols with fallbacks for older terminals. Forked to implement Bevry's best practices and maintain widespread compatibility. <!-- /DESCRIPTION --> ## Usage [Complete API Documentation.](http://main.figures.bevry.surge.sh/docs/) Forked from [sindresorhus/figures](https://github.com/sindresorhus/figures) <!-- INSTALL/ --> ## Install ### [npm](https://npmjs.com "npm is a package manager for javascript") - Install: `npm install --save @bevry/figures` - Import: `import pkg from ('@bevry/figures')` - Require: `const pkg = require('@bevry/figures').default` ### [Deno](https://deno.land "Deno is a secure runtime for JavaScript and TypeScript, it is an alternative for Node.js") ``` typescript import pkg from 'https://unpkg.com/@bevry/figures@^7.6.0/edition-deno/index.ts' ``` ### [Editions](https://editions.bevry.me "Editions are the best way to produce and consume packages you care about.") This package is published with the following editions: - `@bevry/figures/source/index.ts` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") source code with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules - `@bevry/figures` aliases `@bevry/figures/edition-es2022/index.js` - `@bevry/figures/edition-es2022/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against [ES2022](https://en.wikipedia.org/wiki/ES2022 "ECMAScript 2022") for [Node.js](https://nodejs.org "Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine") 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with [Require](https://nodejs.org/dist/latest-v5.x/docs/api/modules.html "Node/CJS Modules") for modules - `@bevry/figures/edition-es2022-esm/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against [ES2022](https://en.wikipedia.org/wiki/ES2022 "ECMAScript 2022") for [Node.js](https://nodejs.org "Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine") 12 || 14 || 16 || 18 || 20 || 21 with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules - `@bevry/figures/edition-types/index.d.ts` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled Types with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules <!-- /INSTALL --> <!-- HISTORY/ --> ## History [Discover the release history by heading on over to the `HISTORY.md` file.](https://github.com/bevry/figures/blob/HEAD/HISTORY.md#files) <!-- /HISTORY --> <!-- BACKERS/ --> ## Backers ### Code [Discover how to contribute via the `CONTRIBUTING.md` file.](https://github.com/bevry/figures/blob/HEAD/CONTRIBUTING.md#files) #### Authors - [Benjamin Lupton](https://balupton.com) — Accelerating collaborative wisdom. #### Maintainers - [Benjamin Lupton](https://balupton.com) — Accelerating collaborative wisdom. #### Contributors - [Benjamin Lupton](https://github.com/balupton) — [view contributions](https://github.com/bevry/figures/commits?author=balupton "View the GitHub contributions of Benjamin Lupton on repository bevry/figures") - [Brandon Smith](https://github.com/brandon93s) — [view contributions](https://github.com/bevry/figures/commits?author=brandon93s "View the GitHub contributions of Brandon Smith on repository bevry/figures") - [Christophe Hurpeau](https://github.com/christophehurpeau) — [view contributions](https://github.com/bevry/figures/commits?author=christophehurpeau "View the GitHub contributions of Christophe Hurpeau on repository bevry/figures") - [Corey Farrell](https://github.com/coreyfarrell) — [view contributions](https://github.com/bevry/figures/commits?author=coreyfarrell "View the GitHub contributions of Corey Farrell on repository bevry/figures") - [Dimitri B.](https://github.com/BendingBender) — [view contributions](https://github.com/bevry/figures/commits?author=BendingBender "View the GitHub contributions of Dimitri B. on repository bevry/figures") - [ehmicky](https://github.com/ehmicky) — [view contributions](https://github.com/bevry/figures/commits?author=ehmicky "View the GitHub contributions of ehmicky on repository bevry/figures") - [Jannis R](https://github.com/derhuerst) — [view contributions](https://github.com/bevry/figures/commits?author=derhuerst "View the GitHub contributions of Jannis R on repository bevry/figures") - [Kevin Goslar](https://github.com/kevgo) — [view contributions](https://github.com/bevry/figures/commits?author=kevgo "View the GitHub contributions of Kevin Goslar on repository bevry/figures") - [Richard Gibson](https://github.com/gibson042) — [view contributions](https://github.com/bevry/figures/commits?author=gibson042 "View the GitHub contributions of Richard Gibson on repository bevry/figures") - [Richie Bendall](https://github.com/richienb) — [view contributions](https://github.com/bevry/figures/commits?author=richienb "View the GitHub contributions of Richie Bendall on repository bevry/figures") - [Sam Verschueren](https://github.com/SamVerschueren) — [view contributions](https://github.com/bevry/figures/commits?author=SamVerschueren "View the GitHub contributions of Sam Verschueren on repository bevry/figures") - [Sindre Sorhus](https://github.com/sindresorhus) — [view contributions](https://github.com/bevry/figures/commits?author=sindresorhus "View the GitHub contributions of Sindre Sorhus on repository bevry/figures") ### Finances <span class="badge-githubsponsors"><a href="https://github.com/sponsors/balupton" title="Donate to this project using GitHub Sponsors"><img src="https://img.shields.io/badge/github-donate-yellow.svg" alt="GitHub Sponsors donate button" /></a></span> <span class="badge-thanksdev"><a href="https://thanks.dev/u/gh/bevry" title="Donate to this project using ThanksDev"><img src="https://img.shields.io/badge/thanksdev-donate-yellow.svg" alt="ThanksDev donate button" /></a></span> <span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span> <span class="badge-liberapay"><a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span> <span class="badge-buymeacoffee"><a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a></span> <span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span> <span class="badge-crypto"><a href="https://bevry.me/crypto" title="Donate to this project using Cryptocurrency"><img src="https://img.shields.io/badge/crypto-donate-yellow.svg" alt="crypto donate button" /></a></span> <span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span> #### Sponsors - [Andrew Nesbitt](https://nesbitt.io) — Software engineer and researcher - [Balsa](https://balsa.com) — We're Balsa, and we're building tools for builders. - [Codecov](https://codecov.io) — Empower developers with tools to improve code quality and testing. - [Poonacha Medappa](https://poonachamedappa.com) - [Rob Morris](https://github.com/Rob-Morris) - [Sentry](https://sentry.io) — Real-time crash reporting for your web apps, mobile apps, and games. - [Syntax](https://syntax.fm) — Syntax Podcast #### Donors - [Andrew Nesbitt](https://nesbitt.io) - [Armen Mkrtchian](https://mogoni.dev) - [Balsa](https://balsa.com) - [Chad](https://opencollective.com/chad8) - [Codecov](https://codecov.io) - [dr.dimitru](https://veliovgroup.com) - [Elliott Ditman](https://elliottditman.com) - [entroniq](https://gitlab.com/entroniq) - [GitHub](https://github.com/about) - [Hunter Beast](https://cryptoquick.com) - [Jean-Luc Geering](https://github.com/jlgeering) - [Michael Duane Mooring](https://mdm.cc) - [Michael Harry Scepaniak](https://michaelscepaniak.com) - [Mohammed Shah](https://github.com/smashah) - [Mr. Henry](https://mrhenry.be) - [Nermal](https://arjunaditya.vercel.app) - [Pleo](https://pleo.io) - [Poonacha Medappa](https://poonachamedappa.com) - [Rob Morris](https://github.com/Rob-Morris) - [Robert de Forest](https://github.com/rdeforest) - [Sentry](https://sentry.io) - [ServieJS](https://github.com/serviejs) - [Skunk Team](https://skunk.team) - [Syntax](https://syntax.fm) - [WriterJohnBuck](https://github.com/WriterJohnBuck) <!-- /BACKERS --> <!-- LICENSE/ --> ## License Unless stated otherwise all works are: - Copyright &copy; [Benjamin Lupton](https://balupton.com) and licensed under: - [Artistic License 2.0](http://spdx.org/licenses/Artistic-2.0.html) <!-- /LICENSE -->