Skip to content

Commit 4e467da

Browse files
committed
Add Periphery as an example.
1 parent a12f46d commit 4e467da

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ Then, import `SwiftSyntax` in your Swift code.
4747

4848
[**SwiftPack**](https://github.com/omochi/SwiftPack): a tool for automatically embedding Swift library source.
4949

50+
[**Periphery**](https://github.com/peripheryapp/periphery): a tool to detect unused code analyzer.
51+
5052
## Contributing
5153

5254
### Building SwiftSyntax from `master`
@@ -61,26 +63,26 @@ To build the `master` version of SwiftSyntax, check `swift-syntax` and `swift`
6163

6264
And run `swift-syntax/build-script.py`. SwiftSyntax is now being built with the Swift compiler installed on the system.
6365

64-
Swift-CI will automatically run the code generation step whenever a new toolchain (development snapshot or release) is published. It should thus almost never be necessary to perform the above build yourself.
66+
Swift-CI will automatically run the code generation step whenever a new toolchain (development snapshot or release) is published. It should thus almost never be necessary to perform the above build yourself.
6567

6668
Afterwards, SwiftPM can also generate an Xcode project to develop SwiftSyntax by running `swift package generate-xcodeproj`.
6769

68-
If you also want to run tests locally, read the section below as testing has additional requirements.
70+
If you also want to run tests locally, read the section below as testing has additional requirements.
6971

7072
### Local Testing
71-
SwiftSyntax uses some test utilities that need to be built as part of the Swift compiler project. To build the most recent version of SwiftSyntax and test it, follow the steps in [swift/README.md](https://github.com/apple/swift/blob/master/README.md) and pass `--llbuild --swiftpm --swiftsyntax` to the build script invocation to build SwiftSyntax and all its dependencies using the current `master` compiler.
73+
SwiftSyntax uses some test utilities that need to be built as part of the Swift compiler project. To build the most recent version of SwiftSyntax and test it, follow the steps in [swift/README.md](https://github.com/apple/swift/blob/master/README.md) and pass `--llbuild --swiftpm --swiftsyntax` to the build script invocation to build SwiftSyntax and all its dependencies using the current `master` compiler.
7274

73-
SwiftSyntax can then be tested using the build script in `apple/swift` by running
75+
SwiftSyntax can then be tested using the build script in `apple/swift` by running
7476
```
7577
swift/utils/build-script --swiftsyntax --swiftpm --llbuild -t --skip-test-cmark --skip-test-swift --skip-test-llbuild --skip-test-swiftpm
7678
```
77-
This command will build SwiftSyntax and all its dependencies, tell the build script to run tests, but skip all tests but the SwiftSyntax tests.
79+
This command will build SwiftSyntax and all its dependencies, tell the build script to run tests, but skip all tests but the SwiftSyntax tests.
7880

7981
Note that it is not currently supported to SwiftSyntax while building the Swift compiler using Xcode.
8082

8183
### CI Testing
8284

83-
Running `@swift-ci Please test` on the main Swift repository will also test the most recent version of SwiftSyntax.
85+
Running `@swift-ci Please test` on the main Swift repository will also test the most recent version of SwiftSyntax.
8486

8587
Testing SwiftSyntax from its own repository is now available by commenting `@swift-ci Please test macOS platform`.
8688

0 commit comments

Comments
 (0)