Skip to content

Commit 4eb16d0

Browse files
yhk1038claude
yhk1038
and
claude
committed
docs: update README and IDE documentation
- Rename "Quick links" to "Links", "Getting Started" to "IDE Support" - Add JetBrains plugin link to README (all languages) - Add Cursor support to VS Code extension link - Create JetBrains documentation (ko, en, ja) - Update VS Code docs with logo header and marketplace links - Fix git clone URL (pyhyun -> type-ruby) - Update marketplace URLs: - VS Code: marketplace.visualstudio.com/items?itemName=t-ruby.t-ruby - Cursor: open-vsx.org/extension/t-ruby/t-ruby - JetBrains: plugins.jetbrains.com/plugin/29335-t-ruby - Remove invalid Discussions link, keep GitHub Issues only 🤖 Generated with [Claude Code](https://claude.ai/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
1 parent 50d2135 commit 4eb16d0

File tree

9 files changed

+624
-51
lines changed

9 files changed

+624
-51
lines changed

‎README.ja.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ trc greet.trb
133133
gem install t-ruby
134134

135135
# ソースからインストール
136-
git clone https://github.com/pyhyun/t-ruby
136+
git clone https://github.com/type-ruby/t-ruby
137137
cd t-ruby && bundle install
138138
```
139139

@@ -247,10 +247,11 @@ watch:
247247

248248
---
249249

250-
## クイックリンク
250+
## リンク
251251

252-
**はじめに**
253-
- [VS Code 拡張](./docs/vscode/ja/getting-started.md)
252+
**IDE サポート**
253+
- [VS Code 拡張 (および Cursor)](./docs/vscode/ja/getting-started.md)
254+
- [JetBrains プラグイン](./docs/jetbrains/ja/getting-started.md)
254255
- [Vim セットアップ](./docs/vim/ja/getting-started.md)
255256
- [Neovim セットアップ](./docs/neovim/ja/getting-started.md)
256257

‎README.ko.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ trc greet.trb
133133
gem install t-ruby
134134

135135
# 소스에서 설치
136-
git clone https://github.com/pyhyun/t-ruby
136+
git clone https://github.com/type-ruby/t-ruby
137137
cd t-ruby && bundle install
138138
```
139139

@@ -247,10 +247,11 @@ watch:
247247

248248
---
249249

250-
## 빠른 링크
250+
## 링크
251251

252-
**시작하기**
253-
- [VS Code 확장](./docs/vscode/ko/getting-started.md)
252+
**IDE 지원**
253+
- [VS Code 확장 (및 Cursor)](./docs/vscode/ko/getting-started.md)
254+
- [JetBrains 플러그인](./docs/jetbrains/ko/getting-started.md)
254255
- [Vim 설정](./docs/vim/ko/getting-started.md)
255256
- [Neovim 설정](./docs/neovim/ko/getting-started.md)
256257

‎README.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ We still love Ruby, and we want this to be
138138
gem install t-ruby
139139

140140
# from source
141-
git clone https://github.com/pyhyun/t-ruby
141+
git clone https://github.com/type-ruby/t-ruby
142142
cd t-ruby && bundle install
143143
```
144144

@@ -252,10 +252,11 @@ watch:
252252

253253
---
254254

255-
## Quick links
255+
## Links
256256

257-
**Getting Started**
258-
- [VS Code Extension](./docs/vscode/en/getting-started.md)
257+
**IDE Support**
258+
- [VS Code Extension (and Cursor)](./docs/vscode/en/getting-started.md)
259+
- [JetBrains Plugin](./docs/jetbrains/en/getting-started.md)
259260
- [Vim Setup](./docs/vim/en/getting-started.md)
260261
- [Neovim Setup](./docs/neovim/en/getting-started.md)
261262

‎docs/jetbrains/en/getting-started.md‎

Lines changed: 168 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
<p align="center">
2+
<img src="https://avatars.githubusercontent.com/u/248530250" alt="T-Ruby" height="120">
3+
</p>
4+
5+
<h1 align="center">T-Ruby for JetBrains</h1>
6+
7+
<p align="center">
8+
<a href="https://type-ruby.github.io">Official Website</a>
9+
&nbsp;&nbsp;•&nbsp;&nbsp;
10+
<a href="https://github.com/type-ruby/t-ruby">GitHub</a>
11+
&nbsp;&nbsp;•&nbsp;&nbsp;
12+
<a href="https://plugins.jetbrains.com/plugin/29335-t-ruby">JetBrains Marketplace</a>
13+
</p>
14+
15+
---
16+
17+
Welcome to T-Ruby for JetBrains! This guide will help you install and configure the T-Ruby plugin for a seamless typed Ruby development experience.
18+
19+
> **Note**: This plugin works with all JetBrains IDEs including IntelliJ IDEA, RubyMine, WebStorm, and more.
20+
21+
## Prerequisites
22+
23+
Before installing the plugin, ensure you have:
24+
25+
- **JetBrains IDE** 2023.1 or higher (IntelliJ IDEA, RubyMine, WebStorm, etc.)
26+
- **Ruby** 3.0 or higher
27+
- **T-Ruby Compiler** (`trc`) installed and available in your PATH
28+
29+
### Installing T-Ruby Compiler
30+
31+
```bash
32+
# Install via gem (recommended)
33+
gem install t-ruby
34+
```
35+
36+
Verify the installation:
37+
```bash
38+
trc --version
39+
```
40+
41+
## Installation
42+
43+
### Method 1: JetBrains Marketplace (Recommended)
44+
45+
1. Open your JetBrains IDE
46+
2. Go to `Settings/Preferences` > `Plugins`
47+
3. Search for "T-Ruby" in the `Marketplace` tab
48+
4. Click **Install**
49+
5. Restart the IDE
50+
51+
Or install directly from the [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/29335-t-ruby).
52+
53+
### Method 2: Install from Disk (Coming Soon)
54+
55+
1. Download the `.zip` file from [Releases](https://github.com/type-ruby/t-ruby/releases)
56+
2. Go to `Settings/Preferences` > `Plugins`
57+
3. Click the gear icon > `Install Plugin from Disk...`
58+
4. Select the downloaded file
59+
60+
### Method 3: Build from Source
61+
62+
```bash
63+
# Clone the repository
64+
git clone https://github.com/type-ruby/t-ruby.git
65+
cd t-ruby/editors/jetbrains
66+
67+
# Build with Gradle
68+
./gradlew buildPlugin
69+
70+
# The built plugin will be in build/distributions/
71+
```
72+
73+
## Configuration
74+
75+
After installation, configure the plugin in `Settings/Preferences` > `Languages & Frameworks` > `T-Ruby`:
76+
77+
### Configuration Options
78+
79+
| Option | Default | Description |
80+
|--------|---------|-------------|
81+
| T-Ruby Compiler Path | `trc` | Path to T-Ruby compiler |
82+
| Enable Real-time Diagnostics | `true` | Check errors while typing |
83+
| Enable Autocomplete | `true` | Type-based autocompletion |
84+
85+
## Features
86+
87+
### Syntax Highlighting
88+
89+
The plugin provides full syntax highlighting for:
90+
- `.trb` files (T-Ruby source files)
91+
- `.d.trb` files (T-Ruby declaration files)
92+
93+
Type annotations, interfaces, and type aliases are highlighted distinctly.
94+
95+
### IntelliSense
96+
97+
- **Autocomplete**: Type suggestions for parameters and return types
98+
- **Hover**: View type information by hovering over symbols
99+
- **Go to Definition**: `Ctrl+Click` to navigate to type/function definitions
100+
101+
### Diagnostics
102+
103+
Real-time error checking for:
104+
- Unknown types
105+
- Duplicate definitions
106+
- Syntax errors
107+
108+
### Actions
109+
110+
Access via `Find Action` (`Ctrl+Shift+A` / `Cmd+Shift+A`):
111+
112+
| Action | Description |
113+
|--------|-------------|
114+
| `T-Ruby: Compile Current File` | Compile the active `.trb` file |
115+
| `T-Ruby: Generate Declaration File` | Generate `.d.trb` from source |
116+
117+
## Quick Start Example
118+
119+
1. Create a new file `hello.trb`:
120+
121+
```trb
122+
type UserId = String
123+
124+
interface User
125+
id: UserId
126+
name: String
127+
age: Integer
128+
end
129+
130+
def greet(user: User): String
131+
"Hello, #{user.name}!"
132+
end
133+
```
134+
135+
2. Save the file - you'll see syntax highlighting and real-time diagnostics
136+
137+
3. Hover over types to see their definitions
138+
139+
4. Use `Ctrl+Space` for autocomplete suggestions
140+
141+
## Troubleshooting
142+
143+
### Plugin not working
144+
145+
1. Check if `trc` is installed: `which trc`
146+
2. Verify the path in settings: `Settings` > `Languages & Frameworks` > `T-Ruby`
147+
3. Check IDE logs: `Help` > `Show Log in Finder/Explorer`
148+
149+
### No syntax highlighting
150+
151+
1. Ensure file has `.trb` or `.d.trb` extension
152+
2. Check file type association: `Settings` > `Editor` > `File Types`
153+
154+
### Performance issues
155+
156+
- Disable diagnostics for large files
157+
- Restart the IDE
158+
159+
## Next Steps
160+
161+
- [Syntax Highlighting Guide](../../syntax-highlighting/en/guide.md)
162+
- [T-Ruby Language Reference](https://github.com/type-ruby/t-ruby/wiki)
163+
- [Report Issues](https://github.com/type-ruby/t-ruby/issues)
164+
165+
## Support
166+
167+
For questions and bug reports, please visit GitHub Issues:
168+
https://github.com/type-ruby/t-ruby/issues

0 commit comments

Comments
 (0)