[feat]: Add Typescript & TSX Language Grammars (#37)

thecoolwinter · web-flow · commit 016b0e8df960 · 2023-04-27T01:24:58.000+02:00
diff --git a/CodeLanguages-Container/CodeLanguages-Container.xcodeproj/project.pbxproj b/CodeLanguages-Container/CodeLanguages-Container.xcodeproj/project.pbxproj
@@ -34,6 +34,8 @@
 		28B3F05D290C3709000CD04D /* TreeSitterSwift in Frameworks */ = {isa = PBXBuildFile; productRef = 28B3F05C290C3709000CD04D /* TreeSitterSwift */; };
 		28B3F063290C372D000CD04D /* TreeSitterZig in Frameworks */ = {isa = PBXBuildFile; productRef = 28B3F062290C372D000CD04D /* TreeSitterZig */; };
 		28B9F7AA290DDAC900245748 /* TreeSitterBash in Frameworks */ = {isa = PBXBuildFile; productRef = 28B9F7A9290DDAC900245748 /* TreeSitterBash */; };
+		6CA62EA929F9D36700785B11 /* TreeSitterTS in Frameworks */ = {isa = PBXBuildFile; productRef = 6CA62EA829F9D36700785B11 /* TreeSitterTS */; };
+		6CA62EAB29F9D36700785B11 /* TreeSitterTSX in Frameworks */ = {isa = PBXBuildFile; productRef = 6CA62EAA29F9D36700785B11 /* TreeSitterTSX */; };
 		6CEC70FE29C3A85000B61C7A /* TreeSitterRegex in Frameworks */ = {isa = PBXBuildFile; productRef = 6CEC70FD29C3A85000B61C7A /* TreeSitterRegex */; };
 		9D6DA3B8298F1A4600E69066 /* TreeSitterOCaml in Frameworks */ = {isa = PBXBuildFile; productRef = 9D6DA3B7298F1A4600E69066 /* TreeSitterOCaml */; };
 /* End PBXBuildFile section */
@@ -52,6 +54,7 @@
 				28B3F051290C36B1000CD04D /* TreeSitterPHP in Frameworks */,
 				28B3F042290C365C000CD04D /* TreeSitterHaskell in Frameworks */,
 				285BF67329AAA45B00641989 /* TreeSitterLua in Frameworks */,
+				6CA62EAB29F9D36700785B11 /* TreeSitterTSX in Frameworks */,
 				2846B262296BA1CF005F60B6 /* TreeSitterDockerfile in Frameworks */,
 				282C119329AA32C8004F1EA6 /* TreeSitterSQL in Frameworks */,
 				28B3F039290C362C000CD04D /* TreeSitterElixir in Frameworks */,
@@ -75,6 +78,7 @@
 				28B3F048290C367C000CD04D /* TreeSitterJava in Frameworks */,
 				6CEC70FE29C3A85000B61C7A /* TreeSitterRegex in Frameworks */,
 				282E5977298051980064B34A /* TreeSitterYAML in Frameworks */,
+				6CA62EA929F9D36700785B11 /* TreeSitterTS in Frameworks */,
 				2886C788298135540023E016 /* TreeSitterKotlin in Frameworks */,
 				28B3F057290C36D5000CD04D /* TreeSitterRuby in Frameworks */,
 			);
@@ -181,6 +185,8 @@
 				285BF67229AAA45B00641989 /* TreeSitterLua */,
 				6CEC70FD29C3A85000B61C7A /* TreeSitterRegex */,
 				28AAB6AD29CA57D40087654B /* TreeSitterDart */,
+				6CA62EA829F9D36700785B11 /* TreeSitterTS */,
+				6CA62EAA29F9D36700785B11 /* TreeSitterTSX */,
 			);
 			productName = "CodeLanguages-Container";
 			productReference = 28B3F00C290C207D000CD04D /* CodeLanguages_Container.framework */;
