Skip to content

Commit

Permalink
A little README revamping
Browse files Browse the repository at this point in the history
  • Loading branch information
DavisVaughan committed Nov 27, 2024
1 parent 7c371d2 commit 2b49a76
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 12 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
/target

# From quarto preview
README.html
README_files
66 changes: 54 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,60 @@
- Install the Air CLI to `~/.cargo/bin` (which must be on your `PATH`):
# air

```sh
cargo install --path "crates/air"
```
[![Actions status](https://github.com/posit-dev/air/actions/workflows/test.yml/badge.svg)](https://github.com/posit-dev/air/actions)

Add a `--debug` flag if you're a developer.
> [!NOTE]
> air is currently in alpha. Expect breaking changes both in the API and in formatting results.
- Install the VS Code extension:
An R formatter and language server, written in Rust.

```sh
# The first time
npm install --global vsce
# Installation

cd editors/code && rm -rf *.vsix && vsce package && positron --install-extension *.vsix
```
Install air using our standalone installers:

Replace `positron` by `code` to install in VS Code. The CLI tools for Positron or VS Code need to be installed on your path.
```shell
# On macOS and Linux
curl -LsSf https://github.com/posit-dev/air/releases/latest/download/air-installer.sh | sh

# On Windows, using Powershell
powershell -c "irm https://github.com/posit-dev/air/releases/latest/download/air-installer.ps1 | iex"

# For a specific version
curl -LsSf https://github.com/posit-dev/air/releases/download/0.1.0/air-installer.sh | sh
powershell -c "irm https://github.com/posit-dev/air/releases/download/0.1.0/air-installer.ps1 | iex"
```

The installer scripts will automatically add air to your `PATH`. The very first time you install air, for the `PATH` modifications to be applied:

- On macOS and Linux, you'll need to restart your shell.
- On Windows, you'll need to restart your computer.

# Acknowledgements and inspiration

air draws inspiration from many sources including [roslyn](https://github.com/dotnet/roslyn), [swift](https://github.com/swiftlang/swift), [rust-analyzer](https://github.com/rust-lang/rust-analyzer), [prettier](https://github.com/prettier/prettier), [biome](https://github.com/biomejs/biome), and [ruff](https://github.com/astral-sh/ruff). These are all excellent tools that provide either formatters, language servers, or both, all of which have influenced design decisions in air.

We are particularly thankful to [biome](https://github.com/biomejs/biome), as air is built on top of their language agnostic tooling for both building a [rowan](https://github.com/rust-analyzer/rowan) syntax tree and implementing a formatter. Biome is an open source project maintained by community members, please consider [sponsoring them](https://github.com/sponsors/biomejs#sponsors).

# Developer notes

Install the dev version of the air cli with:

```sh
cargo install --path crates/air --debug
```

This installs it to `~/.cargo/bin` (which must be on your `PATH`), and can be removed with `cargo uninstall air`.

Install the dev version of the VS Code extension:

```sh
# The first time
npm install --global vsce

# Install for Positron
cd editors/code && rm -rf *.vsix && vsce package && positron --install-extension *.vsix

# Install for VS Code
cd editors/code && rm -rf *.vsix && vsce package && code --install-extension *.vsix
```

The CLI tools for Positron or VS Code need to be installed on your path using the command palette command `Shell Command: Install 'code'/'positron' command in PATH`.

0 comments on commit 2b49a76

Please sign in to comment.