Skip to content

Commit 0cb284e

Browse files
committed
chore: add gifs
1 parent ee5ea19 commit 0cb284e

4 files changed

Lines changed: 14 additions & 28 deletions

File tree

32 MB
Loading
1.01 MB
Loading

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,29 @@ Type hints for short variable declarations (`:=`), range clauses, const/var bloc
88

99
Hints are clickable (navigate to type definition) and fully customizable:
1010

11-
| Option | Styles |
12-
|---|---|
13-
| Pointer prefix | `*int`   `^int`   `&int`   `ptrOf int` |
14-
| Channel arrows | `<-chan / chan<-` &nbsp; `← chan / → chan / ⇄ chan` |
15-
| Channel type brackets | `chan int` &nbsp; `chan(int)` &nbsp; `chan[int]` &nbsp; `chan⟨int⟩` |
16-
| Generic brackets | `[T]` &nbsp; `⟨T⟩` &nbsp; `<T>` |
17-
| Variadic / ellipsis | `...` &nbsp; `` &nbsp; `` &nbsp; `~` |
18-
| Separator | `, ` &nbsp; ` \| ` &nbsp; `; ` |
19-
| Function literal | `func(...)` &nbsp; `ƒ(...)` &nbsp; `(...)` |
11+
| Option | Styles |
12+
|:----------------------|:-----------------------------------------------------------------------------------------------|
13+
| Pointer prefix | `*int` &nbsp; `^int` &nbsp; `&int` &nbsp; `ptrOf int` |
14+
| Channel arrows | `<-chan / chan<-` &nbsp; `← chan / → chan / ⇄ chan` &nbsp; `chan recv / chan send / chan bdir` |
15+
| Channel type brackets | `chan int` &nbsp; `chan(int)` &nbsp; `chan[int]` &nbsp; `chan⟨int⟩` |
16+
| Generic brackets | `[T]` &nbsp; `⟨T⟩` &nbsp; `<T>` |
17+
| Variadic / ellipsis | `...` &nbsp; `` &nbsp; `` &nbsp; `~` |
18+
| Separator | `, ` &nbsp; ` \| ` &nbsp; `; ` |
19+
| Function literal | `func(...)` &nbsp; `ƒ(...)` &nbsp; `(...)` |
2020

2121
Other settings: max hint length (long types get truncated), toggle type parameter rendering and their constraints, leading space.
2222

23-
<!-- TODO: screenshot -->
23+
![inlay-hints-showcase.gif](.github/resources/inlay-hints-showcase.gif)
2424

2525
## Builder Pattern Generator
2626

27-
<kbd>Alt+Enter</kbd> on any struct → **Generate struct builder**.
27+
<kbd>Alt+Enter</kbd> or <kbd>Cmd+.</kbd> on any struct → **Generate struct builder**.
2828

2929
Generates a fluent builder: exported interface with `With*` methods, unexported implementation, constructor, and a `B()` terminal method. Supports generics.
3030

3131
Pick which fields to include from the standard GoLand member chooser dialog. Exported fields are unchecked by default (they're directly settable anyway).
3232

33-
<!-- TODO: demo video/gif -->
33+
![generate-builder-demo.gif](.github/resources/generate-builder-demo.gif)
3434

3535
## Installation
3636

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,17 @@
1-
<!-- Plugin Configuration File. Read more: https://plugins.jetbrains.com/docs/intellij/plugin-configuration-file.html -->
21
<idea-plugin>
3-
<!-- Unique identifier of the plugin. It should be FQN. It cannot be changed between the plugin versions. -->
42
<id>com.pyro.gotools</id>
5-
6-
<!-- Public plugin name should be written in Title Case.
7-
Guidelines: https://plugins.jetbrains.com/docs/marketplace/plugin-overview-page.html#plugin-name -->
83
<name>GoTools</name>
9-
10-
<!-- A displayed Vendor name or Organization ID displayed on the Plugins Page. -->
114
<vendor url="https://github.com/pyrorhythm">pyro</vendor>
12-
13-
<!-- Description of the plugin displayed on the Plugin Page and IDE Plugin Manager.
14-
Guidelines: https://plugins.jetbrains.com/docs/marketplace/plugin-overview-page.html#plugin-description -->
155
<description><![CDATA[
166
Productivity tools for Go development in GoLand/IntelliJ:
177
<ul>
188
<li><b>Configurable Inlay Type Hints</b> — rich type hints with customizable styles for pointers, channels, generics, function literals, and more. Control max length, bracket style, separators, and Unicode symbols.</li>
199
<li><b>Builder Pattern Generator</b> — generates a fluent Builder pattern (interface + implementation) for any Go struct, with field selection dialog and generics support.</li>
2010
</ul>
21-
]]></description>
22-
11+
]]></description>
2312
<resource-bundle>messages.Bundle</resource-bundle>
24-
2513
<depends>com.intellij.modules.platform</depends>
2614
<depends>org.jetbrains.plugins.go</depends>
27-
2815
<extensions defaultExtensionNs="com.intellij">
2916
<codeInsight.declarativeInlayProvider group="TYPES_GROUP"
3017
implementationClass="com.pyro.gotools.inlayHints.Provider"
@@ -47,8 +34,7 @@
4734
<intentionAction>
4835
<language>go</language>
4936
<className>com.pyro.gotools.codeActions.builderPattern.Intention</className>
50-
<category>Go</category>
37+
<category>GoTools</category>
5138
</intentionAction>
52-
5339
</extensions>
5440
</idea-plugin>

0 commit comments

Comments
 (0)