swagger-api / swagger-api/swagger-codegen

[Swift] Reserved words should be escaped with backticks, not underscores

Open
#7,736 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

Reserved words in Swift are supposed to be escaped with backticks: https://developer.apple.com/library/content/documentation/Swift/Conceptual/Swift_Programming_Language/LexicalStructure.html

Trying to override escapeReservedWord results in the backticks being encoded:

return '_' + name + '_';  // Results in: public var _protocol_: ModelProtocol?
return '`' + name + '`';  // Results in: public var `protocol`: ModelProtocol? 

Is this an issue with Handlebars?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the generated Swift declaration described in the issue and trace how escapeReservedWord output is encoded. The work is done when reserved Swift words appear wrapped in literal backticks rather than HTML-encoded backticks.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
devtools
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.