Skip to content

Add a note about an open issue with code generation and SourceKit-LSP #642

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

Merged
merged 7 commits into from
Nov 23, 2024
Merged

Add a note about an open issue with code generation and SourceKit-LSP #642

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d10e61c
Add a note about an open issue with code generation and SourceKit-LSP
t089 Oct 2, 2024
1e3dcf4
Update README.md
t089 Nov 22, 2024
e1a6c1c
Update README.md
t089 Nov 22, 2024
c68d7b2
update docc
t089 Nov 22, 2024
de8c2fd
Merge branch 'main' into patch-1
t089 Nov 22, 2024
56bd8f8
improve language
t089 Nov 22, 2024
8957902
fix docc note syntax
t089 Nov 23, 2024
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
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,9 @@ platforms, listed below.
| Generator plugin and CLI | ✅ 10.15+ | ✅ | ✖️ | ✖️ | ✖️ | ✖️ |
| Generated code and runtime library | ✅ 10.15+ | ✅ | ✅ 13+ | ✅ 13+ | ✅ 6+ | ✅ 1+ |

> [!NOTE]
> When using Visual Studio Code or other editors that rely on [SourceKit-LSP](https://github.com/swiftlang/sourcekit-lsp), the editor may not correctly recognize generated code within the same module. As a workaround, consider creating a separate target for code generation and then importing it into your main module. For more details, see the discussion in [swiftlang/sourcekit-lsp#665](https://github.com/swiftlang/sourcekit-lsp/issues/665#issuecomment-2093169169).

## Documentation and example projects

To get started, check out the [documentation][docs-generator], which contains
Expand Down
3 changes: 3 additions & 0 deletions Sources/swift-openapi-generator/Documentation.docc/Swift-OpenAPI-Generator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,9 @@ The generated code, runtime library, and transports are supported on more platfo
| Generator plugin and CLI | ✅ 10.15+ | ✅ | ✖️ | ✖️ | ✖️ | ✖️ |
| Generated code and runtime library | ✅ 10.15+ | ✅ | ✅ 13+ | ✅ 13+ | ✅ 6+ | ✅ 1+ |

> [!NOTE]
> When using Visual Studio Code or other editors that rely on [SourceKit-LSP](https://github.com/swiftlang/sourcekit-lsp), the editor may not correctly recognize generated code within the same module. As a workaround, consider creating a separate target for code generation and then importing it into your main module. For more details, see the discussion in [swiftlang/sourcekit-lsp#665](https://github.com/swiftlang/sourcekit-lsp/issues/665#issuecomment-2093169169).

### Documentation and example projects

To get started, check out the topics below, or one of the <doc:Swift-OpenAPI-Generator> tutorials.
Expand Down