Skip to content

Commit

Permalink
Update README.md (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
andreluiz901 committed Feb 14, 2024
1 parent 51ac65a commit 85a2810
Showing 1 changed file with 38 additions and 33 deletions.
71 changes: 38 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
[Biome](https://biomejs.dev/) is a powerful tool designed to enhance your development experience. This plugin integrates
seamlessly with many [JetBrains IDE's](#Supported IDEs) to provide some capabilities:
# Biome - IntelliJ Plugin

- See lints while you type
- Apply code fixes (from mouse-over,<kbd title="Option">⌥</kbd>+<kbd title="Enter">⏎</kbd>or<kbd title="Alt">
Alt</kbd>+<kbd title="Enter">Enter</kbd>)
- Reformat your code with<kbd>⌥⇧</kbd>+<kbd title="Cmd">⌘</kbd>+<kbd title="L">L</kbd>or<kbd title="Ctrl">
Ctrl</kbd>+<kbd title="Alt">Alt</kbd>+<kbd title="L">L</kbd> (You can also format
your [code on save](https://www.jetbrains.com/help/webstorm/reformat-and-rearrange-code.html#reformat-on-save))
[![IntelliJ IDEA Ultimate Version](https://img.shields.io/badge/IntelliJ%20IDEA%20Ultimate-2023.2.2-374151.svg?labelcolor=000&logo=intellij-idea&labelColor=black)](https://www.jetbrains.com/idea/)
[![WebStorm Version](https://img.shields.io/badge/WebStorm-2023.2.2-1F3263.svg?labelcolor=000&logo=webstorm&labelColor=black)](https://www.jetbrains.com/webstorm/)
[![AppCode Version](https://img.shields.io/badge/AppCode-2023.2.2-2380B0.svg?labelcolor=000&logo=appcode&labelColor=black)](https://www.jetbrains.com/objc/)
[![PhpStorm Version](https://img.shields.io/badge/PhpStorm-2023.2.2-953D8C.svg?labelcolor=000&logo=phpstorm&labelColor=black)](https://www.jetbrains.com/phpstorm/)
[![RubyMine Version](https://img.shields.io/badge/RubyMine-2023.2.2-A11523.svg?labelcolor=000&logo=ruby&labelColor=black)](https://www.jetbrains.com/ruby/)

However, please note the following limitations:
[Biome](https://biomejs.dev/) is a powerful tool designed to enhance your development experience.
This plugin integrates seamlessly with many [JetBrains IDE's](#supported-ides) to provide the following capabilities.

- Automatically applying code fixes on save
- 💡 See lints while you type
- 👨‍💻 Apply code fixes
- 🚧 Reformat your code
- 💾 Automatically applying code fixes on save

## Installation

To install the Biome IntelliJ Plugin, Head over
to [official plugin page](https://plugins.jetbrains.com/plugin/22761-biome) or follow these steps:
To install the Biome IntelliJ plugin, head over to the [official plugin page](https://plugins.jetbrains.com/plugin/22761-biome) or follow these steps:

### From JetBrains IDEs

Expand All @@ -28,37 +29,41 @@ to [official plugin page](https://plugins.jetbrains.com/plugin/22761-biome) or f

### From disk

1. Download the plugin .zip from releases tab.
2. Press `⌘Сmd,` to open the IDE settings and then select Plugins.
3. On the Plugins page, click The Settings button and then click Install Plugin from Disk….
1. Download the plugin .zip from the *releases* tab.
2. Press <kbd>⌘Cmd + ,</kbd> to open the IDE settings and then select *Plugins*.
3. On the Plugins page, click the *Settings* button and then click *Install Plugin from Disk…*.

## Biome Resolution
## Getting Started
### Biome Resolution

The Plugin tries to use Biome from your project’s local dependencies (`node_modules/.bin/biome`). We recommend adding
Biome as a project dependency to ensure that NPM scripts and the extension use the same Biome version.
The plugin tries to use Biome from your project’s local dependencies (`node_modules/.bin/biome`). We recommend adding Biome as a project dependency to ensure that NPM scripts and the extension use the same Biome version.

You can also explicitly specify the`Biome`binary the extension should use by configuring the`Biome CLI Path`
in `Settings`->`Language & Frameworks`->`Biome Settings`.
You can also explicitly specify the `biome` binary the extension should use by configuring the `Biome CLI Path` in `Settings`->`Language & Frameworks`->`Biome Settings`.

## Plugin settings
### Plugin settings

### `Biome CLI Path`
#### `Biome CLI Path`

This setting overrides the Biome binary used by the plugin.

## Supported IDEs
### Supported IDEs

This plugin is currently supported in the following IDEs:

- IntelliJ IDEA Ultimate >2023.2.2
- WebStorm >2023.2.2
- AppCode >2023.2.2
- PhpStorm >2023.2.2
- RubyMine >2023.2.2
- [![IntelliJ IDEA Ultimate Version](https://img.shields.io/badge/IntelliJ%20IDEA%20Ultimate-2023.2.2-374151.svg?labelcolor=000&logo=intellij-idea&labelColor=black)](https://www.jetbrains.com/idea/)

- [![WebStorm Version](https://img.shields.io/badge/WebStorm-2023.2.2-1F3263.svg?labelcolor=000&logo=webstorm&labelColor=black)](https://www.jetbrains.com/webstorm/)

## Contributing
- [![AppCode Version](https://img.shields.io/badge/AppCode-2023.2.2-2380B0.svg?labelcolor=000&logo=appcode&labelColor=black)](https://www.jetbrains.com/objc/)

We welcome contributions to the Biome IntelliJ Plugin. If you encounter any issues or have suggestions for improvements,
please open an issue on our [GitHub repository](https://github.com/biomejs/biome/issues/new/choose). We also have
a [Discord community](https://discord.gg/BypW39g6Yc) where you can discuss the plugin, ask questions, and connect with
other Biome's developers.
- [![PhpStorm Version](https://img.shields.io/badge/PhpStorm-2023.2.2-953D8C.svg?labelcolor=000&logo=phpstorm&labelColor=black)](https://www.jetbrains.com/phpstorm/)

- [![RubyMine Version](https://img.shields.io/badge/RubyMine-2023.2.2-A11523.svg?labelcolor=000&logo=ruby&labelColor=black)](https://www.jetbrains.com/ruby/)

## Usage

Biome CLI comes with many commands and options, so you can use only what you need.

Apply code fixes by either hovering over the relevant section and selecting the suggested fix, pressing <kbd title="Option">⌥</kbd>+<kbd title="Enter">⏎</kbd>(Option+Enter) or <kbd title="Alt">Alt</kbd>+<kbd title="Enter">Enter</kbd>.

To reformat your code, use the keyboard shortcut <kbd>⌥⇧</kbd>+<kbd title="Cmd">⌘</kbd>+<kbd title="L">L</kbd> or <kbd title="Ctrl">Ctrl</kbd>+<kbd title="Alt">Alt</kbd>+<kbd title="L">L</kbd>. Alternatively, you can configure your IDE to format [code automatically on save](https://www.jetbrains.com/help/webstorm/reformat-and-rearrange-code.html#reformat-on-save) for a seamless coding experience.

0 comments on commit 85a2810

Please sign in to comment.