Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/viktorstrate/swift-tree-sitter
Swift bindings for the tree-sitter parsing library
https://github.com/viktorstrate/swift-tree-sitter
bindings ios macos swift tree-sitter
Last synced: about 23 hours ago
JSON representation
Swift bindings for the tree-sitter parsing library
- Host: GitHub
- URL: https://github.com/viktorstrate/swift-tree-sitter
- Owner: viktorstrate
- License: mit
- Created: 2020-05-24T10:49:06.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-03-03T18:39:12.000Z (over 2 years ago)
- Last Synced: 2024-11-02T07:10:12.385Z (8 days ago)
- Topics: bindings, ios, macos, swift, tree-sitter
- Language: Swift
- Homepage:
- Size: 852 KB
- Stars: 32
- Watchers: 2
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Swift Tree Sitter
This module provides Swift bindings for the [tree-sitter](https://tree-sitter.github.io) parsing library
## Installation
### Using Swift Package Manager
Add it as a dependency in the `Package.swift` file.
```swift
.package(url: "https://github.com/viktorstrate/swift-tree-sitter", from: "1.0.0")
```
Or from Xcode navigate to `File` -> `Swift Packages` -> `Add Package Dependency...`, then enter this url:
```
https://github.com/viktorstrate/swift-tree-sitter
```
### Import directly to Xcode
If you want to load languages from `.bundles` dynamically at runtime, you'll have to import it directly to Xcode as Mac bundles aren't supported using the Swift Package Manager.
To do this, download the project and drag the folder with the `SwiftTreeSitter.xcodeproj` file into the sidebar of your Xcode project.
## Usage
First you'll need to setup the Parser and specify what language to use.
```swift
let javascript = try STSLanguage(fromPreBundle: .javascript)
let parser = STSParser(language: javascript)
```
Then you can parse some source code.
```swift
let sourceCode = "let x = 1; console.log(x);";
let tree = parser.parse(string: sourceCode, oldTree: nil)!
print(tree.rootNode.sExpressionString!)
// (program
// (lexical_declaration
// (variable_declarator name: (identifier) value: (number)))
// (expression_statement
// (call_expression function:
// (member_expression object: (identifier)
// property: (property_identifier))
// arguments: (arguments (identifier)))))
```
Inspect the syntax tree.
```swift
let callExpression = tree.rootNode.child(at: 1).firstChild(forOffset: 0)
print("type:\t\(callExpression.type)")
print("start point:\t\(callExpression.startPoint)")
print("end point:\t\(callExpression.endPoint)")
print("start byte:\t\(callExpression.startByte)")
print("end byte:\t\(callExpression.endByte)")
// type: call_expression
// start point: STSPoint(row: 0, column: 11)
// end point: STSPoint(row: 0, column: 25)
// start byte: 11
// end byte: 25
```
If your source code changes you can update the syntax tree.
This will take less time than to recompute the tree from scratch again.
```swift
// replace let with const
let newSourceCode = "const x = 1; console.log(x);";
tree.edit(
STSInputEdit(
startByte: 0,
oldEndByte: 3,
newEndByte: 5,
startPoint: STSPoint(row: 0, column: 0),
oldEndPoint: STSPoint(row: 0, column: 3),
newEndPoint: STSPoint(row: 0, column: 5)
))
let newTree = parser.parse(string: newSourceCode, oldTree: tree)
```
### Parsing text from a custom data source
If your text is stored in a custom data source,
you can parse it by passing a callback to `.parse()` instead of a `String`.
```swift
let sourceLines = [
"let x = 1;\n",
"console.log(x);\n"
]
let tree = parser.parse(callback: { (byte, point) -> [Int8] in
if (point.row >= sourceLines.count) {
return []
}
let line = sourceLines[Int(point.row)]
let index = line.index(line.startIndex, offsetBy: Int(point.column))
let slice = line[index...]
let array = Array(slice.utf8).map { Int8($0) }
return array
}, oldTree: nil)
```