Add ./sourcekit-lsp-dev-utils script

This commit is contained in:
Yuta Saito
2024-12-08 15:43:36 +09:00
parent 2c403e78ae
commit e3997540e0
3 changed files with 12 additions and 1 deletions

View File

@@ -115,6 +115,14 @@ swift package format-source-code
If you are developing SourceKit-LSP in VS Code, you can also run the *Run swift-format* task from *Tasks: Run tasks* in the command palette.
## Generate configuration schema
If you modify the configuration options in [`SKOptions`](./Sources/SKOptions), you need to regenerate the configuration the JSON schema and the documentation by running the following command:
```bash
./sourcekit-lsp-dev-utils generate-config-schema
```
## Authoring commits
Prefer to squash the commits of your PR (*pull request*) and avoid adding commits like “Address review comments”. This creates a clearer git history, which doesnt need to record the history of how the PR evolved.

View File

@@ -1,3 +1,3 @@
# sourcekit-lsp-dev-utils
This directory contains utilities for developing SourceKit-LSP.
This directory contains utilities for developing SourceKit-LSP. [CONTRIBUTING.md](../CONTRIBUTING.md) covers how to use these utilities.

3
sourcekit-lsp-dev-utils Executable file
View File

@@ -0,0 +1,3 @@
#!/usr/bin/env sh
swift run --package-path "$(dirname $0)/SourceKitLSPDevUtils" sourcekit-lsp-dev-utils "$@"