Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dalisoft/typos-rs-npm
Source code spell checker
https://github.com/dalisoft/typos-rs-npm
cli code-quality rust spell-checker
Last synced: about 1 month ago
JSON representation
Source code spell checker
- Host: GitHub
- URL: https://github.com/dalisoft/typos-rs-npm
- Owner: dalisoft
- License: apache-2.0
- Created: 2024-04-21T21:08:02.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-10-24T00:28:53.000Z (3 months ago)
- Last Synced: 2024-10-24T14:37:10.013Z (3 months ago)
- Topics: cli, code-quality, rust, spell-checker
- Language: JavaScript
- Homepage: https://github.com/crate-ci/typos
- Size: 40 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# typos-rs-npm
Source code spell checker
> **npm** integration for [typos-rs](https://github.com/crate-ci/typos) without any overhead so using full power of `typos-rs` CLI performance and feature
## Documentations
Look at [official documentation](https://github.com/crate-ci/typos)
## Motivation
> This package is specifically designed for direct Command-Line Interface (CLI) interaction or as an extension for Visual Studio Code.
### The functionality for npx or bunx is not included and is not anticipated to be incorporated in the future
## How this is fast?
This project leverages the [binary2npm](https://github.com/dalisoft/binary2npm) utility to streamline the acquisition of platform-specific binaries. The binaries provided by the author are highly optimized, surpassing the performance of the traditional **Node.js** `bin.js` approach. By invoking the binaries directly, we circumvent unnecessary overhead, resulting in significantly reduced startup times and enhanced efficiency.
## Installation
```sh
npm install dalisoft/typos-rs-npm -D
# or
yarn install dalisoft/typos-rs-npm -D
# or
bun add dalisoft/typos-rs-npm -D
```
## Environment variables
| Name | Description | Required |
| -------------- | ----------------------------------------------------------------------------------------------- | -------- |
| `GITHUB_TOKEN` | For [GitHub API](https://docs.github.com/rest/overview/resources-in-the-rest-api#rate-limiting) | Yes |
## Usage
See [Documentations](#documentations), requires [Environment variables](#environment-variables)
## License
Apache-2.0