Skip to content

Copilot: Fix GYB generation instructions. #475

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Copilot: Fix GYB generation instructions. #475

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Execute these commands in order for a fresh repository setup:
2. **Generate Swift Source Code** (REQUIRED):
```bash
# Generate the main Device.generated.swift file from template
python3 Utils/gyb.py Source/Device.swift.gyb > Source/Device.generated.swift
./Utils/gyb --line-directive '' -o ./Source/Device.generated.swift ./Source/Device.swift.gyb
```
- Takes < 1 minute
- Must be run after any changes to `Source/Device.swift.gyb`
Expand Down Expand Up @@ -86,7 +86,7 @@ Since this is a device detection library, validation focuses on:
1. **Code Generation Validation** (Always required):
```bash
# Verify code generation works and produces valid Swift
python3 Utils/gyb.py Source/Device.swift.gyb > Source/Device.generated.swift
./Utils/gyb --line-directive '' -o ./Source/Device.generated.swift ./Source/Device.swift.gyb
wc -l Source/Device.generated.swift # Should show ~2700-4000 lines
```
- Must produce Swift code without syntax errors
Expand Down Expand Up @@ -136,7 +136,7 @@ Since this is a device detection library, validation focuses on:

### Adding New Device Support
1. Edit `Source/Device.swift.gyb` to add new device entries
2. Regenerate: `python3 Utils/gyb.py Source/Device.swift.gyb > Source/Device.generated.swift`
2. Regenerate: `./Utils/gyb --line-directive '' -o ./Source/Device.generated.swift ./Source/Device.swift.gyb`
3. Build and test: `swift build && swift test`
4. Lint: `swiftlint`
5. Test on relevant simulators
Expand All @@ -158,7 +158,7 @@ Since this is a device detection library, validation focuses on:

**"SwiftLint not found"**: Install via `brew install swiftlint` (macOS only)

**"Code generation produces different output"**: Ensure you're using Python 3 and the exact command: `python3 Utils/gyb.py Source/Device.swift.gyb > Source/Device.generated.swift`
**"Code generation produces different output"**: Ensure you're using Python 3 and the exact command: `./Utils/gyb --line-directive '' -o ./Source/Device.generated.swift ./Source/Device.swift.gyb`

**"Permission denied installing gems"**: Use `sudo gem install bundler` or install gems in user directory

Expand Down Expand Up @@ -207,7 +207,7 @@ DeviceKit.podspec # CocoaPods specification
## Command Validation Status

### ✅ Verified on Linux (Limited):
- `python3 Utils/gyb.py Source/Device.swift.gyb > Source/Device.generated.swift` - Works, produces valid Swift code
- `./Utils/gyb --line-directive '' -o ./Source/Device.generated.swift ./Source/Device.swift.gyb` - Works, produces valid Swift code
- Repository structure exploration and documentation review
- Package.swift and project file validation

Expand Down