mirror of
https://github.com/danbulant/oxc
synced 2026-05-24 12:21:58 +00:00
48 lines
2 KiB
Markdown
48 lines
2 KiB
Markdown
<p align="center">
|
|
<img alt="OXC Logo" src="https://raw.githubusercontent.com/oxc-project/oxc-assets/main/preview-universal.png" width="600">
|
|
</p>
|
|
|
|
<div align="center">
|
|
|
|
[![MIT licensed][license-badge]][license-url]
|
|
[![Build Status][ci-badge]][ci-url]
|
|
[![Code Coverage][code-coverage-badge]][code-coverage-url]
|
|
[![Sponsors][sponsors-badge]][sponsors-url]
|
|
|
|
[![Discord chat][discord-badge]][discord-url]
|
|
[![Playground][playground-badge]][playground-url]
|
|
|
|
[discord-badge]: https://img.shields.io/discord/1079625926024900739?logo=discord&label=Discord
|
|
[discord-url]: https://discord.gg/9uXCAwqQZW
|
|
[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg
|
|
[license-url]: https://github.com/oxc-project/oxc/blob/main/LICENSE
|
|
[ci-badge]: https://github.com/oxc-project/oxc/actions/workflows/ci.yml/badge.svg?event=push&branch=main
|
|
[ci-url]: https://github.com/oxc-project/oxc/actions/workflows/ci.yml?query=event%3Apush+branch%3Amain
|
|
[npm-badge]: https://img.shields.io/npm/v/oxlint/latest?color=brightgreen
|
|
[npm-url]: https://www.npmjs.com/package/oxlint/v/latest
|
|
[code-size-badge]: https://img.shields.io/github/languages/code-size/oxc-project/oxc
|
|
[code-size-url]: https://github.com/oxc-project/oxc
|
|
[code-coverage-badge]: https://codecov.io/github/oxc-project/oxc/branch/main/graph/badge.svg
|
|
[code-coverage-url]: https://codecov.io/gh/oxc-project/oxc
|
|
[sponsors-badge]: https://img.shields.io/github/sponsors/Boshen
|
|
[sponsors-url]: https://github.com/sponsors/Boshen
|
|
[playground-badge]: https://img.shields.io/badge/Playground-blue?color=9BE4E0
|
|
[playground-url]: https://oxc-playground.netlify.app
|
|
|
|
</div>
|
|
|
|
# ⚓ Oxc
|
|
|
|
The Oxidation Compiler is creating a suite of high-performance tools for JavaScript and TypeScript.
|
|
|
|
## Oxlint
|
|
|
|
This is the linter for oxc.
|
|
|
|
See [usage instructions](https://oxc.rs/docs/guide/usage/linter.html).
|
|
|
|
Run
|
|
|
|
- `npx --yes oxlint@latest` in your JavaScript / TypeScript codebase and see it complete in milliseconds. No configurations are required.
|
|
- `npx oxlint@latest --help` for quick usage instructions.
|
|
- `npx oxlint@latest --rules` for the list of rules.
|