# @trufflesuite/chromafi
> ๐ฆ
cli syntax highlighting: any function - any object - 176 languages
Latest version **3.0.0** (published 2022-02-14) ยท MIT license ยท 0 weekly downloads
## Install
```sh
npm install @trufflesuite/chromafi
pnpm add @trufflesuite/chromafi
yarn add @trufflesuite/chromafi
bun add @trufflesuite/chromafi
```
## Health
**Score 15/100 (F)** โ status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 3.0.0 |
| Published | 2022-02-14 |
| First published | 2019-08-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 1.8 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | F1LT3R |
| Maintainers | kevinbluer, tenthirtyone, lsqproduction, kevinweaver, leeftk, gnidan, davidmurdoch, eggplantzzz, fainashalts, haltman, rkalis, cds-amal, micaiahreid |
| Keywords | syntax, highlight, cli, color, console, terminal, language, highlight.js, chalk, object, string, function, line-numbers, 1c, abnf, accesslog, actionscript, ada, apache, applescript, arduino, armasm, asciidoc, aspectj, autohotkey, autoit, avrasm, awk, axapta, bash, basic, bnf, brainfuck, cal, capnproto, ceylon, clean, clojure-repl, clojure, cmake, coffeescript, coq, cos, cpp, crmsh, crystal, cs, csp, css, d, dart, delphi, diff, django, dns, dockerfile, dos, dsconfig, dts, dust, ebnf, elixir, elm, erb, erlang-repl, erlang, excel, fix, flix, fortran, fsharp, gams, gauss, gcode, gherkin, glsl, go, golo, gradle, groovy, haml, handlebars, haskell, haxe, hsp, htmlbars, http, hy, inform7, ini, irpf90, java, javascript, jboss-cli, json, julia-repl, julia, kotlin, lasso, ldif, leaf, less, lisp, livecodeserver, livescript, llvm, lsl, lua, makefile, markdown, mathematica, matlab, maxima, mel, mercury, mipsasm, mizar, mojolicious, monkey, moonscript, n1ql, nginx, nimrod, nix, nsis, objectivec, ocaml, openscad, oxygene, parser3, perl, pf, php, pony, powershell, processing, profile, prolog, protobuf, puppet, purebasic, python, q, qml, r, rib, roboconf, routeros, rsl, ruby, ruleslanguage, rust, scala, scheme, scilab, scss, shell, smali, smalltalk, sml, sqf, sql, stan, stata, step21, stylus, subunit, swift, taggerscript, tap, tcl, tex, thrift, tp, twig, typescript, vala, vbnet, vbscript-html, vbscript, verilog, vhdl, vim, x86asm, xl, xml, xquery, yaml, zephir |
## Links
- npm: https://www.npmjs.com/package/@trufflesuite/chromafi
- Repository: https://github.com/trufflesuite/chromafi
- Homepage: https://github.com/trufflesuite/chromafi/tree/release
- Issues: https://github.com/trufflesuite/chromafi/issues
- npm.io page: https://npm.io/package/@trufflesuite/chromafi
## Dependencies (8)
- [chalk](https://npm.io/package/chalk.md) ^2.3.2
- [cheerio](https://npm.io/package/cheerio.md) ^1.0.0-rc.2
- [camelcase](https://npm.io/package/camelcase.md) ^4.1.0
- [strip-ansi](https://npm.io/package/strip-ansi.md) ^4.0.0
- [highlight.js](https://npm.io/package/highlight.js.md) ^10.4.1
- [lodash.merge](https://npm.io/package/lodash.merge.md) ^4.6.2
- [strip-indent](https://npm.io/package/strip-indent.md) ^2.0.0
- [detect-indent](https://npm.io/package/detect-indent.md) ^5.0.0
## Alternatives
- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) โ 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) โ 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) โ 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) โ 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) โ 529.5K weekly downloads
## Recent versions
- 3.0.0 (latest) โ 2022-02-14
- 2.2.2 โ 2020-12-07
- 2.2.1 โ 2020-10-29
- 2.2.0 โ 2020-09-18
- 2.1.2 โ 2019-10-15
- 2.1.1 โ 2019-08-22
## README
# Chromafi
[](https://travis-ci.org/F1LT3R/chromafi)
[](https://coveralls.io/github/F1LT3R/chromafi?branch=master)
[](https://www.npmjs.com/package/chromafi)
[](https://github.com/sindresorhus/xo)
> ๐ฆ
cli syntax highlighting: any function - any object - 176 languages
## Fork notice
This is Truffle's customized fork of Chromafi. The original Chromafi can be found [here](https://github.com/F1LT3R/chromafi).
The differences are as follows:
1. This fork allows colors to continue across lines.
2. This fork exposes the `hljs` object as `chromafi.hljs` so that it can be modified.
3. This fork uses `lodash.merge` instead of `deepmerge` for Webpack compatibility.
4. This fork has removed the `ansi-mark` functionality and dependency.
## Support
Support the development of Chromafi by [becoming a patreon](https://patreon.com/bePatron?u=9720216).
## Features
* JavaScript objects that are logged to the console... still look like JavaScript objects.
* Chromafi highlights JavaScript functions.
* Adjust indentation for tabbed code with Chromafi.
* User defined color palettes.
* Line numbers optional.
* Padding adjustment for use with background colors or tight spaces.
* Chromafi also highlights strings of code in 176 languages.
## Usage
### Chromafi a JavaScript Object
```javascript
const chromafi = require('chromafi')
const obj = {
foo: 'bar',
baz: 1337,
qux: true,
zxc: null,
'foogle-bork': function (a, b) {
return b - a
}
}
const chromatastic = chromafi(obj)
console.log(chromatastic)
```
### Chromafi a JavaScript Function
```javascript
const chromafi = require('chromafi')
function add (a, b) {
return a + b
}
const chromantic = chromafi(add)
console.log(chromantic)
```
### Chromafi a String of Code
```javascript
const chromafi = require('chromafi')
const codeString = `
// Creates a Class based on Type
const create = (kind, parent) => {
// Create the Class based on the Type's
// Constructor or use an Anon. Func
const protoclass = kind.ctor || function () {}
// Inherit from a parent object
if (parent) {
protoclass.prototype = new Parent()
}
// Merge prototype from Class's Type
if (kind.proto) {
merge.call(protoclass.prototype, kind.proto)
}
return protoclass
}
`
const chromadactic = chromafi(codeString)
console.log(chromadactic)
```
## Options
```javascript
const chromafi = require('chromafi')
const chalk = require('chalk')
const obj = {foobar: 1337}
const options = {
lineNumberPad: 0,
codePad: 0,
indent: 2,
lineNumbers: true,
colors: {
base: chalk.bgBlack.white.bold,
line_numbers: chalk.bgCyan.black
}
}
const chromafanatic = chromafi(obj, options)
console.log(chromafanatic)
```
## Light Color Scheme
Chromafi uses [Chalk](https://github.com/chalk/chalk) to write ANSI color codes to the terminal.
```javascript
const chromafi = require('chromafi')
const chromafi = require('.')
const chalk = require('chalk')
const obj = {
foo: 'bar',
baz: 1337,
qux: true,
zxc: null,
'foogle-bork': function (a, b) {
return b - a
}
}
const chromafantastic = chromafi(obj, {
colors: {
base: chalk.bgWhite.black.bold,
keyword: chalk.red,
number: chalk.blue.dim,
function: chalk.black,
title: chalk.blue,
params: chalk.black,
string: chalk.black,
built_in: chalk.blue,
literal: chalk.blue,
attr: chalk.black,
// Just pass `chalk` to ignore colors
trailing_space: chalk,
regexp: chalk.blue,
line_numbers: chalk.bgBlue.white
}
})
console.log(chromafantastic)
```
## Highlighting Other Languages
Chromafi uses [Highlight.js](https://highlightjs.org/) to syntax highlight to your code. This means Chromafi can highlight any language that `Highlight.js` can.
Let's Chromafi some assembler syntax:
```javascript
const chromafi = require('chromafi')
const armAssemblyCode = `
.text
.global connect
connect:
mov r3, #2 ; s->sin_family = AF_INET
strh r3, [sp]
ldr r3, =server_port ; s->sin_port = server_port
ldr r3, [r3]
strh r3, [sp, #2]
ldr r3, =server_addr ; s->sin_addr = server_addr
ldr r3, [r3]
str r3, [sp, #4]
mov r3, #0 ; bzero(&s->sin_zero)
str r3, [sp, #8]
str r3, [sp, #12]
mov r1, sp ; const struct sockaddr *addr = sp
ldr r7, =connect_call
ldr r7, [r7]
swi #0
add sp, sp, #16
pop {r0} ; pop sockfd
pop {r7}
pop {fp, ip, lr}
mov sp, ip
bx lr
.data
socket_call: .long 281
connect_call: .long 283
/* all addresses are network byte-order (big-endian) */
server_addr: .long 0x0100007f ; localhost
server_port: .hword 0x0b1a
`
const chromalicious = chromafi(armAssemblyCode, {lang: 'arm'})
console.log(chromalicious)
```
## Supported Languages
> 1c, abnf, accesslog, actionscript, ada, apache, applescript, arduino, armasm, asciidoc, aspectj, autohotkey, autoit, avrasm, awk, axapta, bash, basic, bnf, brainfuck, cal, capnproto, ceylon, clean, clojure-repl, clojure, cmake, coffeescript, coq, cos, cpp, crmsh, crystal, cs, csp, css, d, dart, delphi, diff, django, dns, dockerfile, dos, dsconfig, dts, dust, ebnf, elixir, elm, erb, erlang-repl, erlang, excel, fix, flix, fortran, fsharp, gams, gauss, gcode, gherkin, glsl, go, golo, gradle, groovy, haml, handlebars, haskell, haxe, hsp, htmlbars, http, hy, inform7, ini, irpf90, java, javascript, jboss-cli, json, julia-repl, julia, kotlin, lasso, ldif, leaf, less, lisp, livecodeserver, livescript, llvm, lsl, lua, makefile, markdown, mathematica, matlab, maxima, mel, mercury, mipsasm, mizar, mojolicious, monkey, moonscript, n1ql, nginx, nimrod, nix, nsis, objectivec, ocaml, openscad, oxygene, parser3, perl, pf, php, pony, powershell, processing, profile, prolog, protobuf, puppet, purebasic, python, q, qml, r, rib, roboconf, routeros, rsl, ruby, ruleslanguage, rust, scala, scheme, scilab, scss, shell, smali, smalltalk, sml, sqf, sql, stan, stata, step21, stylus, subunit, swift, taggerscript, tap, tcl, tex, thrift, tp, twig, typescript, vala, vbnet, vbscript-html, vbscript, verilog, vhdl, vim, x86asm, xl, xml, xquery, yaml, zephir
## Credits
Thank you to the following Noun Project artists for the vectors used in the lead graphic.
- [Yoshi](https://thenounproject.com/aure7/)
- [Tom Ingebretsen](https://thenounproject.com/tomplusplus/)
- [Roussy Lucas](https://thenounproject.com/lroussy/)
- [Wira](https://thenounproject.com/wirawizinda097/)
---
_Source: https://npm.io/package/@trufflesuite/chromafi ยท Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._