Package Health Score

83 / 100

security
Security review needed
popularity
Popular
maintenance
Healthy
community
Active

Explore Similar Packages

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
8.1.0	\|	12/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
7.3.9	\|	11/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
8.0.0	\|	11/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
6.31.3	\|	08/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
6.30.2	\|	03/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Yes

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

Popular

Weekly Downloads (294,056)

GitHub Stars: 979
Forks: 76
Contributors: 60

Direct Usage Popularity

The npm package cspell receives a total of 294,056 downloads a week. As such, we scored cspell popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package cspell, we found that it has been starred 979 times.

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

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 60
Funding: Yes

With more than 10 contributors for the cspell repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 91
Open PR: 4
Last Release: 1 day ago
Last Commit: 1 day ago

Further analysis of the maintenance status of cspell based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that cspell demonstrates a positive version release cadence with at least one new version released in the past 3 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: 18 Direct
Versions: 385
Install Size: 306 kB
Dist-tags: 5
# of Files: 172
Maintainers: 1
TS Typings: Yes

cspell 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

cspell

A Spell Checker for Code!

cspell is a command line tool and library for spell checking code.

Support Future Development

Features

Spell Checks Code -- Able to spell check code by parsing it into words before checking against the dictionaries.
- Supports CamelCase, snake_case, and compoundwords naming styles.
Self contained -- does not depend upon OS libraries like Hunspell or aspell. Nor does it depend upon online services.
Fast -- checks 1000's of lines of code in seconds.
Programming Language Specific Dictionaries -- Has dedicated support for:
- JavaScript, TypeScript, Python, PHP, C#, C++, LaTex, Go, HTML, CSS, etc.
Customizable -- supports custom dictionaries and word lists.
Continuous Integration Support -- Can easily be added as a linter to Travis-CI.

cspell was initially built as the spell checking service for the spell checker extension for Visual Studio Code.

CSpell for Enterprise

Available as part of the Tidelift Subscription.

The maintainers of cspell and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. Learn more.

Installation

npm install -g cspell

Docker

There is a docker image at Packages for cspell.

cspell commands below can be run by replacing

cspell

with:

docker run -it -v $PWD:/workdir ghcr.io/streetsidesoftware/cspell:latest

Example:

docker run -it -v $PWD:/workdir ghcr.io/streetsidesoftware/cspell:latest lint --help

Basic Usage

Example: recursively spell check all JavaScript files in src

JavaScript files

cspell "src/**/*.js"
# or
cspell lint "src/**/*.js"

Check everything

cspell "**"

Git: Check Only Changed Files

 git diff --name-only | npx cspell --file-list stdin

Command: `lint` -- Spell Checking

The lint command is used for spell checking files.

Help

cspell lint --help

Options

Usage: cspell lint [options] [globs...] [file://

cspell dependencies

@cspell/cspell-json-reporter @cspell/cspell-pipe @cspell/cspell-types @cspell/dynamic-import chalk chalk-template commander cspell-gitignore cspell-glob cspell-io cspell-lib fast-glob fast-json-stable-stringify file-entry-cache get-stdin semver strip-ansi vscode-uri

cspell development dependencies

@types/file-entry-cache @types/glob @types/micromatch @types/semver micromatch minimatch

FAQs

What is cspell?

A Spelling Checker for Code!. Visit Snyk Advisor to see a full health score report for cspell, including popularity, security, maintenance & community analysis.

Is cspell popular?

The npm package cspell receives a total of 294,056 weekly downloads. As such, cspell popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is cspell well maintained?

We found that cspell demonstrated a healthy version release cadence and project activity. It has a community of 60 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is cspell safe to use?

While scanning the latest version of cspell, we found that a security review is needed. A total of 1 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 1 December-2023, at 18:50 (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