Skip to content

Commit c451f0a

Browse files
authored
chore: update README with note about hierarchical project support in IntelliJ (#698)
1 parent 0bd50d9 commit c451f0a

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,24 @@ aws.services=-location,-dynamodb
132132
# Generate all services except those using the restJson1 protocol:
133133
aws.protocols=-restJson1
134134
```
135+
136+
### IntelliJ multiplatform compatibility
137+
138+
Due to an outstanding issue in IntelliJ ([KTIJ-21583](https://youtrack.jetbrains.com/issue/KTIJ-21583)), the IDE will
139+
sometimes fail to resolve symbols in composite projects like
140+
[**smithy-kotlin**](https://github.com/awslabs/smithy-kotlin) and
141+
[**aws-crt-kotlin**](https://github.com/awslabs/aws-crt-kotlin). When using either of these projects in a composite
142+
build in IntelliJ, you may need to disable hierarchical project support. Add (or modify) a **local.properties** file in
143+
**smithy-kotlin** and **aws-crt-kotlin** with the following contents:
144+
145+
```
146+
# FIXME - see https://youtrack.jetbrains.com/issue/KTIJ-21583
147+
kotlin.mpp.hierarchicalStructureSupport=false
148+
```
149+
150+
**Note**: These files should be created in the **smithy-kotlin** and **aws-crt-kotlin** projects, not the
151+
**aws-sdk-kotlin** project.
152+
135153
### Debugging
136154

137155
See [Debugging](docs/debugging.md)

0 commit comments

Comments
 (0)