@@ -239,6 +245,7 @@
 				285BF67129AAA45B00641989 /* XCRemoteSwiftPackageReference "tree-sitter-lua" */,
 				6CEC70FC29C3A85000B61C7A /* XCRemoteSwiftPackageReference "tree-sitter-regex" */,
 				28AAB6AC29CA57D40087654B /* XCRemoteSwiftPackageReference "tree-sitter-dart" */,
+				6CA62EA729F9D36700785B11 /* XCRemoteSwiftPackageReference "tree-sitter-typescript" */,
 			);
 			productRefGroup = 28B3F00D290C207D000CD04D /* Products */;
 			projectDirPath = "";
@@ -696,6 +703,14 @@
 				kind = branch;
 			};
 		};
+		6CA62EA729F9D36700785B11 /* XCRemoteSwiftPackageReference "tree-sitter-typescript" */ = {
+			isa = XCRemoteSwiftPackageReference;
+			repositoryURL = "https://github.com/thecoolwinter/tree-sitter-typescript";
+			requirement = {
+				branch = master;
+				kind = branch;
+			};
+		};
 		6CEC70FC29C3A85000B61C7A /* XCRemoteSwiftPackageReference "tree-sitter-regex" */ = {
 			isa = XCRemoteSwiftPackageReference;
 			repositoryURL = "https://github.com/thecoolwinter/tree-sitter-regex/";
@@ -845,6 +860,16 @@
 			package = 28B9F7A6290DDAB500245748 /* XCRemoteSwiftPackageReference "tree-sitter-bash" */;
 			productName = TreeSitterBash;
 		};
