Package Health Score

66 / 100

security
Security review needed
popularity
Small
maintenance
Sustainable
community
Sustainable

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
13.1.0	\|	06/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
13.0.0	\|	04/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
12.1.5	\|	03/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
11.0.0	\|	03/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
10.14.4	\|	02/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

ISC

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (2,830)

GitHub Stars: 6
Forks: 3
Contributors: 10

Direct Usage Popularity

The npm package @readme/syntax-highlighter receives a total of 2,830 downloads a week. As such, we scored @readme/syntax-highlighter popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package @readme/syntax-highlighter, we found that it has been starred 6 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 10
Funding: No

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 0
Open PR: 0
Last Release: 6 months ago
Last Commit: 20 days ago

Further analysis of the maintenance status of @readme/syntax-highlighter based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that @readme/syntax-highlighter demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=18

Age: 7 years
Dependencies: 4 Direct
Versions: 121
Install Size: 610 kB
Dist-tags: 1
# of Files: 26
Maintainers: 13
TS Typings: No

@readme/syntax-highlighter has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

@readme/syntax-highlighter

ReadMe's React-based syntax highlighter based on CodeMirror and react-codemirror2

Installation

npm install --save @readme/syntax-highlighter

Usage

Read Only Mode

const syntaxHighlighter = require('@readme/syntax-highlighter');
const ele = syntaxHighlighter('console.log("Hello, world!");', 'js');

Read Only with Line Numbers

const syntaxHighlighter = require('@readme/syntax-highlighter');
const ele = syntaxHighlighter('console.log("Hello, world!");', 'js', { ...opts, highlightMode: true });

Read Only with Line Numbers and Highlighted Ranges

const syntaxHighlighter = require('@readme/syntax-highlighter');
const ele = syntaxHighlighter('console.log("Hello, world!");', 'js', {
  ...opts,
  highlightMode: true,
  ranges: [
    [
      { ch: 0, line: 0 },
      { ch: 0, line: 1 },
    ],
  ],
});

Full CodeMirror

Access to a full code Mirror instance. See configuration settings in the react-codemirror2 library

const syntaxHighlighter = require('@readme/syntax-highlighter');
const ele = syntaxHighlighter('console.log("Hello, world!");', 'js', { ...opts, editable: true }, { ...editorProps });

Available Options

Name	Type	Description
`customTheme`	String	Highlighting theme. One of `neo`, `material-palenight`, or `tomorrow-night`. (Setting this will override the `dark` mode option.)
`dark`	Boolean	Enable dark mode.
`editable`	Boolean	Enable the full CodeMirror instance
`highlightMode`	Boolean	Enable line number display.
`inline`	String	Wrap code in a `<span>` tag, instead of a `<div>`.
`ranges`	Array	Ranges of line numbers to apply highlighting to. Requires `highlightMode` enabled
`tokenizeVariables`	Boolean	Match and render ReadMe variables in your markdown.

Languages Supported

Language	Available language mode(s)
ASP.NET	`asp`, `aspx`
C	`c`
C++	`c++`, `cpp`, `cplusplus`
C#	`cs`, `csharp`
Clojure	`clj`, `cljc`, `cljx`, `clojure`
CSS	`css`, `less`, `sass`, `scss`, `styl`, `stylus`
cURL	`curl`
D	`d`
Dart	`dart`
Docker	`dockerfile`
Erlang	`erl`, `erlang`
Go	`go`
GraphQL	`gql`, `graphql`
Groovy	`gradle`, `groovy`
Handlebars	`handlebars`, `hbs`
HTML/XML	`html`, `xhtml`, `xml`
HTTP	`http`
Java	`java`
JavaScript	`coffeescript`, `ecmascript`, `javascript`, `js`, `jsx`, `node`
JSON	`json`
Julia	`jl`, `julia`
Kotlin	`kotlin`, `kt`
Liquid	`liquid`
Markdown	`markdown`
Objective-C	`objc`, `objectivec`,
Objective-C++	`objc++`, `objcpp`, `objectivecpp`, `objectivecplusplus`,
OCaml	`ocaml`, `ml`
Perl	`perl`, `pl`
PHP	`php`
PowerShell	`powershell`, `ps1`
Python	`py`, `python`
R	`r`
React	`jsx`
Ruby	`jruby`, `macruby`, `rake`, `rb`, `rbx`, `ruby`
Rust	`rs`, `rust`
Scala	`scala`
Shell	`bash`, `sh`, `shell`, `zsh`
SQL	`cql`, `mssql`, `mysql`, `plsql`, `postgres`, `postgresql`, `pgsql`, `sql`, `sqlite`
Swift	`swift`
TOML	`toml`
TypeScript	`ts`, `typescript`
YAML	`yaml`, `yml`

@readme/syntax-highlighter dependencies

codemirror prop-types react-codemirror2 codemirror-graphql

FAQs

What is @readme/syntax-highlighter?

ReadMe's React-based syntax highlighter. Visit Snyk Advisor to see a full health score report for @readme/syntax-highlighter, including popularity, security, maintenance & community analysis.

Is @readme/syntax-highlighter popular?

The npm package @readme/syntax-highlighter receives a total of 2,830 weekly downloads. As such, @readme/syntax-highlighter popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @readme/syntax-highlighter well maintained?

We found indications that @readme/syntax-highlighter maintenance is sustainable demonstrating some project activity. We saw a total of 10 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @readme/syntax-highlighter safe to use?

While scanning the latest version of @readme/syntax-highlighter, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 15 December-2024, at 13:26 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

@readme/syntax-highlighter

ReadMe's React-based syntax highlighter For more information about how to use this package see README

Ensure you're using the healthiest npm packages

Package Health Score

Security

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Popularity

Weekly Downloads (2,830)

Direct Usage Popularity

Community

Embed Package Health Score Badge

Maintenance

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Package

Readme

@readme/syntax-highlighter

Installation

Usage

Read Only Mode

Read Only with Line Numbers

Read Only with Line Numbers and Highlighted Ranges

Full CodeMirror

Available Options

Languages Supported

@readme/syntax-highlighter dependencies

@readme/syntax-highlighter development dependencies

FAQs

What is @readme/syntax-highlighter?

Is @readme/syntax-highlighter popular?

Is @readme/syntax-highlighter well maintained?

Is @readme/syntax-highlighter safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (2,830)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

@readme/syntax-highlighter

Installation

Usage

Read Only Mode

Read Only with Line Numbers

Read Only with Line Numbers and Highlighted Ranges

Full CodeMirror

Available Options

Languages Supported

@readme/syntax-highlighter dependencies

@readme/syntax-highlighter development dependencies

FAQs

What is @readme/syntax-highlighter?

Is @readme/syntax-highlighter popular?

Is @readme/syntax-highlighter well maintained?

Is @readme/syntax-highlighter safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues