Skip to content

Commit d440b71

Browse files
committed
docs: rename config file from trc.yaml to trbconfig.yml
Unify configuration filename across all documentation: - English docs (8 files) - Japanese docs (8 files) - Korean docs (8 files) This aligns with the t-ruby core change in commit 941e6d1.
1 parent 15b98c2 commit d440b71

File tree

24 files changed

+135
-135
lines changed

24 files changed

+135
-135
lines changed

docs/cli/commands.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ trc watch --debounce 500
191191
**Watch configuration files too:**
192192

193193
```bash
194-
trc watch src/ --include "trc.yaml"
194+
trc watch src/ --include "trbconfig.yml"
195195
```
196196

197197
### Output
@@ -372,7 +372,7 @@ Initialize a new T-Ruby project with configuration file and directory structure.
372372
### Basic Usage
373373

374374
```bash
375-
# Create trc.yaml in current directory
375+
# Create trbconfig.yml in current directory
376376
trc init
377377

378378
# Interactive setup
@@ -411,7 +411,7 @@ trc init --template basic
411411

412412
Creates:
413413
```
414-
trc.yaml
414+
trbconfig.yml
415415
src/
416416
build/
417417
sig/
@@ -529,7 +529,7 @@ T-Ruby Project Setup
529529
? Create directory structure? Yes
530530
? Initialize git repository? Yes
531531
532-
✓ Created trc.yaml
532+
✓ Created trbconfig.yml
533533
✓ Created src/
534534
✓ Created build/
535535
✓ Created sig/
@@ -583,7 +583,7 @@ trc -h
583583
trc compile --help
584584

585585
# Use specific config file
586-
trc --config path/to/trc.yaml
586+
trc --config path/to/trbconfig.yml
587587

588588
# Set log level (debug, info, warn, error)
589589
trc --log-level debug
@@ -600,11 +600,11 @@ trc --stack-trace
600600

601601
## Configuration File
602602

603-
Commands respect the `trc.yaml` configuration file. Command-line options override config file settings.
603+
Commands respect the `trbconfig.yml` configuration file. Command-line options override config file settings.
604604

605605
Example workflow:
606606

607-
```yaml title="trc.yaml"
607+
```yaml title="trbconfig.yml"
608608
source:
609609
include:
610610
- src
@@ -623,7 +623,7 @@ compiler:
623623
Then simply run:
624624
625625
```bash
626-
# Uses settings from trc.yaml
626+
# Uses settings from trbconfig.yml
627627
trc compile
628628
trc watch
629629
trc check
@@ -733,14 +733,14 @@ trc compile . --log-level debug
733733
**Unexpected output location:**
734734
```bash
735735
# Check your configuration
736-
cat trc.yaml
736+
cat trbconfig.yml
737737

738738
# Or specify explicitly
739739
trc compile src/ --output build/ --rbs-dir sig/
740740
```
741741

742742
## Next Steps
743743

744-
- [Configuration Reference](/docs/cli/configuration) - Learn about `trc.yaml` options
744+
- [Configuration Reference](/docs/cli/configuration) - Learn about `trbconfig.yml` options
745745
- [Compiler Options](/docs/cli/compiler-options) - Detailed compiler flags and settings
746746
- [Project Configuration](/docs/getting-started/project-configuration) - Set up your project

docs/cli/compiler-options.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ T-Ruby's compiler provides extensive options to control compilation, type checki
1616
Compiler options can be specified in three ways:
1717

1818
1. **Command-line flags**: `trc --strict compile src/`
19-
2. **Configuration file**: In `trc.yaml` under `compiler:` section
19+
2. **Configuration file**: In `trbconfig.yml` under `compiler:` section
2020
3. **Environment variables**: `TRC_STRICT=true trc compile src/`
2121

2222
Command-line flags override configuration file settings.
@@ -1033,14 +1033,14 @@ Variables override config file but are overridden by command-line flags.
10331033
Options are resolved in this order (later overrides earlier):
10341034
10351035
1. Default values
1036-
2. Configuration file (`trc.yaml`)
1036+
2. Configuration file (`trbconfig.yml`)
10371037
3. Environment variables
10381038
4. Command-line flags
10391039
10401040
Example:
10411041
10421042
```yaml
1043-
# trc.yaml
1043+
# trbconfig.yml
10441044
compiler:
10451045
strictness: standard
10461046
```
@@ -1099,5 +1099,5 @@ trc compile --strict src/
10991099
## Next Steps
11001100
11011101
- [Commands Reference](/docs/cli/commands) - Learn about all CLI commands
1102-
- [Configuration File](/docs/cli/configuration) - Configure via `trc.yaml`
1102+
- [Configuration File](/docs/cli/configuration) - Configure via `trbconfig.yml`
11031103
- [Type Annotations](/docs/learn/basics/type-annotations) - Start writing typed code

docs/cli/configuration.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ description: T-Ruby configuration file reference
99

1010
# Configuration
1111

12-
T-Ruby uses a `trc.yaml` file to configure compiler behavior, source files, output locations, and type checking rules. This reference covers all available configuration options.
12+
T-Ruby uses a `trbconfig.yml` file to configure compiler behavior, source files, output locations, and type checking rules. This reference covers all available configuration options.
1313

1414
## Configuration File
1515

16-
Place `trc.yaml` in your project root:
16+
Place `trbconfig.yml` in your project root:
1717

18-
```yaml title="trc.yaml"
18+
```yaml title="trbconfig.yml"
1919
# T-Ruby configuration file
2020
version: ">=1.0.0"
2121

@@ -688,7 +688,7 @@ types:
688688
stdlib: true
689689
```
690690
691-
**trc.yaml:**
691+
**trbconfig.yml:**
692692
```yaml
693693
extends: trc.base.yaml
694694

@@ -726,9 +726,9 @@ workspace:
726726
strictness: standard
727727
```
728728
729-
Each package has its own `trc.yaml`:
729+
Each package has its own `trbconfig.yml`:
730730

731-
**packages/core/trc.yaml:**
731+
**packages/core/trbconfig.yml:**
732732
```yaml
733733
source:
734734
include:
@@ -749,7 +749,7 @@ trc --workspace compile
749749

750750
A comprehensive configuration for a Rails application:
751751

752-
```yaml title="trc.yaml"
752+
```yaml title="trbconfig.yml"
753753
# T-Ruby Configuration for Rails App
754754
version: ">=1.2.0"
755755
@@ -876,7 +876,7 @@ Output:
876876

877877
```
878878
Configuration loaded from:
879-
- /path/to/trc.yaml
879+
- /path/to/trbconfig.yml
880880
- Environment variables:
881881
- TRC_STRICTNESS=standard
882882
- Command line:
@@ -953,7 +953,7 @@ compiler:
953953
### 3. Use environment-specific configs
954954

955955
```yaml
956-
# trc.yaml (default - development)
956+
# trbconfig.yml (default - development)
957957
compiler:
958958
strictness: standard
959959
@@ -981,7 +981,7 @@ compiler:
981981
### 5. Keep configuration in version control
982982

983983
```bash
984-
git add trc.yaml
984+
git add trbconfig.yml
985985
git commit -m "Add T-Ruby configuration"
986986
```
987987

docs/getting-started/editor-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Add to your Neovim configuration:
8888
require('lspconfig').t_ruby_lsp.setup {
8989
cmd = { "t-ruby-lsp" },
9090
filetypes = { "truby" },
91-
root_dir = require('lspconfig').util.root_pattern("trc.yaml", ".git"),
91+
root_dir = require('lspconfig').util.root_pattern("trbconfig.yml", ".git"),
9292
settings = {
9393
truby = {
9494
typeCheck = {

docs/getting-started/project-configuration.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ For larger projects, T-Ruby uses a configuration file to manage compiler options
1313

1414
## Configuration File
1515

16-
Create a `trc.yaml` file in your project root:
16+
Create a `trbconfig.yml` file in your project root:
1717

18-
```yaml title="trc.yaml"
18+
```yaml title="trbconfig.yml"
1919
# T-Ruby Configuration
2020

2121
# Compiler version requirement
@@ -59,7 +59,7 @@ Use `trc init` to create a configuration file:
5959
trc init
6060
```
6161

62-
This creates a `trc.yaml` with sensible defaults.
62+
This creates a `trbconfig.yml` with sensible defaults.
6363

6464
For interactive setup:
6565

@@ -184,7 +184,7 @@ A typical T-Ruby project structure:
184184

185185
```
186186
my-project/
187-
├── trc.yaml # Configuration
187+
├── trbconfig.yml # Configuration
188188
├── src/ # T-Ruby source files
189189
│ ├── models/
190190
│ │ ├── user.trb
@@ -212,7 +212,7 @@ my-project/
212212

213213
Use environment variables or multiple config files:
214214

215-
```yaml title="trc.yaml"
215+
```yaml title="trbconfig.yml"
216216
# Base configuration
217217
218218
compiler:
@@ -252,7 +252,7 @@ Create a Rake task:
252252
require "t-ruby/rake_task"
253253
254254
TRuby::RakeTask.new(:compile) do |t|
255-
t.config_file = "trc.yaml"
255+
t.config_file = "trbconfig.yml"
256256
end
257257
258258
# Compile before running tests
@@ -270,7 +270,7 @@ bundle exec rake test
270270

271271
For Rails projects, configure T-Ruby to work with the Rails structure:
272272

273-
```yaml title="trc.yaml"
273+
```yaml title="trbconfig.yml"
274274
source:
275275
include:
276276
- app/models
@@ -348,13 +348,13 @@ For monorepos with multiple packages:
348348
monorepo/
349349
├── packages/
350350
│ ├── core/
351-
│ │ ├── trc.yaml
351+
│ │ ├── trbconfig.yml
352352
│ │ └── src/
353353
│ ├── web/
354-
│ │ ├── trc.yaml
354+
│ │ ├── trbconfig.yml
355355
│ │ └── src/
356356
│ └── api/
357-
│ ├── trc.yaml
357+
│ ├── trbconfig.yml
358358
│ └── src/
359359
└── trc.workspace.yaml
360360
```

docs/tooling/migrating-from-ruby.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -609,7 +609,7 @@ end
609609

610610
Start with permissive mode during migration:
611611

612-
```yaml title="trc.yaml"
612+
```yaml title="trbconfig.yml"
613613
compiler:
614614
strictness: permissive
615615

@@ -628,7 +628,7 @@ This allows:
628628

629629
As you add more types, increase strictness:
630630

631-
```yaml title="trc.yaml"
631+
```yaml title="trbconfig.yml"
632632
compiler:
633633
strictness: standard # Move from permissive
634634
@@ -642,7 +642,7 @@ compiler:
642642

643643
Once fully migrated:
644644

645-
```yaml title="trc.yaml"
645+
```yaml title="trbconfig.yml"
646646
compiler:
647647
strictness: strict
648648
@@ -672,7 +672,7 @@ app/
672672

673673
Configure T-Ruby to only compile `.trb` files:
674674

675-
```yaml title="trc.yaml"
675+
```yaml title="trbconfig.yml"
676676
source:
677677
include:
678678
- app/models
@@ -739,7 +739,7 @@ bundle exec rake test
739739

740740
### Phase 1: Setup
741741
- [ ] Install T-Ruby
742-
- [ ] Create `trc.yaml` configuration
742+
- [ ] Create `trbconfig.yml` configuration
743743
- [ ] Set up watch mode
744744
- [ ] Configure CI for type checking
745745

docs/tooling/rbs-integration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ end
9090

9191
By default, RBS files are generated. You can control this:
9292

93-
```yaml title="trc.yaml"
93+
```yaml title="trbconfig.yml"
9494
compiler:
9595
generate_rbs: true # Default
9696
```
@@ -109,7 +109,7 @@ trc compile --rbs-only src/
109109

110110
Configure where RBS files are written:
111111

112-
```yaml title="trc.yaml"
112+
```yaml title="trbconfig.yml"
113113
output:
114114
rbs_dir: sig # Default
115115
```
@@ -403,7 +403,7 @@ sig/
403403
└── external.rbs
404404
```
405405

406-
```yaml title="trc.yaml"
406+
```yaml title="trbconfig.yml"
407407
output:
408408
rbs_dir: sig/generated
409409

@@ -555,7 +555,7 @@ class User < ApplicationRecord
555555
end
556556
```
557557

558-
```yaml title="trc.yaml"
558+
```yaml title="trbconfig.yml"
559559
source:
560560
include:
561561
- app/models

docs/tooling/steep.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -750,7 +750,7 @@ target :test do
750750
end
751751
```
752752

753-
```yaml title="trc.yaml"
753+
```yaml title="trbconfig.yml"
754754
source:
755755
include:
756756
- src/app

0 commit comments

Comments
 (0)