npmpackage.info

Gathering detailed insights and metrics for cli-highlight

Other packages similar to cli-highlight

cli-width

4.1.0

Get stdout window width, with two fallbacks, tty and then a default.

cli-cursor

5.0.0

Toggle the CLI cursor

webpack-cli

5.1.4

CLI for webpack & friends

cli-highlighter

1.0.1

A fork of cli-highlight

Gathering detailed insights and metrics for cli-highlight

cli-highlight

Syntax highlighting for your terminal 💻✨

2.1.11

308

ISC

TypeScript

472,016,172 3

Installations

npm install cli-highlight

Pull Requests

Open

20

Total

144

Closed

91

Merged

33

Issues

Open

10

Total

29

Closed

19

Releases

v2.1.11

Published on 28 Mar 2021

v2.1.10

Published on 08 Jan 2021

v2.1.9

Published on 01 Dec 2020

v2.1.8

Published on 21 Nov 2020

v2.1.7

Published on 21 Nov 2020

v2.1.6

Published on 21 Nov 2020

View all 16 releases

Developer

felixfbecker

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=8.0.0

Typescript Support

Yes

Node Version

14.15.1

NPM Version

6.14.9 Statistics

308 Stars

112 Commits

31 Forks

8 Watching

46 Branches

8 Contributors

Updated on 31 Oct 2024

Languages

TypeScript (72.42%)

1C Enterprise (9.17%)

Groovy (4.93%)

Zephir (3.66%)

Hy (3.4%)

XQuery (2.38%)

Scheme (2.29%)

Shell (0.8%)

HTML (0.59%)

JavaScript (0.36%)

Total Downloads

Cumulative downloads

Total Downloads

472,016,172

Last day

-7.3%

719,839

Compared to previous day

Last week

3.8%

3,868,152

Compared to previous week

Last month

14.8%

16,121,456

Compared to previous month

Last year

32.2%

141,442,035

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

cli-highlight

Syntax highlighting in your terminal

node

Example

Example Output

CLI Usage

Output a file

1$ highlight package.json

Color output of another program with piping. Example: A database migration script that logs SQL Queries

1$ db-migrate --dry-run | highlight

Command line options:

1Usage: highlight [options] [file]
2
3Outputs a file or STDIN input with syntax highlighting
4
5Options:
6  --language, -l  Set the langugage explicitely
7                  If omitted will try to auto-detect
8  --theme, -t     Use a theme defined in a JSON file
9  --version, -v   Show version number                                   [boolean]
10  --help, -h      Show help                                             [boolean]

Programmatic Usage

You can use this module programmatically to highlight logs of your Node app. Example:

1const highlight = require('cli-highlight').highlight
2const Sequelize = require('sequelize')
3
4const db = new Sequelize(process.env.DB, {
5  logging(log) {
6    console.log(highlight(log, {language: 'sql', ignoreIllegals: true}))
7  }
8})

Detailed API documenation can be found here.

Themes

You can write your own theme in a JSON file and pass it with --theme. The key must be one of the highlight.js CSS class names or "default", and the value must be one or an array of Chalk styles to be applied to that token.

1{
2  "keyword": "blue",
3  "built_in": ["cyan", "dim"],
4  "string": "red",
5  "default": "gray"
6}

The style for "default" will be applied to any substrings not handled by highlight.js. The specifics depend on the language but this typically includes things like commas in parameter lists, semicolons at the end of lines, etc.

The theme is combined with the default theme. The default theme is still not colored a lot or optimized for many languages, PRs welcome!

Supported Languages

All languages of highlight.js are supported. Check a CI build for examples of all the different languages and their highlighting.

Contributing

The module is written in TypeScript and can be compiled with npm run build. npm run watch starts tsc in watch mode. Tests are written with mocha.

Improving language support is done by adding more colors to the tokens in the default theme and writing more tests.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

2

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

64 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-7wwv-vh3v-89cq
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-4r62-v4vq-hr96
Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-px4h-xg32-q955
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-x2pg-mjhr-2m5x
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx
Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-29xr-v42j-r956
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

3

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to cli-highlight

cli-highlight

Installations

Pull Requests

20

144

91

33

Issues

10

29

19

Releases

Developer

Developer Guide

CommonJS

>=8.0.0

Yes

14.15.1

6.14.9

Statistics

Languages

Total Downloads

472,016,172

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

cli-highlight

Example

CLI Usage

Programmatic Usage

Themes

Supported Languages

Contributing

10

10

10

2

1

0

0

0

0

0

0

0

3

/10

Other packages similar to cli-highlight