From 4c124a86eae5a14a7258b46a76b72cb367d9781f Mon Sep 17 00:00:00 2001 From: Nicholas Rayburn <52075362+nrayburn-tech@users.noreply.github.com> Date: Sat, 16 Nov 2024 00:53:51 -0600 Subject: [PATCH] docs(editor/vscode): Update VS Code readme with installation instructions and available features (#7306) --- editors/vscode/README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/editors/vscode/README.md b/editors/vscode/README.md index c4298105a..8bee6d1f9 100644 --- a/editors/vscode/README.md +++ b/editors/vscode/README.md @@ -2,6 +2,17 @@ The Oxidation Compiler is creating a suite of high-performance tools for JavaScript and TypeScript. +## Installation + +Any of the below options can be used to install the extension. + +- Install through the VS Code extensions marketplace by searching for `Oxc`. Verify the identifier is `oxc.oxc-vscode`. +- From within VS Code, open the Quick Open (Ctrl+P or Cmd+P on macOS) and execute `ext install oxc.oxc-vscode`. + ## Oxlint -This is the linter for oxc. +This is the linter for Oxc. The currently supported features are listed below. + +- Highlighting for warnings or errors identified by Oxlint +- Quick fixes to fix a warning or error when possible +- JSON schema validation for supported Oxlint configuration files (does not include ESLint configuration files)