Fix typos

Author: the-mikedavis

.github/workflows/ci.yml

@@ -27,7 +27,7 @@ jobs:
 
       - name: Run cargo check
         run: cargo check
-      - name: Run cargo check withoult default features
+      - name: Run cargo check without default features
         run: cargo check --no-default-features
 
   test:
@@ -64,7 +64,7 @@ jobs:
 
       - name: Run cargo clippy
         run: cargo clippy --workspace --all-targets -- -D warnings
-      - name: Run cargo clippy withoult default features
+      - name: Run cargo clippy without default features
         run: cargo clippy --workspace --all-targets --no-default-features -- -D warnings
 
       - name: Run cargo doc

bindings/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "twig-sitter"
-description = "Alternative rust bindings for the tree-sitter C library"
+description = "Alternative Rust bindings for the tree-sitter C library"
 authors = ["Pascal Kuthe <[email protected]>"]
 version = "0.1.0"
 edition = "2021"

bindings/src/grammar.rs

@@ -27,7 +27,7 @@ impl std::fmt::Debug for Grammar {
 }
 
 impl Grammar {
-    /// Loads a shared library containg a tree sitter grammar with name `name`
+    /// Loads a shared library containing a tree sitter grammar with name `name`
     // from `library_path`.
     ///
     /// # Safety

bindings/src/parser.rs

@@ -65,7 +65,7 @@ impl Parser {
     /// whole. You can also pass multiple disjoint ranges.
     ///
     /// `ranges` must be non-overlapping and sorted.
-    pub fn set_included_ranges(&mut self, ranges: &[Range]) -> Result<(), InvalidRangesErrror> {
+    pub fn set_included_ranges(&mut self, ranges: &[Range]) -> Result<(), InvalidRangesError> {
         // TODO: save some memory by only storing byte ranges and converting them to TS ranges in an
         // internal buffer here. Points are not used by TS. Alternatively we can path the TS C code
         // to accept a simple pair (struct with two fields) of byte positions here instead of a full
@@ -76,7 +76,7 @@ impl Parser {
         if success {
             Ok(())
         } else {
-            Err(InvalidRangesErrror)
+            Err(InvalidRangesError)
         }
     }
 
@@ -144,14 +144,14 @@ impl Drop for Parser {
 /// An error that occurred when trying to assign an incompatible [`Grammar`] to
 /// a [`Parser`].
 #[derive(Debug, PartialEq, Eq)]
-pub struct InvalidRangesErrror;
+pub struct InvalidRangesError;
 
-impl fmt::Display for InvalidRangesErrror {
+impl fmt::Display for InvalidRangesError {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         write!(f, "include ranges overlap or are not sorted",)
     }
 }
-impl std::error::Error for InvalidRangesErrror {}
+impl std::error::Error for InvalidRangesError {}
 
 type TreeSitterReadFn = unsafe extern "C" fn(
     payload: NonNull<c_void>,

bindings/src/query.rs

@@ -312,7 +312,7 @@ impl QueryStr {
 #[derive(Debug, PartialEq, Eq)]
 pub struct ParserErrorLocation {
     pub path: PathBuf,
-    /// at which line the error occured
+    /// at which line the error occurred
     pub line: u32,
     /// at which codepoints/columns the errors starts in the line
     pub column: u32,

bindings/src/query/predicate.rs

@@ -81,7 +81,7 @@ impl TextPredicate {
         }
     }
 
-    pub fn satsified<I: TsInput>(
+    pub fn satisfied<I: TsInput>(
         &self,
         input: &mut I,
         matched_nodes: &[MatchedNode],
@@ -230,7 +230,7 @@ impl Query {
                     });
                 }
 
-                // is and is-not are better handeled as custom predicates since interpreting is context dependent
+                // is and is-not are better handled as custom predicates since interpreting is context dependent
                 // "is?" => property_predicates.push((QueryProperty::parse(&predicate), false)),
                 // "is-not?" => property_predicates.push((QueryProperty::parse(&predicate), true)),
                 _ => custom_predicate(pattern, UserPredicate::Other(predicate))?,
@@ -375,7 +375,7 @@ impl Error for InvalidPredicateError {}
 #[repr(C)]
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 // warns about never being constructed but it's constructed by C code
-// and wrwitten into a mutable reference
+// and written into a mutable reference
 #[allow(dead_code)]
 enum PredicateStepKind {
     Done = 0,
@@ -406,15 +406,17 @@ extern "C" {
     /// Get all of the predicates for the given pattern in the query. The
     /// predicates are represented as a single array of steps. There are three
     /// types of steps in this array, which correspond to the three legal values
-    /// for the `type` field: - `TSQueryPredicateStepTypeCapture` - Steps with
-    /// this type represent names    of captures. Their `value_id` can be used
-    /// with the   [`ts_query_capture_name_for_id`] function to obtain the name
-    /// of the capture. - `TSQueryPredicateStepTypeString` - Steps with this
-    /// type represent literal    strings. Their `value_id` can be used with the
-    /// [`ts_query_string_value_for_id`] function to obtain their string value.
-    /// - `TSQueryPredicateStepTypeDone` - Steps with this type are *sentinels*
-    /// that represent the end of an individual predicate. If a pattern has two
-    /// predicates, then there will be two steps with this `type` in the array.
+    /// for the `type` field:
+    ///
+    /// - `TSQueryPredicateStepTypeCapture` - Steps with this type represent names of captures.
+    ///   Their `value_id` can be used with the [`ts_query_capture_name_for_id`] function to
+    ///   obtain the name of the capture.
+    /// - `TSQueryPredicateStepTypeString` - Steps with this type represent literal strings.
+    ///   Their `value_id` can be used with the [`ts_query_string_value_for_id`] function to
+    ///   obtain their string value.
+    /// - `TSQueryPredicateStepTypeDone` - Steps with this type are *sentinels* that represent the
+    ///   end of an individual predicate. If a pattern has two predicates, then there will be two
+    ///   steps with this `type` in the array.
     fn ts_query_predicates_for_pattern(
         query: NonNull<QueryData>,
         pattern_index: u32,

bindings/src/query_cursor.rs

@@ -15,7 +15,7 @@ thread_local! {
     static CURSOR_CACHE: UnsafeCell<Vec<InactiveQueryCursor>> = UnsafeCell::new(Vec::with_capacity(8));
 }
 
-/// SAFETY: must not call itself recuresively
+/// SAFETY: must not call itself recursively
 unsafe fn with_cache<T>(f: impl FnOnce(&mut Vec<InactiveQueryCursor>) -> T) -> T {
     CURSOR_CACHE.with(|cache| f(&mut *cache.get()))
 }
@@ -51,7 +51,7 @@ impl<'tree, I: TsInput> QueryCursor<'_, 'tree, I> {
                 .query
                 .pattern_text_predicates(query_match.pattern_index)
                 .iter()
-                .all(|predicate| predicate.satsified(&mut self.input, matched_nodes, self.query));
+                .all(|predicate| predicate.satisfied(&mut self.input, matched_nodes, self.query));
             if satisfies_predicates {
                 let res = QueryMatch {
                     id: query_match.id,
@@ -90,7 +90,7 @@ impl<'tree, I: TsInput> QueryCursor<'_, 'tree, I> {
                 .query
                 .pattern_text_predicates(query_match.pattern_index)
                 .iter()
-                .all(|predicate| predicate.satsified(&mut self.input, matched_nodes, self.query));
+                .all(|predicate| predicate.satisfied(&mut self.input, matched_nodes, self.query));
             if satisfies_predicates {
                 let res = QueryMatch {
                     id: query_match.id,

bindings/src/ropey.rs

@@ -39,8 +39,8 @@ impl<'a> TsInput for RopeTsInput<'a> {
             "parser offset out of bounds: {offset} > {}",
             self.src.len_bytes()
         );
-        // this cursor is optimized for contigous reads which are by far the most common during parsing
-        // very far jumps (like injections at the other end of the document) are handelde
+        // this cursor is optimized for contiguous reads which are by far the most common during parsing
+        // very far jumps (like injections at the other end of the document) are handled
         // by starting a new cursor (new chunks iterator)
         if offset < self.cursor.offset() || offset - self.cursor.offset() > 4906 {
             self.cursor = regex_cursor::RopeyCursor::at(self.src, offset);

bindings/src/syntax_tree.rs

@@ -65,7 +65,7 @@ pub struct InputEdit {
 impl InputEdit {
     /// returns the offset between the old end of the edit and the new end of
     /// the edit. This offset needs to be added to every position that occurs
-    /// ofter `self.old_end_byte` to may it to its old position
+    /// after `self.old_end_byte` to may it to its old position
     ///
     /// This function assumes that the the source-file is smaller than 2GiB
     pub fn offset(&self) -> i32 {

cli/Cargo.toml

@@ -2,7 +2,7 @@
 name = "skidder-cli"
 version = "0.1.0"
 edition = "2021"
-description = "A package mangager for tree-sitter"
+description = "A package manager for tree-sitter"
 authors = ["Pascal Kuthe <[email protected]>"]
 license = "MPL-2.0"
 repository = "https://github.com/helix-editor/sappling"