├── LICENSE.txt └── README.md /LICENSE.txt: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | 204 | 205 | ## Runtime Library Exception to the Apache 2.0 License: ## 206 | 207 | 208 | As an exception, if you use this Software to compile your source code and 209 | portions of this Software are embedded into the binary product as a result, 210 | you may redistribute such product without providing attribution as would 211 | otherwise be required by Sections 4(a), 4(b) and 4(d) of the License. 212 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | Precompiled Swift Syntax 4 | ======================== 5 | 6 | > [!NOTE] 7 | > Tested with Xcode 16.3 against the `release/6.1` branch. 8 | 9 | A precompiled distribution of `swiftlang/swift-syntax` that allows you to completely eliminate having to build SwiftSyntax from source. 10 | 11 | Getting Started 12 | --------------- 13 | 14 | Add the package dependency to your `Package.swift`: 15 | 16 | ```swift 17 | dependencies: [ 18 | .package( 19 | url: "https://github.com/swift-precompiled/swift-syntax.git", 20 | branch: "release/6.1" 21 | ) 22 | ] 23 | ``` 24 | 25 | That’s it — build & run; **SwiftSyntax** will not be rebuilt locally. 26 | 27 |

(back to top)

28 | 29 | Why is this needed? 30 | ------------------- 31 | 32 | [Swift macros](https://docs.swift.org/swift-book/documentation/the-swift-programming-language/macros/) rely on **SwiftSyntax** to parse and expand your source. Pulling the full package and recompiling it *every* clean build for *every* architecture costs a lot of time: 33 | 34 | | Scenario | Extra build time | 35 | | -------- | ---------------- | 36 | | Local *Debug* clean build | **≈ 20 s** | 37 | | Local *Release* (WMO) | **≥ 4 min** | 38 | | Xcode Cloud / CI | **Up to 12 min** | 39 | 40 | Nearly all that time is spent type-checking and compiling SwiftSyntax itself, not running your macros. 41 | 42 |

(back to top)

43 | 44 | Troubleshooting 45 | --------------- 46 | 47 | ### General Xcode troubleshooting 48 | 49 | If Xcode throws build or symbol errors, run this clean-slate sequence: 50 | 51 | 1. **Product ▸ Clean Build Folder** (⇧⌘K) 52 | 2. **File ▸ Packages ▸ Reset Package Caches** (ignore any errors) 53 | 3. Quit and relaunch Xcode 54 | 4. **File ▸ Packages ▸ Update to Latest Package Versions** 55 | 56 | ### Warnings about `swift-syntax` dependencies 57 | 58 | When another package depends on `apple/swift-syntax`, SwiftPM will warn: 59 | 60 | ```text 61 | 'foo' dependency on 'https://github.com/apple/swift-syntax.git' conflicts with 62 | dependency on 'https://github.com/swift-precompiled/swift-syntax' 63 | which has the same identity 'swift-syntax'. This will be escalated to an error 64 | in future versions of SwiftPM. 65 | ``` 66 | 67 | | Option | How | 68 | | ------ | --- | 69 | | **Fork & patch** | Fork each affected package and change its `swiftlang/swift-syntax` reference to `swift-precompiled/swift-syntax`. | 70 | | **Workspace override** | Create an Xcode workspace, clone **this repo** locally, and add it to the workspace. SwiftPM will prefer the local copy. | 71 | 72 | > [!IMPORTANT] 73 | > SwiftPM keys packages solely by the identity `swift-syntax`. 74 | > 75 | > If `swift-precompiled/swift-syntax` *and* the official `swiftlang/swift-syntax` both appear—often via transitive dependencies—SwiftPM throws a “revision conflict.” 76 | > 77 | > The problem affects any fork; even Apple’s own move from `apple/swift-syntax.git` to `swiftlang/swift-syntax.git` recently impacted thousands of projects across the world ([here's an example](https://github.com/pointfreeco/swift-composable-architecture/discussions/3262#discussioncomment-10172538)). 78 | > 79 | > #### CI/CD impact 80 | > In headless pipelines you cannot patch transitive `Package.swift` files or use Xcode workspace overrides, so the build fails with no immediate workaround. 81 | > 82 | > #### References 83 | > - [Point-Free discussion #3262](https://github.com/pointfreeco/swift-composable-architecture/discussions/3262) 84 | > - [Swift Forums: macro-adoption concerns](https://forums.swift.org/t/macro-adoption-concerns-around-swiftsyntax/66588) 85 | > - [Point-Free blog: Being a good citizen in the land of SwiftSyntax](https://www.pointfree.co/blog/posts/116-being-a-good-citizen-in-the-land-of-swiftsyntax) 86 | > - [Swift Forums: override sub-dependency](https://forums.swift.org/t/override-sub-dependency/6726) 87 | > - [Swift Forums: conflict between dependencies that are not sharing a target](https://forums.swift.org/t/swiftpm-conflict-between-dependencies-that-are-not-sharing-a-target/37554) 88 | > - [Swift Forums: can't consume two Swift packages with the same name](https://forums.swift.org/t/cant-consume-two-swift-packages-with-the-same-name/40408) 89 | > 90 | > We are developing an automated workaround for CI environments, but the underlying issue must be fixed in SwiftPM by Apple. 91 | 92 |

(back to top)

93 | 94 | Further Reading 95 | --------------- 96 | 97 | - Swift Forums — *Compilation extremely slow since macros adoption* 98 | 99 | - Swift Forums — *Macro adoption concerns around SwiftSyntax* 100 | 101 | - GitHub — *Distribute a pre-built SwiftSyntax binary* 102 | 103 | - Michael Tsai — *Slow Swift Macro Compilation* 104 | 105 | - Tuist — *Swift Macros at Scale* 106 | 107 | - Medium — *Speed Up SwiftSyntaxMacros Package Compilation (Part 1)* 108 | 109 | - Medium — *Speed Up SwiftSyntaxMacros Package Compilation (Part 2)* 110 | 111 | - [`InstantSyntax`](https://github.com/johnno1962/InstantSyntax) 112 | - [`swift-syntax-xcframeworks`](https://github.com/sjavora/swift-syntax-xcframeworks) 113 | 114 |

(back to top)

115 | 116 | Acknowledgements 117 | ---------------- 118 | 119 | Special thanks to 120 | - [@giginet](https://github.com/giginet) 121 | - [@johnno1962](https://github.com/johnno1962), 122 | - [@kabiroberai](https://github.com/kabiroberai) 123 | - [@yume190](https://github.com/yume190) 124 | 125 | 126 | Led by [@vatsal_manot](https://github.com/vatsal_manot) as a part of [@PreternaturalAI](https://github.com/PreternaturalAI)’s ongoing work. 127 | 128 |

(back to top)

129 | --------------------------------------------------------------------------------