https://github.com/bevry/ansi
ANSI colors and styles for Deno, Node.js, JavaScript, and TypeScript
https://github.com/bevry/ansi
Last synced: 8 months ago
JSON representation
ANSI colors and styles for Deno, Node.js, JavaScript, and TypeScript
- Host: GitHub
- URL: https://github.com/bevry/ansi
- Owner: bevry
- License: other
- Created: 2020-07-21T22:56:01.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-12T16:26:16.000Z (over 1 year ago)
- Last Synced: 2024-10-30T00:55:53.273Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 378 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# @bevry/ansi
ANSI colors and styles for Deno, Node.js, JavaScript, and TypeScript
Foundations of this project were [Thorsten Lorenz's](https://github.com/thlorenz) excellent work on the early [ansistyles](https://github.com/thlorenz/ansistyles) and [ansicolors](https://github.com/thlorenz/ansicolors) packages.
## Usage
[Complete API Documentation.](http://master.ansi.bevry.surge.sh/docs/)
## Install
### [npm](https://npmjs.com "npm is a package manager for javascript")
- Install: `npm install --save @bevry/ansi`
- Import: `import * as pkg from ('@bevry/ansi')`
- Require: `const pkg = require('@bevry/ansi')`
### [Deno](https://deno.land "Deno is a secure runtime for JavaScript and TypeScript, it is an alternative for Node.js")
``` typescript
import * as pkg from 'https://unpkg.com/@bevry/ansi@^6.10.0/edition-deno/index.ts'
```
### [Skypack](https://www.skypack.dev "Skypack is a JavaScript Delivery Network for modern web apps")
``` html
import * as pkg from '//cdn.skypack.dev/@bevry/ansi@^6.10.0'
```
### [unpkg](https://unpkg.com "unpkg is a fast, global content delivery network for everything on npm")
``` html
import * as pkg from '//unpkg.com/@bevry/ansi@^6.10.0'
```
### [jspm](https://jspm.io "Native ES Modules CDN")
``` html
import * as pkg from '//dev.jspm.io/@bevry/ansi@6.10.0'
```
### [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/ansi` aliases `@bevry/ansi/index.cjs` which uses the [Editions Autoloader](https://github.com/bevry/editions "You can use the Editions Autoloader to autoload the appropriate edition for your consumers environment") to automatically select the correct edition for the consumer's environment
- `@bevry/ansi/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/ansi/edition-browsers/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against [ES2024](https://en.wikipedia.org/wiki/ES2024 "ECMAScript 2024") for web browsers with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules
- `@bevry/ansi/edition-es2024/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against [ES2024](https://en.wikipedia.org/wiki/ES2024 "ECMAScript 2024") for [Node.js](https://nodejs.org "Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine") 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 22 || 24 with [Require](https://nodejs.org/dist/latest-v5.x/docs/api/modules.html "Node/CJS Modules") for modules
- `@bevry/ansi/edition-es5/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against ES5 for [Node.js](https://nodejs.org "Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine") 4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 22 || 24 with [Require](https://nodejs.org/dist/latest-v5.x/docs/api/modules.html "Node/CJS Modules") for modules
- `@bevry/ansi/edition-es2024-esm/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against [ES2024](https://en.wikipedia.org/wiki/ES2024 "ECMAScript 2024") for [Node.js](https://nodejs.org "Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine") 12 || 14 || 16 || 18 || 20 || 22 || 24 with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules
- `@bevry/ansi/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
- `@bevry/ansi/edition-deno/index.ts` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") source code made to be compatible with [Deno](https://deno.land "Deno is a secure runtime for JavaScript and TypeScript, it is an alternative to Node.js")
## History
[Discover the release history by heading on over to the `HISTORY.md` file.](https://github.com/bevry/ansi/blob/HEAD/HISTORY.md#files)
## Backers
### Code
[Discover how to contribute via the `CONTRIBUTING.md` file.](https://github.com/bevry/ansi/blob/HEAD/CONTRIBUTING.md#files)
#### Authors
- 2020+ [Benjamin Lupton](https://balupton.com) — Accelerating collaborative wisdom.
- 2013 [Thorsten Lorenz](https://twitch.tv/thlorenz) — Open sourcerer with focus on TypeScript/JavaScript, Rust and Flutter/Dart. Thanks for your support! 🙏 ❤️
#### Maintainers
- [Benjamin Lupton](https://balupton.com) — Accelerating collaborative wisdom.
#### Contributors
- [Benjamin Lupton](https://github.com/balupton) — [view contributions](https://github.com/bevry/ansi/commits?author=balupton "View the GitHub contributions of Benjamin Lupton on repository bevry/ansi")
- [Thorsten Lorenz](https://github.com/thlorenz) — [view contributions](https://github.com/bevry/ansi/commits?author=thlorenz "View the GitHub contributions of Thorsten Lorenz on repository bevry/ansi")
### Finances
#### Sponsors
- [Andrew Nesbitt](https://nesbitt.io) — Working on mapping the world of open source software @ecosyste-ms and empowering developers with @octobox
- [Divinci ™](https://divinci.ai) — A more comfortable AI conversation experience, with friends! 🤖🖤
- [Mr. Henry](https://mrhenry.be)
- [Poonacha Medappa](https://poonachamedappa.com)
- [Roboflow](https://roboflow.com)
- [Square](https://github.com/square)
#### Donors
- [Andrew Nesbitt](https://nesbitt.io)
- [Ángel González](https://univunix.com)
- [Arjun Aditya](https://arjunaditya.xyz)
- [Armen Mkrtchian](https://mogoni.dev)
- [Balsa](https://balsa.com)
- [Canonical](https://canonical.com)
- [Chad](https://opencollective.com/chad8)
- [Codecov](https://codecov.io)
- [Divinci ™](https://divinci.ai)
- [dr.dimitru](https://veliovgroup.com)
- [Elliott Ditman](https://elliottditman.com)
- [entroniq](https://gitlab.com/entroniq)
- [Frontend Masters](https://FrontendMasters.com)
- [GitHub](https://github.com/about)
- [Hunter Beast](https://cryptoquick.com)
- [Jean-Luc Geering](https://github.com/jlgeering)
- [Lee Driscoll](https://leedriscoll.me)
- [Michael Duane Mooring](https://divinci.app)
- [Michael Harry Scepaniak](https://michaelscepaniak.com)
- [Mohammed Shah](https://github.com/smashah)
- [Mr. Henry](https://mrhenry.be)
- [Pleo](https://pleo.io)
- [Poonacha Medappa](https://poonachamedappa.com)
- [Robert de Forest](https://github.com/rdeforest)
- [Rob Morris](https://linktr.ee/recipromancer)
- [Roboflow](https://roboflow.com)
- [Scott Kempson](https://github.com/scokem)
- [Sentry](https://sentry.io)
- [ServieJS](https://github.com/serviejs)
- [Skunk Team](https://skunk.team)
- [Square](https://github.com/square)
- [Syntax](https://syntax.fm)
- [WriterJohnBuck](https://github.com/WriterJohnBuck)
## License
Unless stated otherwise all works are:
- Copyright © 2020+ [Benjamin Lupton](https://balupton.com)
- Copyright © 2013 [Thorsten Lorenz](https://twitch.tv/thlorenz)
and licensed under:
- [Artistic License 2.0](http://spdx.org/licenses/Artistic-2.0.html)