Skip to content

Commit e399754

Browse files
Add ./sourcekit-lsp-dev-utils script
1 parent 2c403e7 commit e399754

File tree

3 files changed

+12
-1
lines changed

3 files changed

+12
-1
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,14 @@ swift package format-source-code
115115
116116
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.
117117
118+
## Generate configuration schema
119+
120+
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:
121+
122+
```bash
123+
./sourcekit-lsp-dev-utils generate-config-schema
124+
```
125+
118126
## Authoring commits
119127
120128
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 doesn’t need to record the history of how the PR evolved.

SourceKitLSPDevUtils/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# sourcekit-lsp-dev-utils
22

3-
This directory contains utilities for developing SourceKit-LSP.
3+
This directory contains utilities for developing SourceKit-LSP. [CONTRIBUTING.md](../CONTRIBUTING.md) covers how to use these utilities.

sourcekit-lsp-dev-utils

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#!/usr/bin/env sh
2+
3+
swift run --package-path "$(dirname $0)/SourceKitLSPDevUtils" sourcekit-lsp-dev-utils "$@"

0 commit comments

Comments
 (0)