Skip to content

Commit

Permalink
Release v0.1.0-alpha-4
Browse files Browse the repository at this point in the history
  • Loading branch information
InSyncWithFoo committed Nov 22, 2024
1 parent da35530 commit 2812520
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 21 deletions.
15 changes: 12 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,17 @@ For code changes, see [`CHANGELOG_CODE.md`][_-1].

## [Unreleased]

<i>This section is currently empty.</i>


## [0.1.0-alpha-4] - 2024-11-22

See [the documentation][0.1.0-a4-1] for more information.

Latest tool versions at the time of release:

* Ruff: [0.7.4][0.1.0-a4-2]
* uv: [0.5.2][0.1.0-a4-3]
* uv: [0.5.4][0.1.0-a4-3]
* Rye: [0.42.0][0.1.0-a4-4]


Expand Down Expand Up @@ -95,11 +100,14 @@ Latest tool versions at the time of release:
Previously, a threading error would be reported.
* Ruff's violation fixes with multiple edits are now applied correctly
in <i>Command line</i> mode.
* The plugin now creates an informational-only
project generation panel on IntelliJ IDEA.
Previously, a `RuntimeException` would be thrown.


[0.1.0-a4-1]: https://insyncwithfoo.github.io/ryecharm/
[0.1.0-a4-2]: https://github.com/astral-sh/ruff/releases/tag/0.7.4
[0.1.0-a4-3]: https://github.com/astral-sh/uv/releases/tag/0.5.2
[0.1.0-a4-3]: https://github.com/astral-sh/uv/releases/tag/0.5.4
[0.1.0-a4-4]: https://github.com/astral-sh/rye/releases/tag/0.42.0
[0.1.0-a4-a-1]: https://peps.python.org/pep-0735/
[0.1.0-a4-a-2]: https://packaging.python.org/en/latest/specifications/name-normalization/#name-normalization
Expand Down Expand Up @@ -261,7 +269,8 @@ See [the documentation][0.1.0-a1-5] for more information.
[0.1.0-a1-5]: https://insyncwithfoo.github.io/ryecharm


[Unreleased]: https://github.com/InSyncWithFoo/ryecharm/compare/v0.1.0-alpha-3..HEAD
[Unreleased]: https://github.com/InSyncWithFoo/ryecharm/compare/v0.1.0-alpha-4..HEAD
[0.1.0-alpha-4]: https://github.com/InSyncWithFoo/ryecharm/compare/v0.1.0-alpha-3..v0.1.0-alpha-4
[0.1.0-alpha-3]: https://github.com/InSyncWithFoo/ryecharm/compare/v0.1.0-alpha-2..v0.1.0-alpha-3
[0.1.0-alpha-2]: https://github.com/InSyncWithFoo/ryecharm/compare/v0.1.0-alpha-1..v0.1.0-alpha-2
[0.1.0-alpha-1]: https://github.com/InSyncWithFoo/ryecharm/commits
8 changes: 7 additions & 1 deletion CHANGELOG_CODE.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ For user-facing changes, see [`CHANGELOG.md`][_-1].

## [Unreleased]

<i>This section is currently empty.</i>


## [0.1.0-alpha-4] - 2024-11-22

### Changed

* The `# noqa` comment parsing algorithm is updated to match that of Ruff.
Expand Down Expand Up @@ -127,7 +132,8 @@ Commands and settings integrated:
[_0.1.0-a1-4]: https://rye.astral.sh/guide/commands/


[Unreleased]: https://github.com/InSyncWithFoo/ryecharm/compare/v0.1.0-alpha-3..HEAD
[Unreleased]: https://github.com/InSyncWithFoo/ryecharm/compare/v0.1.0-alpha-4..HEAD
[0.1.0-alpha-4]: https://github.com/InSyncWithFoo/ryecharm/compare/v0.1.0-alpha-3..v0.1.0-alpha-4
[0.1.0-alpha-3]: https://github.com/InSyncWithFoo/ryecharm/compare/v0.1.0-alpha-2..v0.1.0-alpha-3
[0.1.0-alpha-2]: https://github.com/InSyncWithFoo/ryecharm/compare/v0.1.0-alpha-1..v0.1.0-alpha-2
[0.1.0-alpha-1]: https://github.com/InSyncWithFoo/ryecharm/commits
34 changes: 17 additions & 17 deletions docs/other-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ The new content will be written back when this editor is closed.
![](./assets/features-edit-script-metadata-fragment-demo-new-editor.png)


### Installed version inlay hints
## Installed version inlay hints

In `pyproject.toml` and `uv.toml` files,
elements of dependency specifier arrays
Expand All @@ -111,46 +111,46 @@ This applies to the following arrays
This is equivalent to running `uv pip list` at the project's path
with the corresponding interpreter as argument, if any.

!!! note

On IntelliJ IDEA, flickering might happen during computation.
The cause of this problem is as of yet unknown.

As a workaround, enable the "Retrieve data for computing dependency version
inlay hints in read action" advanced setting in the <i>uv</i> subpanel.
### Limitations

This workaround has the disadvantage of delaying
the computation of other inlay hint providers,
causing a "synchronous execution under read action" exception.
Unless the delay proves to be a problem, you can safely ignore this warning.
On IntelliJ IDEA, flickering might happen during recalculation.
The cause of this problem is as of yet unknown.

As a workaround, enable the "Retrieve data for computing dependency version
inlay hints in read action" advanced setting in the <i>uv</i> subpanel.

### Dependency groups
This workaround has the disadvantage of delaying other inlay hint providers,
causing a "synchronous execution under read action" exception to be logged.
Unless the delay proves to be a problem, you can safely ignore this warning.


## Dependency groups

[PEP 735][10] dependency groups are supported
using a number of features.


#### Language injection
### Language injection

See [&sect; <i>Requirements arrays in TOML files</i>][11].

![](./assets/features-dependency-groups-language-injection.png)


#### References finding
### References finding

On focus, an included group's name will be highlighted
along with that group's declaration and vice versa.

![](./assets/features-dependency-groups-references-finding.png)


#### One-click-install via line markers
### One-click-install via line markers

Dependency groups can be installed
using their corresponding icons in the gutter.
The icon corresponding to the `[dependency-groups]`
The icon next to the `[dependency-groups]`
table header installs all groups.

This is equivalent to running `uv sync --group ...`/`uv sync --all-groups`
Expand All @@ -159,7 +159,7 @@ at the project's path.
![](./assets/features-dependency-groups-line-markers.png)


#### Inspection
### Inspection

Errors will be reported for a dependency group if:

Expand Down
2 changes: 2 additions & 0 deletions mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ theme:
- navigation.expand
- navigation.footer
- navigation.indexes
- navigation.instant
- navigation.tracking
- search.suggest

markdown_extensions:
Expand Down

0 comments on commit 2812520

Please sign in to comment.