Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dalisoft/oxlint-rs-npm
Linter for the JavaScript Oxidation Compiler
https://github.com/dalisoft/oxlint-rs-npm
compiler javascript linter minifier parser rust typescript
Last synced: 9 days ago
JSON representation
Linter for the JavaScript Oxidation Compiler
- Host: GitHub
- URL: https://github.com/dalisoft/oxlint-rs-npm
- Owner: dalisoft
- License: apache-2.0
- Created: 2024-04-08T12:21:46.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-10-27T00:02:20.000Z (12 days ago)
- Last Synced: 2024-10-27T01:17:53.753Z (12 days ago)
- Topics: compiler, javascript, linter, minifier, parser, rust, typescript
- Language: Shell
- Homepage: https://oxc-project.github.io
- Size: 110 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# oxlint-rs-npm
Linter for the JavaScript Oxidation Compiler
> **npm** integration for [oxlint-rs](https://github.com/oxc-project/oxc) without any overhead so using full power of `oxlint` CLI performance and feature
## Documentations
Look at [official documentation](https://github.com/oxc-project/oxc)
## Motivation
The tools inherently exhibit rapid performance, yet the `npm` `bin.js` script introduces a discernible overhead when deployed for **Rust** projects, leading to suboptimal startup times. This solution effectively addresses and eliminates this overhead, ensuring that **Rust** projects operate with the expected efficiency. For detailed insights, please refer to the pull requests [oxc#2920](https://github.com/oxc-project/oxc/pull/2920).
> 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/oxlint-rs-npm -D
# or
yarn install dalisoft/oxlint-rs-npm -D
# or
bun add dalisoft/oxlint-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