Merge pull request #2 from lukepistrol/improve-docs

Improve docs

.gitignore

@@ -3,6 +3,7 @@
 /Packages
 xcuserdata/
 DerivedData/
-.swiftpm
+.swiftpm/config/registries.json
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
 .netrc
 docs/

.swiftpm/xcode/package.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>IDEDidComputeMac32BitWarning</key>
+	<true/>
+</dict>
+</plist>

.swiftpm/xcode/xcshareddata/xcschemes/CodeEditLanguages.xcscheme

@@ -0,0 +1,105 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "1410"
+   version = "1.3">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "CodeEditLanguages_CodeEditLanguages"
+               BuildableName = "CodeEditLanguages_CodeEditLanguages"
+               BlueprintName = "CodeEditLanguages_CodeEditLanguages"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </BuildActionEntry>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "CodeEditLanguages"
+               BuildableName = "CodeEditLanguages"
+               BlueprintName = "CodeEditLanguages"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </BuildActionEntry>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "NO"
+            buildForArchiving = "NO"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "CodeEditLanguagesTests"
+               BuildableName = "CodeEditLanguagesTests"
+               BlueprintName = "CodeEditLanguagesTests"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES">
+      <Testables>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "CodeEditLanguagesTests"
+               BuildableName = "CodeEditLanguagesTests"
+               BlueprintName = "CodeEditLanguagesTests"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </TestableReference>
+      </Testables>
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+      <MacroExpansion>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "CodeEditLanguages_CodeEditLanguages"
+            BuildableName = "CodeEditLanguages_CodeEditLanguages"
+            BlueprintName = "CodeEditLanguages_CodeEditLanguages"
+            ReferencedContainer = "container:">
+         </BuildableReference>
+      </MacroExpansion>
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>

CodeLanguages-Container/CodeLanguages-Container.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -1,5 +1,14 @@
 {
   "pins" : [
+    {
+      "identity" : "swift-docc-plugin",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/apple/swift-docc-plugin.git",
+      "state" : {
+        "revision" : "3303b164430d9a7055ba484c8ead67a52f7b74f6",
+        "version" : "1.0.0"
+      }
+    },
     {
       "identity" : "swifttreesitter",
       "kind" : "remoteSourceControl",

CodeLanguages-Container/CodeLanguages-Container/CodeLanguages_Container.h

@@ -19,6 +19,9 @@ typedef struct TSLanguage TSLanguage;
 extern "C" {
 #endif
 
+// A collection of pointers to supported tree-sitter languages
+// Add new ones below (please keep an alphabetical order)
+
 extern TSLanguage *tree_sitter_bash();
 extern TSLanguage *tree_sitter_c();
 extern TSLanguage *tree_sitter_cpp();
@@ -43,6 +46,3 @@ extern TSLanguage *tree_sitter_zig();
 #ifdef __cplusplus
 }
 #endif
-// In this header, you should import all the public headers of your framework using statements like #import <CodeLanguages_Container/PublicHeader.h>
-
-

Sources/CodeEditLanguages/CodeLanguage.swift

@@ -8,7 +8,6 @@
 import Foundation
 import tree_sitter
 import SwiftTreeSitter
-
 import CodeLanguages_Container
 
 /// A structure holding metadata for code languages

Sources/CodeEditLanguages/Documentation.docc/Add-Languages.md

@@ -97,23 +97,23 @@ extern TSLanguage *tree_sitter_{lang}();
 
 In order to add a language to ``CodeEditLanguages`` you need to open the `.xcodeproj` file located inside `CodeLanguage-Container`.
 
-Add the `tree-sitter` package you created earlier as a dependency like you would in a regular Xcode project.
+1. Add the `tree-sitter` package you created earlier as a dependency like you would in a regular Xcode project.
 
-Then make sure the framework target loads the package module.
+2. Then make sure the framework target loads the package module.
 
-Now open the `CodeLanguages_Container.h` header file and add:
+3. Now open the `CodeLanguages_Container.h` header file and add:
 
-```cpp
-extern TSLanguage *tree_sitter_{lang}();
-```
+    ```cpp
+    extern TSLanguage *tree_sitter_{lang}();
+    ```
 
-> Please keep an alphabetical order
+    > Please keep an alphabetical order
 
-Now create the `xcframework` by running the `build_framework.sh` script from the Package's root directory.
+4. Now create the `xcframework` by running the `build_framework.sh` script from the Package's root directory.
 
-After that also run the `copy_resources.sh` script to copy the `*.scm` files into the Package's Resource folder.
+5. Check the output of the script. It should say `Done!` at the end.
 
-You are now done in the Xcode Project and may close it now. Open the Package and continue.
+6. You are now done in the Xcode Project and may close it now. Open the Package and continue.
 
 ## Add it to CodeLanguage
 
@@ -196,11 +196,34 @@ When everything is working correctly push your `tree-sitter-{lang}` changes to `
 
 Now you can remove the local dependencies and replace it with the actual package URLs and submit a Pull Request for `CodeEditTextView`.
 
-## Documentation
-
-Please make sure to add the newly created properties to the documentation `*.md` files.
-
 ## Unit Tests
 
 Also make sure to add test cases for your new language in `Tests/CodeEditLanguagesTests`.
 
+### Example
+
+```swift
+// MARK: - Swift
+
+    // create as many test cases as there are file extensions
+    func test_CodeLanguageSwift() throws {
+        let url = URL(fileURLWithPath: "~/path/to/file.swift")
+        let language = CodeLanguage.detectLanguageFrom(url: url)
+
+        XCTAssertEqual(language.id, .swift)
+    }
+
+    func test_FetchQuerySwift() throws {
+        var language = CodeLanguage.swift
+        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)
+    }
+```
+
+## Documentation
+
+Please make sure to add the newly created properties to the documentation `*.md` files.

Sources/CodeEditLanguages/Documentation.docc/Documentation.md

@@ -13,3 +13,15 @@ The languages are then served as a ``CodeLanguage``.
 ### Guides
 
 - <doc:Add-Languages>
+
+### Structs
+
+- ``CodeEditLanguages/CodeLanguage``
+
+### Classes
+
+- ``CodeEditLanguages/TreeSitterModel``
+
+### Enums
+
+- ``CodeEditLanguages/TreeSitterLanguage``