+		6CA62EA829F9D36700785B11 /* TreeSitterTS */ = {
+			isa = XCSwiftPackageProductDependency;
+			package = 6CA62EA729F9D36700785B11 /* XCRemoteSwiftPackageReference "tree-sitter-typescript" */;
+			productName = TreeSitterTS;
+		};
+		6CA62EAA29F9D36700785B11 /* TreeSitterTSX */ = {
+			isa = XCSwiftPackageProductDependency;
+			package = 6CA62EA729F9D36700785B11 /* XCRemoteSwiftPackageReference "tree-sitter-typescript" */;
+			productName = TreeSitterTSX;
+		};
 		6CEC70FD29C3A85000B61C7A /* TreeSitterRegex */ = {
 			isa = XCSwiftPackageProductDependency;
 			package = 6CEC70FC29C3A85000B61C7A /* XCRemoteSwiftPackageReference "tree-sitter-regex" */;
diff --git a/CodeLanguages-Container/CodeLanguages-Container.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved b/CodeLanguages-Container/CodeLanguages-Container.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
diff --git a/CodeLanguages-Container/CodeLanguages-Container/CodeLanguages_Container.h b/CodeLanguages-Container/CodeLanguages-Container/CodeLanguages_Container.h
@@ -49,6 +49,8 @@ extern TSLanguage *tree_sitter_ruby();
 extern TSLanguage *tree_sitter_rust();
 extern TSLanguage *tree_sitter_sql();
 extern TSLanguage *tree_sitter_swift();
+extern TSLanguage *tree_sitter_tsx();
+extern TSLanguage *tree_sitter_typescript();
 extern TSLanguage *tree_sitter_yaml();
 extern TSLanguage *tree_sitter_zig();
 
diff --git a/CodeLanguagesContainer.xcframework.zip b/CodeLanguagesContainer.xcframework.zip
diff --git a/README.md b/README.md
@@ -81,7 +81,7 @@ In order to add support for additional languages we have a complete guide on how
 | [Sql](https://github.com/lukepistrol/tree-sitter-sql/tree/feature/spm) | ✅ | ✅ |
 | [Swift](https://github.com/alex-pinkus/tree-sitter-swift/tree/with-generated-files) | ✅ | ✅ |
 | [TOML](https://github.com/ikatyang/tree-sitter-toml) |  |  |
-| [TypeScript/TSX](https://github.com/tree-sitter/tree-sitter-typescript) |  |  |
+| [TypeScript/TSX](https://github.com/tree-sitter/tree-sitter-typescript) | ✅ | ✅ |
 | [Verilog](https://github.com/tree-sitter/tree-sitter-verilog) |  | _not available_ |
 | [YAML](https://github.com/lukepistrol/tree-sitter-yaml/tree/feature/spm) | ✅ | ✅ |
 | [Zig](https://github.com/maxxnino/tree-sitter-zig) | ✅ | ✅ |
diff --git a/Sources/CodeEditLanguages/CodeLanguage+Definitions.swift b/Sources/CodeEditLanguages/CodeLanguage+Definitions.swift
@@ -39,6 +39,8 @@ public extension CodeLanguage {
         .rust,
         .sql,
         .swift,
+        .tsx,
+        .typescript,
         .yaml,
         .zig
     ]
@@ -248,6 +250,22 @@ public extension CodeLanguage {
         extensions: ["swift"]
     )
 
+    /// A language structure for `TSX`
+    static let tsx: CodeLanguage = .init(
+        id: .tsx,
+        tsName: "typescript",
+        extensions: ["tsx"],
+        parentURL: CodeLanguage.jsx.queryURL
+    )
+
+    /// A language structure for `Typescript`
+    static let typescript: CodeLanguage = .init(
+        id: .typescript,
+        tsName: "typescript",
+        extensions: ["ts"],
+        parentURL: CodeLanguage.javascript.queryURL
+    )
+
     /// A language structure for `YAML`
     static let yaml: CodeLanguage = .init(
         id: .yaml,
diff --git a/Sources/CodeEditLanguages/CodeLanguage.swift b/Sources/CodeEditLanguages/CodeLanguage.swift
@@ -122,6 +122,10 @@ public struct CodeLanguage {
             return tree_sitter_sql()
         case .swift:
             return tree_sitter_swift()
+        case .tsx:
+            return tree_sitter_tsx()
+        case .typescript:
+            return tree_sitter_typescript()
         case .yaml:
             return tree_sitter_yaml()
         case .zig:
diff --git a/Sources/CodeEditLanguages/Resources/tree-sitter-bash/highlights.scm b/Sources/CodeEditLanguages/Resources/tree-sitter-bash/highlights.scm
@@ -22,9 +22,11 @@
   "function"
   "if"
   "in"
+  "select"
+  "then"
   "unset"
+  "until"
   "while"
-  "then"
 ] @keyword
 
 (comment) @comment
diff --git a/Sources/CodeEditLanguages/Resources/tree-sitter-typescript/highlights.scm b/Sources/CodeEditLanguages/Resources/tree-sitter-typescript/highlights.scm
@@ -0,0 +1,35 @@
+; Types
+
+(type_identifier) @type
+(predefined_type) @type.builtin
+
+((identifier) @type
+ (#match? @type "^[A-Z]"))
+
+(type_arguments
+  "<" @punctuation.bracket
+  ">" @punctuation.bracket)
+
+; Variables
+
+(required_parameter (identifier) @variable.parameter)
+(optional_parameter (identifier) @variable.parameter)
+
+; Keywords
+
+[ "abstract"
+  "declare"
+  "enum"
+  "export"
+  "implements"
+  "interface"
+  "keyof"
+  "namespace"
+  "private"
+  "protected"
+  "public"
+  "type"
+  "readonly"
+  "override"
+  "satisfies"
+] @keyword
diff --git a/Sources/CodeEditLanguages/Resources/tree-sitter-typescript/locals.scm b/Sources/CodeEditLanguages/Resources/tree-sitter-typescript/locals.scm
@@ -0,0 +1,2 @@
+(required_parameter (identifier) @local.definition)
+(optional_parameter (identifier) @local.definition)
diff --git a/Sources/CodeEditLanguages/Resources/tree-sitter-typescript/tags.scm b/Sources/CodeEditLanguages/Resources/tree-sitter-typescript/tags.scm
@@ -0,0 +1,23 @@
+(function_signature
+  name: (identifier) @name) @definition.function
+
+(method_signature
+  name: (property_identifier) @name) @definition.method
+
+(abstract_method_signature
+  name: (property_identifier) @name) @definition.method
+
+(abstract_class_declaration
+  name: (type_identifier) @name) @definition.class
+
+(module
+  name: (identifier) @name) @definition.module
+
+(interface_declaration
+  name: (type_identifier) @name) @definition.interface
+
+(type_annotation
+  (type_identifier) @name) @reference.type
+
+(new_expression
+  constructor: (identifier) @name) @reference.class
diff --git a/Sources/CodeEditLanguages/TreeSitterLanguage.swift b/Sources/CodeEditLanguages/TreeSitterLanguage.swift
@@ -37,6 +37,8 @@ public enum TreeSitterLanguage: String {
     case rust
     case sql
     case swift
+    case tsx
+    case typescript
     case yaml
     case zig
     case plainText
diff --git a/Sources/CodeEditLanguages/TreeSitterModel.swift b/Sources/CodeEditLanguages/TreeSitterModel.swift
@@ -76,6 +76,10 @@ public class TreeSitterModel {
             return sqlQuery
         case .swift:
             return swiftQuery
+        case .tsx:
+            return tsxQuery
+        case .typescript:
+            return typescriptQuery
         case .yaml:
             return yamlQuery
         case .zig:
@@ -225,6 +229,16 @@ public class TreeSitterModel {
         return queryFor(.swift)
     }()
 
+    /// Query for `TSX` files.
+    public private(set) lazy var tsxQuery: Query? = {
+        return queryFor(.tsx)
+    }()
+
+    /// Query for `Typescript` files.
+    public private(set) lazy var typescriptQuery: Query? = {
+        return queryFor(.typescript)
+    }()
+
     /// Query for `YAML` files.
     public private(set) lazy var yamlQuery: Query? = {
         return queryFor(.yaml)
diff --git a/Tests/CodeEditLanguagesTests/CodeEditLanguagesTests.swift b/Tests/CodeEditLanguagesTests/CodeEditLanguagesTests.swift
@@ -573,6 +573,44 @@ final class CodeEditLanguagesTests: XCTestCase {
         XCTAssertNotEqual(query?.patternCount, 0)
     }
 
+    // MARK: - TSX
+
+    func test_CodeLanguageTSX() throws {
+        let url = URL(fileURLWithPath: "~/path/to/file.tsx")
+        let language = CodeLanguage.detectLanguageFrom(url: url)
+
+        XCTAssertEqual(language.id, .tsx)
+    }
+
+    func test_FetchQueryTSX() throws {
+        var language = CodeLanguage.tsx
+        language.resourceURL = bundleURL
+
+        let data = try Data(contentsOf: language.queryURL!)
+        let query = try? Query(language: language.language!, data: data)
+        XCTAssertNotNil(query)
+        XCTAssertNotEqual(query?.patternCount, 0)
+    }
+
+    // MARK: - Typescript
+
+    func test_CodeLanguageTypescript() throws {
+        let url = URL(fileURLWithPath: "~/path/to/file.ts")
+        let language = CodeLanguage.detectLanguageFrom(url: url)
+
+        XCTAssertEqual(language.id, .typescript)
+    }
+
+    func test_FetchQueryTypescript() throws {
+        var language = CodeLanguage.typescript
+        language.resourceURL = bundleURL
+
+        let data = try Data(contentsOf: language.queryURL!)
+        let query = try? Query(language: language.language!, data: data)
+        XCTAssertNotNil(query)
+        XCTAssertNotEqual(query?.patternCount, 0)
+    }
+
 // MARK: - YAML
 
     func test_CodeLanguageYAML() throws {

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+(required_parameter (identifier) @local.definition)`
	`2`	`+(optional_parameter (identifier) @local.definition)`